flux README

The project's README from github.com/black-forest-labs/flux. As one markdown file: README.md.

FLUX

by Black Forest Labs: https://bfl.ai.

Documentation for our API can be found here: docs.bfl.ai.

grid

This repo contains minimal inference code to run image generation & editing with our Flux open-weight models.

Local installation

cd $HOME && git clone https://github.com/black-forest-labs/flux
cd $HOME/flux
python3.10 -m venv .venv
source .venv/bin/activate
pip install -e ".[all]"

Local installation with TensorRT support

If you would like to install the repository with TensorRT support, you currently need to install a PyTorch image from NVIDIA instead. First install enroot, next follow the steps below:

cd $HOME && git clone https://github.com/black-forest-labs/flux
enroot import 'docker://[email protected]#nvidia/pytorch:25.01-py3'
enroot create -n pti2501 nvidia+pytorch+25.01-py3.sqsh
enroot start --rw -m ${PWD}/flux:/workspace/flux -r pti2501
cd flux
pip install -e ".[tensorrt]" --extra-index-url https://pypi.nvidia.com

Open-weight models

We are offering an extensive suite of open-weight models. For more information about the individual models, please refer to the link under Usage.

Name Usage HuggingFace repo License
FLUX.1 [schnell] Text to Image https://huggingface.co/black-forest-labs/FLUX.1-schnell apache-2.0
FLUX.1 [dev] Text to Image https://huggingface.co/black-forest-labs/FLUX.1-dev FLUX.1-dev Non-Commercial License
FLUX.1 Fill [dev] In/Out-painting https://huggingface.co/black-forest-labs/FLUX.1-Fill-dev FLUX.1-dev Non-Commercial License
FLUX.1 Canny [dev] Structural Conditioning https://huggingface.co/black-forest-labs/FLUX.1-Canny-dev FLUX.1-dev Non-Commercial License
FLUX.1 Depth [dev] Structural Conditioning https://huggingface.co/black-forest-labs/FLUX.1-Depth-dev FLUX.1-dev Non-Commercial License
FLUX.1 Canny [dev] LoRA Structural Conditioning https://huggingface.co/black-forest-labs/FLUX.1-Canny-dev-lora FLUX.1-dev Non-Commercial License
FLUX.1 Depth [dev] LoRA Structural Conditioning https://huggingface.co/black-forest-labs/FLUX.1-Depth-dev-lora FLUX.1-dev Non-Commercial License
FLUX.1 Redux [dev] Image variation https://huggingface.co/black-forest-labs/FLUX.1-Redux-dev FLUX.1-dev Non-Commercial License
FLUX.1 Kontext [dev] Image editing https://huggingface.co/black-forest-labs/FLUX.1-Kontext-dev FLUX.1-dev Non-Commercial License
FLUX.1 Krea [dev] Text to Image https://huggingface.co/black-forest-labs/FLUX.1-Krea-dev FLUX.1-dev Non-Commercial License

The weights of the autoencoder are also released under apache-2.0 and can be found in the HuggingFace repos above.

API usage

Our API offers access to all models including our Pro tier non-open weight models. Check out our API documentation docs.bfl.ai to learn more.

Licensing models for commercial use

You can license our models for commercial use here: https://bfl.ai/pricing/licensing

As the fee is based on a monthly usage, we provide code to automatically track your usage via the BFL API. To enable usage tracking please select track_usage in the cli or click the corresponding checkmark in our provided demos.

Example: Using FLUX.1 Kontext with usage tracking

We provide a reference implementation for running FLUX.1 with usage tracking enabled for commercial licensing. This can be customized as needed as long as the usage reporting is accurate.

For the reporting logic to work you will need to set your API key as an environment variable before running:

export BFL_API_KEY="your_api_key_here"

You can call FLUX.1 Kontext [dev] like this with tracking activated:

python -m flux kontext --track_usage --loop

For a single generation:

python -m flux kontext --track_usage --prompt "replace the logo with the text 'Black Forest Labs'"

The above reporting logic works similarly for FLUX.1 [dev] and FLUX.1 Tools [dev].

Note that this is only required when using one or more of our open weights models commercially. More information on the commercial licensing can be found at the BFL Helpdesk.

Citation

If you find the provided code or models useful for your research, consider citing them as:

