Create README.md

README.md

@@ -0,0 +1,56 @@
+---
+license: other
+license_name: flux-1-dev-non-commercial-license
+license_link: https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/LICENSE.
+language:
+- en
+pipeline_tag: text-to-image
+tags:
+- LoRA
+- Stable Diffusion
+- image-generation
+- Flux
+---
+![Lora Photorealism for Flux](https://github.com/XLabs-AI/x-flux/blob/main/assets/readme/light/lora-photorealism-header-rev1.png?raw=true)
+
+This repository provides a checkpoint with trained LoRAs for
+[FLUX.1-dev model](https://huggingface.co/black-forest-labs/FLUX.1-dev) by Black Forest Labs
+
+![Example Picture 1](https://github.com/XLabs-AI/x-flux/blob/main/assets/readme/examples/picture-6-rev1.png?raw=true)
+
+# Training details
+[XLabs AI](https://github.com/XLabs-AI) team is happy to publish fune-tuning Flux scripts, including:
+
+- **LoRA** 🔥
+- **ControlNet** 🔥
+
+[See our github](https://github.com/XLabs-AI/x-flux) for train script and train configs.
+
+# Training Dataset
+Dataset has the following format for the training process:
+
+```
+├── images/
+│    ├── 1.png
+│    ├── 1.json
+│    ├── 2.png
+│    ├── 2.json
+│    ├── ...
+```
+A .json file contains "caption" field with a text prompt.
+
+# Inference
+#
+```bash
+python3 main.py \
+--prompt "A handsome man in a suit, 25 years old, cool, futuristic" \
+--lora_repo_id XLabs-AI/flux-lora-collection --lora_name mjv6_lora.safetensors \
+--device cuda:4 --offload --use_lora --model_type flux-dev-fp8 --width 1024 --height 1024
+```
+
+![Example Picture 1](https://github.com/XLabs-AI/x-flux/blob/main/assets/readme/examples/result_13.png?raw=true)
+
+
+# License
+
+lora.safetensors falls under the [FLUX.1 [dev]](https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/LICENSE.md) Non-Commercial License<br/>