Wi-zz commited on
Commit
b3632d5
1 Parent(s): 6b99536

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +51 -53
README.md CHANGED
@@ -1,54 +1,52 @@
1
- Here's a concise, structured, and aesthetically formatted markdown description for your GitHub repo README:
2
-
3
- # Image Captioning App
4
-
5
- ## Overview
6
-
7
- This application generates descriptive captions for images using advanced ML models. It processes single images or entire directories, leveraging CLIP and LLM models for accurate and contextual captions. It has NSFW captioning support with natural language.
8
-
9
- ## Features
10
-
11
- - Single image and batch processing
12
- - Multiple directory support
13
- - Custom output directory
14
- - Adjustable batch size
15
- - Progress tracking
16
-
17
- ## Usage
18
-
19
- | Command | Description |
20
- |---------|-------------|
21
- | `python app.py image.jpg` | Process a single image |
22
- | `python app.py /path/to/directory` | Process all images in a directory |
23
- | `python app.py /path/to/dir1 /path/to/dir2` | Process multiple directories |
24
- | `python app.py /path/to/dir --output /path/to/output` | Specify output directory |
25
- | `python app.py /path/to/dir --bs 8` | Set batch size (default: 4) |
26
-
27
- ## Technical Details
28
-
29
- - **Models**: CLIP (vision), LLM (language), custom ImageAdapter
30
- - **Optimization**: CUDA-enabled GPU support
31
- - **Error Handling**: Skips problematic images in batch processing
32
-
33
- ## Requirements
34
-
35
- - Python 3.x
36
- - PyTorch
37
- - Transformers library
38
- - CUDA-capable GPU (recommended)
39
-
40
- ## Installation
41
-
42
- ```bash
43
- git clone https://huggingface.co/Wi-zz/joy-caption-pre-alpha
44
- cd joy-caption-pre-alpha
45
- pip install -r requirements.txt
46
- ```
47
-
48
- ## Contributing
49
-
50
- Contributions are welcome! Please feel free to submit a Pull Request.
51
-
52
- ## License
53
-
54
  This project is licensed under the [MIT License](LICENSE).
 
1
+ # Image Captioning App
2
+
3
+ ## Overview
4
+
5
+ This application generates descriptive captions for images using advanced ML models. It processes single images or entire directories, leveraging CLIP and LLM models for accurate and contextual captions. It has NSFW captioning support with natural language.
6
+
7
+ ## Features
8
+
9
+ - Single image and batch processing
10
+ - Multiple directory support
11
+ - Custom output directory
12
+ - Adjustable batch size
13
+ - Progress tracking
14
+
15
+ ## Usage
16
+
17
+ | Command | Description |
18
+ |---------|-------------|
19
+ | `python app.py image.jpg` | Process a single image |
20
+ | `python app.py /path/to/directory` | Process all images in a directory |
21
+ | `python app.py /path/to/dir1 /path/to/dir2` | Process multiple directories |
22
+ | `python app.py /path/to/dir --output /path/to/output` | Specify output directory |
23
+ | `python app.py /path/to/dir --bs 8` | Set batch size (default: 4) |
24
+
25
+ ## Technical Details
26
+
27
+ - **Models**: CLIP (vision), LLM (language), custom ImageAdapter
28
+ - **Optimization**: CUDA-enabled GPU support
29
+ - **Error Handling**: Skips problematic images in batch processing
30
+
31
+ ## Requirements
32
+
33
+ - Python 3.x
34
+ - PyTorch
35
+ - Transformers library
36
+ - CUDA-capable GPU (recommended)
37
+
38
+ ## Installation
39
+
40
+ ```bash
41
+ git clone https://huggingface.co/Wi-zz/joy-caption-pre-alpha
42
+ cd joy-caption-pre-alpha
43
+ pip install -r requirements.txt
44
+ ```
45
+
46
+ ## Contributing
47
+
48
+ Contributions are welcome! Please feel free to submit a Pull Request.
49
+
50
+ ## License
51
+
 
 
52
  This project is licensed under the [MIT License](LICENSE).