summaryrefslogtreecommitdiff
path: root/candle-transformers/src/models/flux/mod.rs
diff options
context:
space:
mode:
authorzachcp <zachcp@users.noreply.github.com>2024-11-16 03:09:17 -0500
committerGitHub <noreply@github.com>2024-11-16 09:09:17 +0100
commita3f200e36991418c25cddef0e09c426deea90606 (patch)
tree238710f1f0a91ea244f659c08798fe0978380a93 /candle-transformers/src/models/flux/mod.rs
parent00d8a0c178f588b6454c02e66b709917628c2bae (diff)
downloadcandle-a3f200e36991418c25cddef0e09c426deea90606.tar.gz
candle-a3f200e36991418c25cddef0e09c426deea90606.tar.bz2
candle-a3f200e36991418c25cddef0e09c426deea90606.zip
Module Docs (#2620)
* update bert docs * update based * update bigcode * add pixtral * add flux as well
Diffstat (limited to 'candle-transformers/src/models/flux/mod.rs')
-rw-r--r--candle-transformers/src/models/flux/mod.rs22
1 files changed, 19 insertions, 3 deletions
diff --git a/candle-transformers/src/models/flux/mod.rs b/candle-transformers/src/models/flux/mod.rs
index 8eb928f5..064c5130 100644
--- a/candle-transformers/src/models/flux/mod.rs
+++ b/candle-transformers/src/models/flux/mod.rs
@@ -1,10 +1,26 @@
//! Flux Model
//!
-//! Flux is a series of text-to-image generation models based on diffusion transformers.
+//! Flux is a 12B rectified flow transformer capable of generating images from text descriptions.
//!
-//! - [GH Link](https://github.com/black-forest-labs/flux)
-//! - Transformers Python [reference implementation](https://github.com/huggingface/transformers/blob/5af7d41e49bbfc8319f462eb45253dcb3863dfb7/src/transformers/models/chinese_clip/modeling_chinese_clip.py)
+//! - [Hugging Face Model](https://huggingface.co/black-forest-labs/FLUX.1-schnell)
+//! - [GitHub Repository](https://github.com/black-forest-labs/flux)
+//! - [Blog Post](https://blackforestlabs.ai/announcing-black-forest-labs/)
//!
+//! # Usage
+//!
+//! ```bash
+//! cargo run --features cuda \
+//! --example flux -r -- \
+//! --height 1024 --width 1024 \
+//! --prompt "a rusty robot walking on a beach holding a small torch, \
+//! the robot has the word \"rust\" written on it, high quality, 4k"
+//! ```
+//!
+//! <div align=center>
+//! <img src="https://github.com/huggingface/candle/raw/main/candle-examples/examples/flux/assets/flux-robot.jpg" alt="" width=320>
+//! </div>
+//!
+
use candle::{Result, Tensor};
pub trait WithForward {