Create README.md

README.md

@@ -0,0 +1,53 @@
+---
+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:
+- Stable Diffusion
+- image-generation
+- Flux
+- diffusers
+- controlnet
+---
+
+![Controlnet collections for Flux](https://github.com/XLabs-AI/x-flux/blob/main/assets/readme/light/flux-controlnet-collections.png?raw=true)
+[<img src="https://github.com/XLabs-AI/x-flux/blob/main/assets/readme/light/join-our-discord-rev1.png?raw=true">](https://discord.gg/FHY2guThfy)
+
+This repository provides a IP-Adapter checkpoint for
+[FLUX.1-dev model](https://huggingface.co/black-forest-labs/FLUX.1-dev) by Black Forest Labs
+
+![Example Picture 1](assets/depth_result.gif?raw=true)
+
+[See our github](https://github.com/XLabs-AI/x-flux-comfyui) for comfy ui workflows.
+![Example Picture 1](assets/controlnet_depth_flow_example.png?raw=true)
+
+[See our github](https://github.com/XLabs-AI/x-flux) for train script, train configs and demo script for inference.
+
+# Models
+IP-Adapter is trained on 512x512 resolution for 50k steps and 1024x1024 for 25k steps resolution and works for both 512x512 and 1024x1024 resolution.
+We release **v1 version** - better and realistic version, which can be used directly in ComfyUI!   
+
+Please, see our [ComfyUI custom nodes installation guide](https://github.com/XLabs-AI/x-flux-comfyui)
+
+
+# Examples
+
+See examples of our models results below.  
+Also, some generation results with input images are provided in "Files and versions"
+
+# Inference
+
+To try our models, you have 2 options:
+1. Use main.py from our [official repo](https://github.com/XLabs-AI/x-flux)
+2. Use our custom nodes for ComfyUI and test it with provided workflows (check out folder /workflows)
+
+Please, try our workflow "ipadapter_workflow.json"
+
+![Example Picture 1](assets/ip_adapter_example1.png?raw=true)
+
+## License
+
+Our weights fall under the [FLUX.1 [dev]](https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/LICENSE.md) Non-Commercial License<br/>