ChuckMcSneed commited on
Commit
cc6cb3e
1 Parent(s): 6ddb8dc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +99 -92
README.md CHANGED
@@ -1,93 +1,100 @@
1
- ---
2
- language:
3
- - en
4
- library_name: flux
5
- license: other
6
- license_name: flux-1-dev-non-commercial-license
7
- license_link: LICENSE.md
8
- extra_gated_prompt: By clicking "Agree", you agree to the [FluxDev Non-Commercial License Agreement](https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/LICENSE.md)
9
- and acknowledge the [Acceptable Use Policy](https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/POLICY.md).
10
- tags:
11
- - text-to-image
12
- - image-generation
13
- ---
14
-
15
- ![FLUX.1 [dev] Grid](./dev_grid.jpg)
16
-
17
- `FLUX.1 [dev]` is a 12 billion parameter rectified flow transformer capable of generating images from text descriptions.
18
- For more information, please read our [blog post](https://blackforestlabs.ai/announcing-black-forest-labs/).
19
-
20
- # Key Features
21
- 1. Cutting-edge output quality, second only to our state-of-the-art model `FLUX.1 [pro]`.
22
- 2. Competitive prompt following, matching the performance of closed source alternatives .
23
- 3. Trained using guidance distillation, making `FLUX.1 [dev]` more efficient.
24
- 4. Open weights to drive new scientific research, and empower artists to develop innovative workflows.
25
- 5. Generated outputs can be used for personal, scientific, and commercial purposes as described in the [flux-1-dev-non-commercial-license](./licence.md).
26
-
27
- # Usage
28
- We provide a reference implementation of `FLUX.1 [dev]`, as well as sampling code, in a dedicated [github repository](https://github.com/black-forest-labs/flux).
29
- Developers and creatives looking to build on top of `FLUX.1 [dev]` are encouraged to use this as a starting point.
30
-
31
- ## API Endpoints
32
- The FLUX.1 models are also available via API from the following sources
33
- 1. [bfl.ml](https://docs.bfl.ml/) (currently `FLUX.1 [pro]`)
34
- 2. [replicate.com](https://replicate.com/collections/flux)
35
- 3. [fal.ai](https://fal.ai/models/fal-ai/flux)
36
-
37
- ## ComfyUI
38
- `FLUX.1 [dev]` is also available in [Comfy UI](https://github.com/comfyanonymous/ComfyUI) for local inference with a node-based workflow.
39
-
40
- ## Diffusers
41
-
42
- To use `FLUX.1 [dev]` with the 🧨 diffusers python library, first install or upgrade diffusers
43
-
44
- ```shell
45
- pip install git+https://github.com/huggingface/diffusers.git
46
- ```
47
-
48
- Then you can use `FluxPipeline` to run the model
49
-
50
- ```python
51
- import torch
52
- from diffusers import FluxPipeline
53
-
54
- pipe = FluxPipeline.from_pretrained("black-forest-labs/FLUX.1-dev", torch_dtype=torch.bfloat16)
55
- pipe.enable_model_cpu_offload() #save some VRAM by offloading the model to CPU. Remove this if you have enough GPU power
56
-
57
- prompt = "A cat holding a sign that says hello world"
58
- image = pipe(
59
- prompt,
60
- height=1024,
61
- width=1024,
62
- guidance_scale=3.5,
63
- output_type="pil",
64
- num_inference_steps=50,
65
- max_sequence_length=512,
66
- generator=torch.Generator("cpu").manual_seed(0)
67
- ).images[0]
68
- image.save("flux-dev.png")
69
- ```
70
-
71
- To learn more check out the [diffusers](https://huggingface.co/docs/diffusers/main/en/api/pipelines/flux) documentation
72
-
73
- ---
74
- # Limitations
75
- - This model is not intended or able to provide factual information.
76
- - As a statistical model this checkpoint might amplify existing societal biases.
77
- - The model may fail to generate output that matches the prompts.
78
- - Prompt following is heavily influenced by the prompting-style.
79
-
80
- # Out-of-Scope Use
81
- The model and its derivatives may not be used
82
-
83
- - In any way that violates any applicable national, federal, state, local or international law or regulation.
84
- - For the purpose of exploiting, harming or attempting to exploit or harm minors in any way; including but not limited to the solicitation, creation, acquisition, or dissemination of child exploitative content.
85
- - To generate or disseminate verifiably false information and/or content with the purpose of harming others.
86
- - To generate or disseminate personal identifiable information that can be used to harm an individual.
87
- - To harass, abuse, threaten, stalk, or bully individuals or groups of individuals.
88
- - To create non-consensual nudity or illegal pornographic content.
89
- - For fully automated decision making that adversely impacts an individual's legal rights or otherwise creates or modifies a binding, enforceable obligation.
90
- - Generating or facilitating large-scale disinformation campaigns.
91
-
92
- # License
 
 
 
 
 
 
 
93
  This model falls under the [`FLUX.1 [dev]` Non-Commercial License](https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/LICENSE.md).
 
1
+ ---
2
+ language:
3
+ - en
4
+ library_name: flux
5
+ license: other
6
+ license_name: flux-1-dev-non-commercial-license
7
+ license_link: LICENSE.md
8
+ extra_gated_prompt: By clicking "Agree", you agree to the [FluxDev Non-Commercial License Agreement](https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/LICENSE.md)
9
+ and acknowledge the [Acceptable Use Policy](https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/POLICY.md).
10
+ tags:
11
+ - text-to-image
12
+ - image-generation
13
+ ---
14
+
15
+ Flux reupload for those who don't want to make a throwaway account to download it.
16
+
17
+ # Original card below
18
+
19
+ ---
20
+
21
+
22
+ ![FLUX.1 [dev] Grid](./dev_grid.jpg)
23
+
24
+ `FLUX.1 [dev]` is a 12 billion parameter rectified flow transformer capable of generating images from text descriptions.
25
+ For more information, please read our [blog post](https://blackforestlabs.ai/announcing-black-forest-labs/).
26
+
27
+ # Key Features
28
+ 1. Cutting-edge output quality, second only to our state-of-the-art model `FLUX.1 [pro]`.
29
+ 2. Competitive prompt following, matching the performance of closed source alternatives .
30
+ 3. Trained using guidance distillation, making `FLUX.1 [dev]` more efficient.
31
+ 4. Open weights to drive new scientific research, and empower artists to develop innovative workflows.
32
+ 5. Generated outputs can be used for personal, scientific, and commercial purposes as described in the [flux-1-dev-non-commercial-license](./licence.md).
33
+
34
+ # Usage
35
+ We provide a reference implementation of `FLUX.1 [dev]`, as well as sampling code, in a dedicated [github repository](https://github.com/black-forest-labs/flux).
36
+ Developers and creatives looking to build on top of `FLUX.1 [dev]` are encouraged to use this as a starting point.
37
+
38
+ ## API Endpoints
39
+ The FLUX.1 models are also available via API from the following sources
40
+ 1. [bfl.ml](https://docs.bfl.ml/) (currently `FLUX.1 [pro]`)
41
+ 2. [replicate.com](https://replicate.com/collections/flux)
42
+ 3. [fal.ai](https://fal.ai/models/fal-ai/flux)
43
+
44
+ ## ComfyUI
45
+ `FLUX.1 [dev]` is also available in [Comfy UI](https://github.com/comfyanonymous/ComfyUI) for local inference with a node-based workflow.
46
+
47
+ ## Diffusers
48
+
49
+ To use `FLUX.1 [dev]` with the 🧨 diffusers python library, first install or upgrade diffusers
50
+
51
+ ```shell
52
+ pip install git+https://github.com/huggingface/diffusers.git
53
+ ```
54
+
55
+ Then you can use `FluxPipeline` to run the model
56
+
57
+ ```python
58
+ import torch
59
+ from diffusers import FluxPipeline
60
+
61
+ pipe = FluxPipeline.from_pretrained("black-forest-labs/FLUX.1-dev", torch_dtype=torch.bfloat16)
62
+ pipe.enable_model_cpu_offload() #save some VRAM by offloading the model to CPU. Remove this if you have enough GPU power
63
+
64
+ prompt = "A cat holding a sign that says hello world"
65
+ image = pipe(
66
+ prompt,
67
+ height=1024,
68
+ width=1024,
69
+ guidance_scale=3.5,
70
+ output_type="pil",
71
+ num_inference_steps=50,
72
+ max_sequence_length=512,
73
+ generator=torch.Generator("cpu").manual_seed(0)
74
+ ).images[0]
75
+ image.save("flux-dev.png")
76
+ ```
77
+
78
+ To learn more check out the [diffusers](https://huggingface.co/docs/diffusers/main/en/api/pipelines/flux) documentation
79
+
80
+ ---
81
+ # Limitations
82
+ - This model is not intended or able to provide factual information.
83
+ - As a statistical model this checkpoint might amplify existing societal biases.
84
+ - The model may fail to generate output that matches the prompts.
85
+ - Prompt following is heavily influenced by the prompting-style.
86
+
87
+ # Out-of-Scope Use
88
+ The model and its derivatives may not be used
89
+
90
+ - In any way that violates any applicable national, federal, state, local or international law or regulation.
91
+ - For the purpose of exploiting, harming or attempting to exploit or harm minors in any way; including but not limited to the solicitation, creation, acquisition, or dissemination of child exploitative content.
92
+ - To generate or disseminate verifiably false information and/or content with the purpose of harming others.
93
+ - To generate or disseminate personal identifiable information that can be used to harm an individual.
94
+ - To harass, abuse, threaten, stalk, or bully individuals or groups of individuals.
95
+ - To create non-consensual nudity or illegal pornographic content.
96
+ - For fully automated decision making that adversely impacts an individual's legal rights or otherwise creates or modifies a binding, enforceable obligation.
97
+ - Generating or facilitating large-scale disinformation campaigns.
98
+
99
+ # License
100
  This model falls under the [`FLUX.1 [dev]` Non-Commercial License](https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/LICENSE.md).