Merge pull request #13 from okotaku/feat/dataset_docs

[Docs] prepare dataset
okotaku · Aug 1, 2023 · 2e7f08d · 2e7f08d
2 parents 07459cb + 3106bb6
commit 2e7f08d
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -25,6 +25,7 @@ Other tutorials for:
 
 - [Run Stable Diffusion](docs/source/run_sd.md)
 - [Run Stable Diffusion XL](docs/source/run_sdxl.md)
+- [Prepare Dataset](docs/source//dataset_prepare.md)
 
 ## Contributing
 

diff --git a/docs/source/dataset_prepare.md b/docs/source/dataset_prepare.md
@@ -0,0 +1,65 @@
+# Prepare Dataset
+
+## Finetune 
+
+1. Prepare `metadata.csv` and images.
+
+The folder structure is
+
+```
+data/example
+├── color.jpg
+├── ...
+└── metadata.csv
+```
+
+Example of `metadata.csv`.
+
+```
+file_name,text
+color.jpg,"a dog"
+```
+
+2. Fix dataset config.
+
+```
+train_dataloader = dict(
+    ...
+    dataset=dict(
+        ...
+        dataset='data/example',
+        image_column='file_name'
+        )
+    ...
+)
+```
+
+3. Run training.
+
+## DreamBooth
+
+1. Prepare images.
+
+The folder structure is
+
+```
+data/example
+├── dog1.jpg
+├── ...
+└── dog5.jpg
+```
+
+2. Fix dataset config.
+
+```
+train_dataloader = dict(
+    ...
+    dataset=dict(
+        ...
+        dataset='data/example',
+        )
+    ...
+)
+```
+
+3. Run training.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,6 +19,12 @@ Welcome to diffengine's documentation!
 
    run_sdxl.md
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Dataset Prepare
+
+   dataset_prepare.md
+
 .. toctree::
    :maxdepth: 1
    :caption: API Reference