kohya_ss/docs
bmaltais f28f96b111
Docs: Comprehensive README overhaul (#3245)
This commit significantly revamps the README.md to improve clarity,
organization, and completeness for you.

Key changes include:
- Enhanced project introduction: Clearly defines project purpose and key features.
- Improved structure:
    - Moved detailed installation guides (Docker, Runpod, Novita) and specific
      troubleshooting (Tesla V100) to separate files in `docs/`.
    - Standardized formatting for notes, warnings, and important messages.
- Content updates and additions:
    - Added a "Prerequisites" section.
    - Expanded the "LoRA" section with links to detailed documentation.
    - Updated "SDXL training" and "Masked loss" sections, removing obsolete notes.
    - Added "Contributing" guidelines and a "License" section.
    - Incorporated badges for GitHub stars, forks, license, and issues.
    - Removed the outdated "ToDo" section.
- Link verification: Ensured internal links are correct and external links
  are properly formatted.
- Change History: Condensed the verbose v25.0.0 entry for better readability.

These changes aim to provide a more user-friendly and informative entry
point for the Kohya's GUI project.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
2025-05-23 20:27:23 -04:00
..
Finetuning Update Finetuning tab structure 2023-07-03 06:56:58 -04:00
LoRA Fix options.md heading 2024-04-18 18:02:14 -04:00
config_README-ja.md add caption_prefix/suffix to dataset 2023-09-02 16:17:12 +09:00
fine_tune_README_ja.md move documents to docs folder 2023-05-07 20:56:42 +09:00
gen_img_README-ja.md update readme and gradual latent doc 2024-02-12 14:52:19 +09:00
image_folder_structure.md Update requirements 2023-06-11 16:33:32 -04:00
installation_docker.md Docs: Comprehensive README overhaul (#3245) 2025-05-23 20:27:23 -04:00
installation_novita.md Docs: Comprehensive README overhaul (#3245) 2025-05-23 20:27:23 -04:00
installation_runpod.md Docs: Comprehensive README overhaul (#3245) 2025-05-23 20:27:23 -04:00
train_README-ja.md Added --sample_at_first description 2023-10-29 21:46:47 +09:00
train_README-zh.md Update train_README-zh.md, fix a few translation errors. 2023-08-29 08:08:40 +08:00
train_README.md Update release 2024-04-17 08:47:38 -04:00
train_db_README-ja.md move documents to docs folder 2023-05-07 20:56:42 +09:00
train_db_README-zh.md move documents to docs folder 2023-05-07 20:56:42 +09:00
train_lllite_README-ja.md fix "\\" to "/" for compatiblity 2023-08-24 19:19:53 +09:00
train_lllite_README.md fix "\\" to "/" for compatiblity 2023-08-24 19:19:53 +09:00
train_network_README-ja.md update doc 2023-10-01 12:17:54 +09:00
train_network_README-zh.md move documents to docs folder 2023-05-07 20:56:42 +09:00
train_ti_README-ja.md move documents to docs folder 2023-05-07 20:56:42 +09:00
troubleshooting_tesla_v100.md Docs: Comprehensive README overhaul (#3245) 2025-05-23 20:27:23 -04:00