@misc{labs2025flux1kontextflowmatching,
      title={FLUX.1 Kontext: Flow Matching for In-Context Image Generation and Editing in Latent Space},
      author={Black Forest Labs and Stephen Batifol and Andreas Blattmann and Frederic Boesel and Saksham Consul and Cyril Diagne and Tim Dockhorn and Jack English and Zion English and Patrick Esser and Sumith Kulal and Kyle Lacey and Yam Levi and Cheng Li and Dominik Lorenz and Jonas Müller and Dustin Podell and Robin Rombach and Harry Saini and Axel Sauer and Luke Smith},
      year={2025},
      eprint={2506.15742},
      archivePrefix={arXiv},
      primaryClass={cs.GR},
      url={https://arxiv.org/abs/2506.15742},
}

@misc{flux2024,
    author={Black Forest Labs},
    title={FLUX},
    year={2024},
    howpublished={\url{https://github.com/black-forest-labs/flux}},
}

flux (black-forest-labs/flux)

Searching Database…

26K ·GitHub
Flux
Что это такое?Это официальный репозиторий для инференса от Black Forest Labs для семейства моделей FLUX.1, которые генерируют и редактируют изображения с помощью диффузии. Код минимальный и нужен для запуска моделей с открытыми весами.
Это готовое приложение или просто код, который я запускаю сам?Это код для инференса: библиотека на Python с интерфейсом командной строки (CLI), которую вы устанавливаете и запускаете сами, чтобы вызывать модели Flux локально. Black Forest Labs также предлагает облачный API как альтернативу локальному запуску.
Что нужно помимо самого кода?Нужны веса моделей из ссылок на репозитории HuggingFace и PyTorch. Для TensorRT дополнительно нужны контейнер NVIDIA PyTorch и enroot. Для учёта коммерческого использования задайте API-ключ BFL как переменную окружения.
Все перечисленные модели FLUX.1 можно скачать, или некоторые доступны только через API?Все перечисленные модели (schnell, dev, Fill, Canny, Depth, их версии LoRA, Redux, Kontext, Krea) имеют открытые веса на HuggingFace. Но через API дополнительно доступны модели уровня Pro, которые не выпущены с открытыми весами.
Для кого предназначен этот репозиторий?Он рассчитан на разработчиков и исследователей, которые хотят запускать инференс Flux напрямую или использовать его в исследованиях; есть рекомендации по цитированию. Использование в продакшене или коммерческих целях требует отдельной лицензии.
Могу ли я использовать все модели FLUX.1 бесплатно, в том числе в коммерческих целях?Лицензия Apache-2.0 распространяется только на FLUX.1 schnell и веса автоэнкодера. FLUX.1 dev и большинство других вариантов (Fill, Canny, Depth, версии LoRA, Redux, Kontext, Krea) работают по лицензии FLUX.1-dev Non-Commercial License и для коммерческого использования требуют платной коммерческой лицензии с учётом использования.
В чём разница между FLUX.1 schnell и dev?FLUX.1 schnell распространяется под лицензией Apache-2.0 и предназначен для быстрой генерации изображений по тексту, а FLUX.1 dev и его варианты работают по более строгой лицензии FLUX.1-dev Non-Commercial License и предлагают такие возможности, как редактирование и управление структурой изображения.
Что такое FLUX.1 Kontext?Это одна из моделей с открытыми весами в семействе, которая специализируется на редактировании изображений, а не на генерации с нуля.
Могу ли я использовать модели с открытыми весами в коммерческих целях?Да, но нужно купить коммерческую лицензию у BFL и включить учёт использования (флаг trackusage), чтобы данные об использовании могли передаваться через API BFL.
Есть ли облачный API, чтобы не запускать всё это самому?Да, BFL предлагает API, документация которого доступна на docs.bfl.ai. Через него также открывается доступ к моделям уровня Pro, которые не выпущены с открытыми весами.
What are similar projects?stable-diffusion-webui, generative-models, kohya_ss, stable-diffusion, SenseNova-U1, IOPaint, DiffSynth-Studio, stable-diffusion-webui-forge
Which topics is it in?inpainting, open-weights, diffusion, image-editing, text-to-image, lora, ai-tools, image-generation, image-processing, nvidia, generative-ai, huggingface
Creator
black-forest-labs
Size
36.6 MB
Stars
26K
Updated
CommitJul 31
Age
2y
Commits · 90 Days