diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..8127969a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,20 @@ +--- +name: Bug Report +about: For bugs only. Not for feature requests or questions. +title: '' +labels: '' +assignees: '' +--- + +## This is for bugs only + +Did you already ask [in the discord](https://discord.com/invite/nuR9zZ2nsh)? + +Yes/No + +You verified that this is a bug and not a feature request or question by asking [in the discord](https://discord.com/invite/nuR9zZ2nsh)? + +Yes/No + +## Describe the bug + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..63453d51 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask in the Discord BEFORE opening an issue + url: https://discord.com/invite/nuR9zZ2nsh + about: Please ask in the discord before opening a github issue. \ No newline at end of file diff --git a/README.md b/README.md index 45779dff..9c2e9e70 100644 --- a/README.md +++ b/README.md @@ -115,8 +115,51 @@ Please do not open a bug report unless it is a bug in the code. You are welcome and ask for help there. However, please refrain from PMing me directly with general question or support. Ask in the discord and I will answer when I can. +### Training in RunPod cloud +Example RunPod template: **runpod/pytorch:2.2.0-py3.10-cuda12.1.1-devel-ubuntu22.04** +> You need a minimum of 24GB VRAM, pick a GPU by your preference. + +#### Example config ($0.5/hr): +- 1x A40 (48 GB VRAM) +- 19 vCPU 100 GB RAM + +#### Custom overrides (you need some storage to clone FLUX.1, store datasets, store trained models and samples): +- ~120 GB Disk +- ~120 GB Pod Volume +- Start Jupyter Notebook + +### 1. Setup +``` +git clone https://github.com/ostris/ai-toolkit.git +cd ai-toolkit +git submodule update --init --recursive +python -m venv venv +source venv/bin/activate +pip install torch +pip install -r requirements.txt +pip install --upgrade accelerate transformers diffusers huggingface_hub #Optional, run it if you run into issues +``` +### 2. Upload your dataset +- Create a new folder in the root, name it `dataset` or whatever you like +- Drag and drop your .jpg and .txt files inside the newly created dataset folder + +### 3. Login into Hugging Face with an Access Token +- Get a READ token from [here](https://huggingface.co/settings/tokens) +- Run ```huggingface-cli login``` and paste your token + +### 4. Training +- Copy an example config file located at ```config/examples``` to the config folder and rename it to ```whatever_you_want.yml``` +- Edit the config following the comments in the file +- Change ```folder_path: "/path/to/images/folder"``` to your dataset path like ```folder_path: "/workspace/ai-toolkit/your-dataset"``` +- Run the file: ```python run.py config/whatever_you_want.yml``` + +### Screenshot from RunPod +RunPod Training Screenshot + + --- diff --git a/requirements.txt b/requirements.txt index 23781266..119eeee0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -27,4 +27,5 @@ hf_transfer lpips pytorch_fid optimum-quanto -sentencepiece \ No newline at end of file +sentencepiece +huggingface_hub