Skip to content

Commit

Permalink
chore: diffuse-rs -> diffusion-rs (#26)
Browse files Browse the repository at this point in the history
* Rename diffuse-rs to diffusion-rs

* Format

* Don't run the code analysis

* Reset version
  • Loading branch information
EricLBuehler authored Jan 7, 2025
1 parent cd03573 commit 34a8c8f
Show file tree
Hide file tree
Showing 225 changed files with 749 additions and 795 deletions.
64 changes: 0 additions & 64 deletions .github/workflows/analysis.yaml

This file was deleted.

6 changes: 3 additions & 3 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ jobs:
- name: Build docs
run: |
rm -rf ./docs
echo "<meta http-equiv=\"refresh\" content=\"0; url=diffuse_rs_core\">" > target/doc/index.html
echo "<meta http-equiv=\"refresh\" content=\"0; url=diffusion_rs_core\">" > target/doc/index.html
cp -r target/doc ./docs
- name: Build Python docs
run: |
python3 -m venv myenv
source myenv/bin/activate
pip install maturin[patchelf] pdoc
cd diffuse_rs_py
cd diffusion_rs_py
maturin develop
cd ..
pdoc diffuse_rs -o ./docs/pyo3
pdoc diffusion_rs -o ./docs/pyo3
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
with:
Expand Down
8 changes: 4 additions & 4 deletions .typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ extend-ignore-identifiers-re = [

[files]
extend-exclude = [
"diffuse_rs_common/src/core/*",
"diffuse_rs_common/src/nn/*",
"diffuse_rs_common/src/cuda_kernels/*",
"diffuse_rs_common/src/metal_kernels/*"
"diffusion_rs_common/src/core/*",
"diffusion_rs_common/src/nn/*",
"diffusion_rs_common/src/cuda_kernels/*",
"diffusion_rs_common/src/metal_kernels/*"
]
36 changes: 18 additions & 18 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 9 additions & 9 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
[workspace]
members = [
"diffuse_rs_core",
"diffuse_rs_examples",
"diffuse_rs_backend",
"diffuse_rs_common",
"diffuse_rs_cli",
"diffuse_rs_py",
"diffusion_rs_core",
"diffusion_rs_examples",
"diffusion_rs_backend",
"diffusion_rs_common",
"diffusion_rs_cli",
"diffusion_rs_py",
]
resolver = "2"

[workspace.package]
version = "0.1.3"
version = "0.1.0"
edition = "2021"
authors = ["Eric Buehler"]
description = "Blazingly fast inference of diffusion models."
homepage = "https://github.com/EricLBuehler/diffuse-rs"
repository = "https://github.com/EricLBuehler/diffuse-rs"
homepage = "https://github.com/EricLBuehler/diffusion-rs"
repository = "https://github.com/EricLBuehler/diffusion-rs"
keywords = ["machine-learning"]
categories = ["science"]
license = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion FEATURE_FLAGS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Feature flags

Diffuse-rs controls building with GPU support or CPU SIMD acceleration with feature flags.
diffusion-rs controls building with GPU support or CPU SIMD acceleration with feature flags.

These are set at compile time and are as follows:

Expand Down
52 changes: 26 additions & 26 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installation guide for diffuse-rs
# Installation guide for diffusion-rs

**ToC**
- [CLI](#cli)
Expand All @@ -8,7 +8,7 @@
- [Rust crate](#rust-crate)

## CLI
1) Installing diffuse-rs via the CLI requires a few prerequisites:
1) Installing diffusion-rs via the CLI requires a few prerequisites:
- Install the Rust programming language
- Follow the instructions on this site: https://rustup.rs/
- (*Linux/Mac only*) Install OpenSSL (*Ubuntu:* `sudo apt install libssl-dev`, *Brew:* `brew install openssl`)
Expand All @@ -18,25 +18,25 @@
- Install the necessary tool: `pip install huggingface_hub`
- Login: `huggingface_cli login`

3) Install the `diffuse_rs_cli` CLI
3) Install the `diffusion_rs_cli` CLI

> [!NOTE]
> Replace the `...` below with [feature flags](FEATURE_FLAGS.md) to build for Nvidia GPUs (CUDA) or Apple Silicon GPUs (Metal)
```
cargo install diffuse_rs_cli --features ...
cargo install diffusion_rs_cli --features ...
```

4) Try the CLI!

> Download the DDUF file here: `wget https://huggingface.co/DDUF/FLUX.1-dev-DDUF/resolve/main/FLUX.1-dev-Q4-bnb.dduf`
```
diffuse_rs_cli --scale 3.5 --num-steps 50 dduf -f FLUX.1-dev-Q4-bnb.dduf
diffusion_rs_cli --scale 3.5 --num-steps 50 dduf -f FLUX.1-dev-Q4-bnb.dduf
```

## CLI from source
1) Installing diffuse-rs via the CLI requires a few prerequisites:
1) Installing diffusion-rs via the CLI requires a few prerequisites:
- Install the Rust programming language
- Follow the instructions on this site: https://rustup.rs/
- (*Linux/Mac only*) Install OpenSSL (*Ubuntu:* `sudo apt install libssl-dev`, *Brew:* `brew install openssl`)
Expand All @@ -48,29 +48,29 @@ diffuse_rs_cli --scale 3.5 --num-steps 50 dduf -f FLUX.1-dev-Q4-bnb.dduf

3) Clone the repository
```
git clone https://github.com/EricLBuehler/diffuse-rs.git
cd diffuse-rs
git clone https://github.com/EricLBuehler/diffusion-rs.git
cd diffusion-rs
```

