DucHaiten commited on
Commit
c518050
1 Parent(s): 42b669c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +72 -78
README.md CHANGED
@@ -1,30 +1,32 @@
1
- ---
2
- license: openrail
3
- language:
4
- - en
5
- ---
6
 
7
- # **IMageDucHaiten**
8
 
9
- *Version:* `V1.1.1`
10
-
11
- ## **Table of Contents**
12
 
13
  - [Introduction](#introduction)
 
14
  - [Installation](#installation)
 
 
 
15
  - [Usage](#usage)
 
 
 
16
  - [Community and Support](#community-and-support)
 
17
 
18
- ## **Introduction**
19
 
20
- **IMageDucHaiten** is a powerful tool, specifically designed to assist those working in artificial intelligence with the preparation of image data for training generative AI models. In version `V1.1.1`, **IMageDucHaiten** provides a suite of automated and flexible tools for processing, tagging, and captioning images, making the data preparation process more efficient and streamlined.
21
 
22
- Whether you're an AI researcher, data engineer, or just someone who enjoys working with images, **IMageDucHaiten** can be an invaluable tool. While it excels at supporting AI data preparation, it is also accessible and beneficial to anyone looking to work with images effortlessly and effectively.
23
 
24
- ### **Key Features**
25
 
26
  - **Image Converter**: Convert image formats to match the requirements of your AI model, supporting a wide range of formats such as PNG, JPG, GIF, BMP, and more.
27
- - **Image Filter**: Filter and remove images that do not meet quality criteria such as size, resolution, ensuring a clean dataset for training.
28
  - **Rotate & Flip**: Rotate and flip images to create various training data variations, enhancing dataset diversity.
29
  - **Image Error Fix**: Automatically detect and fix errors in images, reducing the risk of using incomplete data.
30
  - **Image To Tag**: Automatically tag images, optimizing the data labeling process for AI models.
@@ -32,28 +34,25 @@ Whether you're an AI researcher, data engineer, or just someone who enjoys worki
32
  - **Photo Fantasy**: Create artistic effects on images, useful for data augmentation or enhancing creative content.
33
  - **Shuffle Image**: Shuffle or sequence images to create a diverse dataset, suitable for analysis and modeling tasks.
34
 
35
- **IMageDucHaiten** is not only ideal for AI training data preparation but also serves as a versatile application for all your image processing needs.
36
-
37
- ## **Installation**
38
 
39
  To install and set up **IMageDucHaiten**, you have three options:
40
 
41
- ### **Option 1: Full Package Installation via Direct Download**
42
 
43
- 1. **Download the Full Package:**
44
  - Download the full package from the following link:
45
  [IMageDucHaiten_v1.1.1-Full.zip](https://huggingface.co/DucHaiten/IMageDucHaiten-Full/resolve/main/IMageDucHaiten_v1.1.1-Full.zip)
46
 
47
- 2. **Extract the Package:**
48
  - Extract the contents of the `.zip` file to your desired location.
49
 
50
- 3. **Install Visual Studio Code (if not installed):**
51
  - Download and install Visual Studio Code from [here](https://code.visualstudio.com/).
52
- - After installation, open Visual Studio Code.
53
 
54
- 4. **Activate the Virtual Environment:**
55
- - Open the extracted folder in Visual Studio Code by selecting **File > Open Folder** and navigate to the extracted folder.
56
- - Open the integrated terminal within Visual Studio Code by selecting **View > Terminal**.
57
  - Activate the pre-configured virtual environment:
58
  - On **Windows**:
59
  ```bash
@@ -64,30 +63,33 @@ To install and set up **IMageDucHaiten**, you have three options:
64
  source venv/bin/activate
65
  ```
66
 
67
- 5. **Run the Application:**
68
- - After activating the virtual environment, you can start the application by running `python main.py` in the terminal.
 
 
 
69
 
70
- ### **Option 2: Full Package Installation via Git Clone**
71
 
72
- 1. **Install Git and Git LFS:**
73
- - Make sure you have Git installed on your system. If not, download and install it from [Git's official site](https://git-scm.com/downloads).
74
- - Install Git LFS (Large File Storage) by running the following command:
75
  ```bash
76
  git lfs install
77
  ```
78
 
79
- 2. **Clone the Repository:**
80
  - Use Git to clone the repository with all necessary files:
81
  ```bash
82
  git clone https://huggingface.co/DucHaiten/IMageDucHaiten
83
  ```
84
 
85
- 3. **Open the Project in Visual Studio Code:**
86
  - If you haven't installed Visual Studio Code, download and install it from [here](https://code.visualstudio.com/).
87
- - Open Visual Studio Code, then select **File > Open Folder** and navigate to the cloned folder.
88
 
89
- 4. **Activate the Virtual Environment:**
90
- - Open the integrated terminal by selecting **View > Terminal**.
91
  - Activate the virtual environment:
92
  - On **Windows**:
93
  ```bash
@@ -98,15 +100,18 @@ To install and set up **IMageDucHaiten**, you have three options:
98
  source venv/bin/activate
99
  ```
100
 
101
- 5. **Run the Application:**
102
- - Start the application by running `python main.py` in the terminal.
 
 
 
103
 
104
- ### **Option 3: Manual Installation by Downloading Individual Files**
105
 
106
- 1. **Download the Files Manually:**
107
  - Download individual files and directories from the repository as needed.
108
 
109
- 2. **Set up a Virtual Environment:**
110
  - Create and activate a virtual environment:
111
  - On **Windows**:
112
  ```bash
@@ -119,7 +124,7 @@ To install and set up **IMageDucHaiten**, you have three options:
119
  source venv/bin/activate
120
  ```
121
 
122
- 3. **Install Python Dependencies:**
123
  - Install the required Python packages using `requirements.txt`:
124
  ```bash
125
  pip install -r requirements.txt
@@ -128,21 +133,24 @@ To install and set up **IMageDucHaiten**, you have three options:
128
  4. **Install External Dependencies** (Ghostscript, ImageMagick, Visual C++ Redistributable):
129
  - Follow the instructions provided earlier to ensure all dependencies are properly installed.
130
 
131
- 5. **Open the Project in Visual Studio Code:**
132
  - If you haven't installed Visual Studio Code, download and install it from [here](https://code.visualstudio.com/).
133
- - Open Visual Studio Code, then select **File > Open Folder** and navigate to the project folder.
134
 
135
- 6. **Run the Application:**
136
- - Open the integrated terminal by selecting **View > Terminal**.
137
- - Activate the virtual environment, then start the application by running `python main.py` in the terminal.
 
 
 
138
 
139
- ## **Usage**
140
 
141
- After completing the installation, you can run **IMageDucHaiten** using Visual Studio Code as follows:
142
 
143
- ### **1. Running the Application via Command Line (CMD)**
144
 
145
- 1. **Activate the Virtual Environment:**
146
  - On **Windows**:
147
  ```bash
148
  .\venv\Scripts\activate
@@ -152,21 +160,21 @@ After completing the installation, you can run **IMageDucHaiten** using Visual S
152
  source venv/bin/activate
153
  ```
154
 
155
- 2. **Run the Application:**
156
  - In the terminal, navigate to the folder where `main.py` is located.
157
  - Execute the following command to start the application:
158
  ```bash
159
  python main.py
160
  ```
161
 
162
- ### **2. Running the Application via Visual Studio Code**
163
 
164
- 1. **Open the Project in Visual Studio Code:**
165
  - Launch Visual Studio Code.
166
- - Open the project folder by selecting **File > Open Folder** and navigating to the folder where `main.py` is located.
167
 
168
- 2. **Activate the Virtual Environment:**
169
- - Open the integrated terminal within Visual Studio Code by selecting **View > Terminal**.
170
  - Activate the virtual environment:
171
  - On **Windows**:
172
  ```bash
@@ -177,50 +185,36 @@ After completing the installation, you can run **IMageDucHaiten** using Visual S
177
  source venv/bin/activate
178
  ```
179
 
180
- 3. **Run the Application:**
181
  - In the terminal, start the application by running:
182
  ```bash
183
  python main.py
184
  ```
185
-
186
  - Alternatively, you can press **F5** to run the application with debugging.
187
 
188
- ### **Installing Visual Studio Code**
189
 
190
  If you don't have Visual Studio Code installed, follow these steps:
191
 
192
- 1. **Download Visual Studio Code:**
193
  - Go to [Visual Studio Code's official site](https://code.visualstudio.com/).
194
  - Download the appropriate version for your operating system.
195
 
196
- 2. **Install Visual Studio Code:**
197
  - Run the installer and follow the on-screen instructions to complete the installation.
198
 
199
- 3. **Install the Python Extension:**
200
  - Open Visual Studio Code and go to the **Extensions** view by clicking on the square icon in the sidebar or pressing `Ctrl+Shift+X`.
201
  - Search for "Python" and install the extension provided by Microsoft.
202
 
203
- After installing Visual Studio Code and the Python extension, you can follow the instructions above to run your application.
204
-
205
- ![Screenshot_1.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/Lfy93t29PfhazAAm9PzEi.png)
206
- ![Screenshot_2.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/-YdFtf3_-hCsjykh7XkDX.png)
207
- ![Screenshot_3.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/BLqDam81vkPpvWTKs9d42.png)
208
- ![Screenshot_4.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/cdhsBMhFMYzuEtNj2z4Tw.png)
209
- ![Screenshot_5.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/vtUoLEHhR5k5SIWwxEQDt.png)
210
- ![Screenshot_6.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/MEl_THxy-7IVjvLOtUa8P.png)
211
- ![Screenshot_7.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/ztbJOamnGoXVi49bJ0hqR.png)
212
- ![Screenshot_8.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/qw3osuCswU_8UaLqrshHY.png)
213
- ![Screenshot_9.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/fI-8nFHyWx3uGlss2bnpC.png)
214
- ![Screenshot_10.png](https://cdn-uploads.huggingface.co/production/uploads/630b58b279d18d5e53e3a5a9/3L644SpuP6lFj821PoViM.png)
215
-
216
- ## **Community and Support**
217
 
218
  Join our community to stay updated, share your experiences, and get support from other users:
219
 
220
  - **Discord Server**: Join our Discord community for discussions, support, and updates.
221
  - [Join Discord](https://discord.gg/vKEW6jqa49)
222
 
223
- ## **Support and Contributions**
224
 
225
  If you find **IMageDucHaiten** useful and would like to support the project, consider making a donation or becoming a patron. Your contributions help in maintaining and improving the project:
226
 
 
1
+ # IMageDucHaiten
 
 
 
 
2
 
3
+ **Version:** `V1.1.1`
4
 
5
+ ## Table of Contents
 
 
6
 
7
  - [Introduction](#introduction)
8
+ - [Key Features](#key-features)
9
  - [Installation](#installation)
10
+ - [Option 1: Full Package Installation via Direct Download](#option-1-full-package-installation-via-direct-download)
11
+ - [Option 2: Full Package Installation via Git Clone](#option-2-full-package-installation-via-git-clone)
12
+ - [Option 3: Manual Installation by Downloading Individual Files](#option-3-manual-installation-by-downloading-individual-files)
13
  - [Usage](#usage)
14
+ - [Running the Application via Command Line (CMD)](#running-the-application-via-command-line-cmd)
15
+ - [Running the Application via Visual Studio Code](#running-the-application-via-visual-studio-code)
16
+ - [Installing Visual Studio Code](#installing-visual-studio-code)
17
  - [Community and Support](#community-and-support)
18
+ - [Support and Contributions](#support-and-contributions)
19
 
20
+ ## Introduction
21
 
22
+ **IMageDucHaiten** is a powerful tool specifically designed for AI professionals to assist in the preparation of image data for training generative AI models. Version `V1.1.1` offers a suite of automated and flexible tools for processing, tagging, and captioning images, making the data preparation process more efficient and streamlined.
23
 
24
+ Whether you're an AI researcher, data engineer, or someone who enjoys working with images, **IMageDucHaiten** can be an invaluable tool. It not only excels in supporting AI data preparation but is also accessible and beneficial to anyone looking to work with images effortlessly and effectively.
25
 
26
+ ## Key Features
27
 
28
  - **Image Converter**: Convert image formats to match the requirements of your AI model, supporting a wide range of formats such as PNG, JPG, GIF, BMP, and more.
29
+ - **Image Filter**: Filter and remove images that do not meet quality criteria such as size and resolution, ensuring a clean dataset for training.
30
  - **Rotate & Flip**: Rotate and flip images to create various training data variations, enhancing dataset diversity.
31
  - **Image Error Fix**: Automatically detect and fix errors in images, reducing the risk of using incomplete data.
32
  - **Image To Tag**: Automatically tag images, optimizing the data labeling process for AI models.
 
34
  - **Photo Fantasy**: Create artistic effects on images, useful for data augmentation or enhancing creative content.
35
  - **Shuffle Image**: Shuffle or sequence images to create a diverse dataset, suitable for analysis and modeling tasks.
36
 
37
+ ## Installation
 
 
38
 
39
  To install and set up **IMageDucHaiten**, you have three options:
40
 
41
+ ### Option 1: Full Package Installation via Direct Download
42
 
43
+ 1. **Download the Full Package**:
44
  - Download the full package from the following link:
45
  [IMageDucHaiten_v1.1.1-Full.zip](https://huggingface.co/DucHaiten/IMageDucHaiten-Full/resolve/main/IMageDucHaiten_v1.1.1-Full.zip)
46
 
47
+ 2. **Extract the Package**:
48
  - Extract the contents of the `.zip` file to your desired location.
49
 
50
+ 3. **Install Visual Studio Code (if not installed)**:
51
  - Download and install Visual Studio Code from [here](https://code.visualstudio.com/).
 
52
 
53
+ 4. **Activate the Virtual Environment**:
54
+ - Open the extracted folder in Visual Studio Code by selecting `File > Open Folder` and navigating to the extracted folder.
55
+ - Open the integrated terminal within Visual Studio Code by selecting `View > Terminal`.
56
  - Activate the pre-configured virtual environment:
57
  - On **Windows**:
58
  ```bash
 
63
  source venv/bin/activate
64
  ```
65
 
66
+ 5. **Run the Application**:
67
+ - After activating the virtual environment, you can start the application by running:
68
+ ```bash
69
+ python main.py
70
+ ```
71
 
72
+ ### Option 2: Full Package Installation via Git Clone
73
 
74
+ 1. **Install Git and Git LFS**:
75
+ - Ensure Git is installed on your system. If not, download and install it from [Git's official site](https://git-scm.com/downloads).
76
+ - Install Git LFS (Large File Storage) by running:
77
  ```bash
78
  git lfs install
79
  ```
80
 
81
+ 2. **Clone the Repository**:
82
  - Use Git to clone the repository with all necessary files:
83
  ```bash
84
  git clone https://huggingface.co/DucHaiten/IMageDucHaiten
85
  ```
86
 
87
+ 3. **Open the Project in Visual Studio Code**:
88
  - If you haven't installed Visual Studio Code, download and install it from [here](https://code.visualstudio.com/).
89
+ - Open Visual Studio Code, then select `File > Open Folder` and navigate to the cloned folder.
90
 
91
+ 4. **Activate the Virtual Environment**:
92
+ - Open the integrated terminal by selecting `View > Terminal`.
93
  - Activate the virtual environment:
94
  - On **Windows**:
95
  ```bash
 
100
  source venv/bin/activate
101
  ```
102
 
103
+ 5. **Run the Application**:
104
+ - Start the application by running:
105
+ ```bash
106
+ python main.py
107
+ ```
108
 
109
+ ### Option 3: Manual Installation by Downloading Individual Files
110
 
111
+ 1. **Download the Files Manually**:
112
  - Download individual files and directories from the repository as needed.
113
 
114
+ 2. **Set up a Virtual Environment**:
115
  - Create and activate a virtual environment:
116
  - On **Windows**:
117
  ```bash
 
124
  source venv/bin/activate
125
  ```
126
 
127
+ 3. **Install Python Dependencies**:
128
  - Install the required Python packages using `requirements.txt`:
129
  ```bash
130
  pip install -r requirements.txt
 
133
  4. **Install External Dependencies** (Ghostscript, ImageMagick, Visual C++ Redistributable):
134
  - Follow the instructions provided earlier to ensure all dependencies are properly installed.
135
 
136
+ 5. **Open the Project in Visual Studio Code**:
137
  - If you haven't installed Visual Studio Code, download and install it from [here](https://code.visualstudio.com/).
138
+ - Open Visual Studio Code, then select `File > Open Folder` and navigate to the project folder.
139
 
140
+ 6. **Run the Application**:
141
+ - Open the integrated terminal by selecting `View > Terminal`.
142
+ - Activate the virtual environment, then start the application by running:
143
+ ```bash
144
+ python main.py
145
+ ```
146
 
147
+ ## Usage
148
 
149
+ After completing the installation, you can run **IMageDucHaiten** as follows:
150
 
151
+ ### Running the Application via Command Line (CMD)
152
 
153
+ 1. **Activate the Virtual Environment**:
154
  - On **Windows**:
155
  ```bash
156
  .\venv\Scripts\activate
 
160
  source venv/bin/activate
161
  ```
162
 
163
+ 2. **Run the Application**:
164
  - In the terminal, navigate to the folder where `main.py` is located.
165
  - Execute the following command to start the application:
166
  ```bash
167
  python main.py
168
  ```
169
 
170
+ ### Running the Application via Visual Studio Code
171
 
172
+ 1. **Open the Project in Visual Studio Code**:
173
  - Launch Visual Studio Code.
174
+ - Open the project folder by selecting `File > Open Folder` and navigating to the folder where `main.py` is located.
175
 
176
+ 2. **Activate the Virtual Environment**:
177
+ - Open the integrated terminal within Visual Studio Code by selecting `View > Terminal`.
178
  - Activate the virtual environment:
179
  - On **Windows**:
180
  ```bash
 
185
  source venv/bin/activate
186
  ```
187
 
188
+ 3. **Run the Application**:
189
  - In the terminal, start the application by running:
190
  ```bash
191
  python main.py
192
  ```
 
193
  - Alternatively, you can press **F5** to run the application with debugging.
194
 
195
+ ### Installing Visual Studio Code
196
 
197
  If you don't have Visual Studio Code installed, follow these steps:
198
 
199
+ 1. **Download Visual Studio Code**:
200
  - Go to [Visual Studio Code's official site](https://code.visualstudio.com/).
201
  - Download the appropriate version for your operating system.
202
 
203
+ 2. **Install Visual Studio Code**:
204
  - Run the installer and follow the on-screen instructions to complete the installation.
205
 
206
+ 3. **Install the Python Extension**:
207
  - Open Visual Studio Code and go to the **Extensions** view by clicking on the square icon in the sidebar or pressing `Ctrl+Shift+X`.
208
  - Search for "Python" and install the extension provided by Microsoft.
209
 
210
+ ## Community and Support
 
 
 
 
 
 
 
 
 
 
 
 
 
211
 
212
  Join our community to stay updated, share your experiences, and get support from other users:
213
 
214
  - **Discord Server**: Join our Discord community for discussions, support, and updates.
215
  - [Join Discord](https://discord.gg/vKEW6jqa49)
216
 
217
+ ## Support and Contributions
218
 
219
  If you find **IMageDucHaiten** useful and would like to support the project, consider making a donation or becoming a patron. Your contributions help in maintaining and improving the project:
220