Merge branch 'main' of https://github.com/black-forest-labs/flux

Author: lone17

README.md

@@ -1,14 +1,15 @@
 # FLUX
 
 by Black Forest Labs: https://blackforestlabs.ai
+by Black Forest Labs: https://blackforestlabs.ai. Documentation for our API can be found here: [docs.bfl.ml](https://docs.bfl.ml/).
 
 ![grid](assets/grid.jpg)
 
 This repo contains minimal inference code to run text-to-image and image-to-image with our Flux latent rectified flow transformers.
 
 ### Inference partners
 
-We are happy to partner with [Replicate](https://replicate.com/), [FAL](https://fal.ai/) and [Mystic](https://www.mystic.ai). You can sample our models using their services.
+We are happy to partner with [Replicate](https://replicate.com/), [FAL](https://fal.ai/), [Mystic](https://www.mystic.ai), and [Together](https://www.together.ai/). You can sample our models using their services.
 Below we list relevant links.
 
 Replicate:
@@ -32,6 +33,13 @@ Mystic:
 - https://www.mystic.ai/black-forest-labs/flux1-dev
 - https://www.mystic.ai/black-forest-labs/flux1-schnell
 
+Together:
+
+- https://api.together.xyz/playground/image/black-forest-labs/FLUX.1-schnell-Free (ends December 31, 2024)
+- https://api.together.xyz/playground/image/black-forest-labs/FLUX.1-schnell
+- https://api.together.xyz/playground/image/black-forest-labs/FLUX.1.1-pro
+- https://api.together.xyz/playground/image/black-forest-labs/FLUX.1-pro
+
 ## Local installation
 
 ```bash
@@ -46,7 +54,8 @@ pip install -e ".[all]"
 
 We are offering three models:
 
-- `FLUX.1 [pro]` the base model, available via API
+- `FLUX1.1 [pro]` available via API only
+- `FLUX.1 [pro]` available via API only
 - `FLUX.1 [dev]` guidance-distilled variant
 - `FLUX.1 [schnell]` guidance and step-distilled variant
 
@@ -55,6 +64,7 @@ We are offering three models:
 | `FLUX.1 [schnell]` | https://huggingface.co/black-forest-labs/FLUX.1-schnell | [apache-2.0](model_licenses/LICENSE-FLUX1-schnell)                    | a9e1e277b9b16add186f38e3f5a34044 |
 | `FLUX.1 [dev]`     | https://huggingface.co/black-forest-labs/FLUX.1-dev     | [FLUX.1-dev Non-Commercial License](model_licenses/LICENSE-FLUX1-dev) | a6bd8c16dfc23db6aee2f63a2eba78c0 |
 | `FLUX.1 [pro]`     | Only available in our API.                              |
+| `FLUX1.1 [pro]`    | Only available in our API.                              |
 
 The weights of the autoencoder are also released under [apache-2.0](https://huggingface.co/datasets/choosealicense/licenses/blob/main/markdown/apache-2.0.md) and can be found in either of the two HuggingFace repos above. They are the same for both models.
 
@@ -158,7 +168,7 @@ To learn more check out the [diffusers](https://huggingface.co/docs/diffusers/ma
 
 ## API usage
 
-Our API offers access to the pro model. It is documented here:
+Our API offers access to our models. It is documented here:
 [docs.bfl.ml](https://docs.bfl.ml/).
 
 In this repository we also offer an easy python interface. To use this, you
@@ -175,8 +185,8 @@ Usage from python:
 from flux.api import ImageRequest
 
 # this will create an api request directly but not block until the generation is finished
-request = ImageRequest("A beautiful beach")
-# or: request = ImageRequest("A beautiful beach", api_key="your_key_here")
+request = ImageRequest("A beautiful beach", name="flux.1.1-pro")
+# or: request = ImageRequest("A beautiful beach", name="flux.1.1-pro", api_key="your_key_here")
 
 # any of the following will block until the generation is finished
 request.url

demo_gr.py

@@ -1,6 +1,5 @@
 import os
 import time
-from io import BytesIO
 import uuid
 
 import torch

src/flux/api.py

@@ -6,7 +6,12 @@
 import requests
 from PIL import Image
 
-API_ENDPOINT = "https://api.bfl.ml"
+API_URL = "https://api.bfl.ml"
+API_ENDPOINTS = {
+    "flux.1-pro": "flux-pro",
+    "flux.1-dev": "flux-dev",
+    "flux.1.1-pro": "flux-pro-1.1",
+}
 
 
 class ApiException(Exception):
@@ -31,60 +36,97 @@ def __repr__(self) -> str:
 class ImageRequest:
     def __init__(
         self,
+        # api inputs
         prompt: str,
-        width: int = 1024,
-        height: int = 1024,
-        name: str = "flux.1-pro",
-        num_steps: int = 50,
-        prompt_upsampling: bool = False,
+        name: str = "flux.1.1-pro",
+        width: int | None = None,
+        height: int | None = None,
+        num_steps: int | None = None,
+        prompt_upsampling: bool | None = None,
         seed: int | None = None,
+        guidance: float | None = None,
+        interval: float | None = None,
+        safety_tolerance: int | None = None,
+        # behavior of this class
         validate: bool = True,
         launch: bool = True,
         api_key: str | None = None,
     ):
         """
         Manages an image generation request to the API.
 
+        All parameters not specified will use the API defaults.
+
         Args:
-            prompt: Prompt to sample
-            width: Width of the image in pixel
-            height: Height of the image in pixel
-            name: Name of the model
-            num_steps: Number of network evaluations
-            prompt_upsampling: Use prompt upsampling
-            seed: Fix the generation seed
+            prompt: Text prompt for image generation.
+            width: Width of the generated image in pixels. Must be a multiple of 32.
+            height: Height of the generated image in pixels. Must be a multiple of 32.
+            name: Which model version to use
+            num_steps: Number of steps for the image generation process.
+            prompt_upsampling: Whether to perform upsampling on the prompt.
+            seed: Optional seed for reproducibility.
+            guidance: Guidance scale for image generation.
+            safety_tolerance: Tolerance level for input and output moderation.
+                 Between 0 and 6, 0 being most strict, 6 being least strict.
             validate: Run input validation
             launch: Directly launches request
             api_key: Your API key if not provided by the environment
 
         Raises:
-            ValueError: For invalid input
+            ValueError: For invalid input, when `validate`
             ApiException: For errors raised from the API
         """
         if validate:
-            if name not in ["flux.1-pro"]:
+            if name not in API_ENDPOINTS.keys():
                 raise ValueError(f"Invalid model {name}")
-            elif width % 32 != 0:
+            elif width is not None and width % 32 != 0:
                 raise ValueError(f"width must be divisible by 32, got {width}")
-            elif not (256 <= width <= 1440):
+            elif width is not None and not (256 <= width <= 1440):
                 raise ValueError(f"width must be between 256 and 1440, got {width}")
-            elif height % 32 != 0:
+            elif height is not None and height % 32 != 0:
                 raise ValueError(f"height must be divisible by 32, got {height}")
-            elif not (256 <= height <= 1440):
+            elif height is not None and not (256 <= height <= 1440):
                 raise ValueError(f"height must be between 256 and 1440, got {height}")
-            elif not (1 <= num_steps <= 50):
+            elif num_steps is not None and not (1 <= num_steps <= 50):
                 raise ValueError(f"steps must be between 1 and 50, got {num_steps}")
-
+            elif guidance is not None and not (1.5 <= guidance <= 5.0):
+                raise ValueError(f"guidance must be between 1.5 and 4, got {guidance}")
+            elif interval is not None and not (1.0 <= interval <= 4.0):
+                raise ValueError(f"interval must be between 1 and 4, got {interval}")
+            elif safety_tolerance is not None and not (0 <= safety_tolerance <= 6.0):
+                raise ValueError(
+                    f"safety_tolerance must be between 0 and 6, got {interval}"
+                )
+
+            if name == "flux.1-dev":
+                if interval is not None:
+                    raise ValueError("Interval is not supported for flux.1-dev")
+            if name == "flux.1.1-pro":
+                if (
+                    interval is not None
+                    or num_steps is not None
+                    or guidance is not None
+                ):
+                    raise ValueError(
+                        "Interval, num_steps and guidance are not supported for "
+                        "flux.1.1-pro"
+                    )
+
+        self.name = name
         self.request_json = {
             "prompt": prompt,
             "width": width,
             "height": height,
-            "variant": name,
             "steps": num_steps,
             "prompt_upsampling": prompt_upsampling,
+            "seed": seed,
+            "guidance": guidance,
+            "interval": interval,
+            "safety_tolerance": safety_tolerance,
+        }
+        self.request_json = {
+            key: value for key, value in self.request_json.items() if value is not None
         }
-        if seed is not None:
-            self.request_json["seed"] = seed
 
         self.request_id: str | None = None
         self.result: dict | None = None
@@ -105,7 +147,7 @@ def request(self):
         if self.request_id is not None:
             return
         response = requests.post(
-            f"{API_ENDPOINT}/v1/image",
+            f"{API_URL}/v1/{API_ENDPOINTS[self.name]}",
             headers={
                 "accept": "application/json",
                 "x-key": self.api_key,
@@ -115,7 +157,9 @@ def request(self):
         )
         result = response.json()
         if response.status_code != 200:
-            raise ApiException(status_code=response.status_code, detail=result.get("detail"))
+            raise ApiException(
+                status_code=response.status_code, detail=result.get("detail")
+            )
         self.request_id = response.json()["id"]
 
     def retrieve(self) -> dict:
@@ -126,7 +170,7 @@ def retrieve(self) -> dict:
             self.request()
         while self.result is None:
             response = requests.get(
-                f"{API_ENDPOINT}/v1/get_result",
+                f"{API_URL}/v1/get_result",
                 headers={
                     "accept": "application/json",
                     "x-key": self.api_key,
@@ -137,13 +181,17 @@ def retrieve(self) -> dict:
             )
             result = response.json()
             if "status" not in result:
-                raise ApiException(status_code=response.status_code, detail=result.get("detail"))
+                raise ApiException(
+                    status_code=response.status_code, detail=result.get("detail")
+                )
             elif result["status"] == "Ready":
                 self.result = result["result"]
             elif result["status"] == "Pending":
                 time.sleep(0.5)
             else:
-                raise ApiException(status_code=200, detail=f"API returned status '{result['status']}'")
+                raise ApiException(
+                    status_code=200, detail=f"API returned status '{result['status']}'"
+                )
         return self.result
 
     @property

src/flux/cli.py

@@ -80,7 +80,7 @@ def parse_prompt(options: SamplingOptions) -> SamplingOptions | None:
                 continue
             _, steps = prompt.split()
             options.num_steps = int(steps)
-            print(f"Setting seed to {options.num_steps}")
+            print(f"Setting number of steps to {options.num_steps}")
         elif prompt.startswith("/q"):
             print("Quitting")
             return None