Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fiqryq/caption-llava
A simple yet effective CLI application built on Node.js, using Ollama Vision LLava for auto generate caption based on your image.
https://github.com/fiqryq/caption-llava
llava nodejs ollama-api
Last synced: 8 days ago
JSON representation
A simple yet effective CLI application built on Node.js, using Ollama Vision LLava for auto generate caption based on your image.
- Host: GitHub
- URL: https://github.com/fiqryq/caption-llava
- Owner: fiqryq
- Created: 2024-09-16T18:04:39.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-10-20T14:50:39.000Z (2 months ago)
- Last Synced: 2024-12-13T21:34:46.173Z (8 days ago)
- Topics: llava, nodejs, ollama-api
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/caption-llava
- Size: 3.19 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🖼️ Image Caption Generator ( Caption LLAVA)
This project allows you to generate image captions using the **LLaVA model** running on your local machine. It's **100% free** and **open source**, designed to help you quickly create captions for images with the ability to specify a tone of voice.
## ✨ Features
- **Free** and **open source**.
- Generate captions based on images using the **LLaVA model**.
- Specify the tone of the captions (e.g., professional, casual, humorous, etc.).
- Simple and intuitive command-line usage.
## ⚡️ Usage
To generate captions for your images, use the following command in your terminal:
```bash
caption [IMAGE_FOLDER] [DESTINATION_PATH] [TONE]
```
### Example:
```bash
caption ./my-image ./my-output professional
```
- **`[IMAGE_FOLDER]`**: The folder containing the images you want to generate captions for.
- **`[DESTINATION_PATH]`**: The folder where the generated captions will be saved.
- **`[TONE]`**: The tone of the caption, such as `professional`, `casual`, or `humorous`.
## 📥 Installation
1. Clone the repository:
```bash
git clone [email protected]:fiqryq/caption-llava.git
```
2. Navigate to the project directory:
```bash
cd caption-llava
```
3. Install the required dependencies:
```bash
npm install # or yarn install # or pnpm install
```
4. Run the application:
```bash
npm start # or yarn start # or pnpm install
```
## 🛠️ Requirements
- Node.js installed on your machine.
- The **LLaVA model** configured locally.
## 📝 Notes
- Make sure the **LLaVA model** is properly set up and running on your machine before using the caption generator.
- The tone parameter is optional. If you don't specify a tone, it defaults to a general caption style.
## 🤝 Contributing
Contributions are welcome! Feel free to open an issue or submit a pull request to improve the project.
## 📄 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.