4) Install the `diffuse_rs_cli` CLI
4) Install the `diffusion_rs_cli` CLI

> [!NOTE]
> Replace the `...` below with [feature flags](FEATURE_FLAGS.md) to build for Nvidia GPUs (CUDA) or Apple Silicon GPUs (Metal)
```
cargo install --path diffuse_rs_cli --release --features ...
cargo install --path diffusion_rs_cli --release --features ...
```

5) Try the CLI!

> Download the DDUF file here: `wget https://huggingface.co/DDUF/FLUX.1-dev-DDUF/resolve/main/FLUX.1-dev-Q4-bnb.dduf`
```
diffuse_rs_cli --scale 3.5 --num-steps 50 dduf -f FLUX.1-dev-Q4-bnb.dduf
diffusion_rs_cli --scale 3.5 --num-steps 50 dduf -f FLUX.1-dev-Q4-bnb.dduf
```

## Python bindings
1) Installing diffuse-rs via the Python bindings requires a few prerequisites:
1) Installing diffusion-rs via the Python bindings requires a few prerequisites:
- Install the Rust programming language
- Follow the instructions on this site: https://rustup.rs/
- (*Linux/Mac only*) Install OpenSSL (*Ubuntu:* `sudo apt install libssl-dev`, *Brew:* `brew install openssl`)
Expand All @@ -84,18 +84,18 @@ diffuse_rs_cli --scale 3.5 --num-steps 50 dduf -f FLUX.1-dev-Q4-bnb.dduf

|Feature|Flag|
|--|--|
|Nvidia GPUs (CUDA)|`pip install diffuse_rs_cuda`|
|Apple Silicon GPUs (Metal)|`pip install diffuse_rs_metal`|
|Apple Accelerate (CPU)|`pip install diffuse_rs_accelerate`|
|Intel MKL (CPU)|`pip install diffuse_rs_mkl`|
|Use AVX or NEON automatically|`pip install diffuse_rs`|
|Nvidia GPUs (CUDA)|`pip install diffusion_rs_cuda`|
|Apple Silicon GPUs (Metal)|`pip install diffusion_rs_metal`|
|Apple Accelerate (CPU)|`pip install diffusion_rs_accelerate`|
|Intel MKL (CPU)|`pip install diffusion_rs_mkl`|
|Use AVX or NEON automatically|`pip install diffusion_rs`|

4) Try the Python bindings!

> Download the DDUF file here: `wget https://huggingface.co/DDUF/FLUX.1-dev-DDUF/resolve/main/FLUX.1-dev-Q4-bnb.dduf`
```py
from diffuse_rs import DiffusionGenerationParams, ModelSource, Pipeline
from diffusion_rs import DiffusionGenerationParams, ModelSource, Pipeline
from PIL import Image
import io

Expand All @@ -113,7 +113,7 @@ image.show()
```

## Python bindings from source
1) Installing diffuse-rs via the Python bindings requires a few prerequisites:
1) Installing diffusion-rs via the Python bindings requires a few prerequisites:
- Install the Rust programming language
- Follow the instructions on this site: https://rustup.rs/
- (*Linux/Mac only*) Install OpenSSL (*Ubuntu:* `sudo apt install libssl-dev`, *Brew:* `brew install openssl`)
Expand All @@ -125,8 +125,8 @@ image.show()

3) Clone the repository
```
git clone https://github.com/EricLBuehler/diffuse-rs.git
cd diffuse-rs
git clone https://github.com/EricLBuehler/diffusion-rs.git
cd diffusion-rs
```

4) Install the maturin build tool
Expand All @@ -140,15 +140,15 @@ pip install maturin
> Replace the `...` below with [feature flags](FEATURE_FLAGS.md) to build for Nvidia GPUs (CUDA) or Apple Silicon GPUs (Metal)
```
maturin develop -m diffuse_rs_py/Cargo.toml --release --features ...
maturin develop -m diffusion_rs_py/Cargo.toml --release --features ...
```

6) Try the Python bindings!

> Download the DDUF file here: `wget https://huggingface.co/DDUF/FLUX.1-dev-DDUF/resolve/main/FLUX.1-dev-Q4-bnb.dduf`
```py
from diffuse_rs import DiffusionGenerationParams, ModelSource, Pipeline
from diffusion_rs import DiffusionGenerationParams, ModelSource, Pipeline
from PIL import Image
import io

Expand All @@ -166,7 +166,7 @@ image.show()
```

## Rust crate
1) Installing diffuse-rs for usage as a Rust crate requires a few prerequisites:
1) Installing diffusion-rs for usage as a Rust crate requires a few prerequisites:
- Install the Rust programming language
- Follow the instructions on this site: https://rustup.rs/
- (*Linux/Mac only*) Install OpenSSL (*Ubuntu:* `sudo apt install libssl-dev`, *Brew:* `brew install openssl`)
Expand All @@ -177,5 +177,5 @@ image.show()
- Login: `huggingface_cli login`

3) Add the dependency to your `Cargo.toml`
- Run: `cargo add diffuse_rs_core`
- Alternatively, you can add the git dependency to your Cargo.toml for the latest updates: `diffuse_rs_core = { git = "https://github.com/EricLBuehler/diffuse-rs.git", version = "0.1.0" }`
- Run: `cargo add diffusion_rs_core`
- Alternatively, you can add the git dependency to your Cargo.toml for the latest updates: `diffusion_rs_core = { git = "https://github.com/EricLBuehler/diffusion-rs.git", version = "0.1.0" }`
Loading

0 comments on commit 34a8c8f

Please sign in to comment.