Mirrors
/
riffusion-inference
mirror of https://github.com/riffusion/riffusion.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add detail to readme 

Topic: readme_3
This commit is contained in:
Hayk Martiros 2022-12-27 15:22:34 +00:00
parent 7b55a966ba
commit 266af6b3e0
2 changed files with 22 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -36,22 +36,27 @@ If you build on this work, please cite it as follows:
Tested with Python 3.9 + 3.10 and diffusers 0.9.0.
To run this model in real time, you need a GPU that can run stable diffusion with approximately 50
steps in under five seconds. A 3090 or A10G will do it.
Install in a virtual Python environment:
It's highly recommended to set up a virtual Python environment with `conda` or `virtualenv`:
```
conda create --name riffusion python=3.9
conda activate riffusion
```
Install Python dependencies:
```
python -m pip install -r requirements.txt
```
In order to use audio formats other than WAV, `ffmpeg` is required.
```
sudo apt-get install ffmpeg # linux
brew install ffmpeg # mac
conda install -c conda-forge ffmpeg # conda
```
If torchaudio has no audio backend, see
[this issue](https://github.com/riffusion/riffusion/issues/12).
You can open and save WAV files with pure python. For opening and saving non-wav files – like mp3 –
you'll need to install ffmpeg with `suod apt-get install ffmpeg` or `brew install ffmpeg`.
Guides:
* [Windows Simple Instructions](https://www.reddit.com/r/riffusion/comments/zrubc9/installation_guide_for_riffusion_app_inference/)
@ -69,6 +74,9 @@ import torch
torch.cuda.is_available()
```
To generate audio in real-time, you need a GPU that can run stable diffusion with approximately 50
steps in under five seconds, such as a 3090 or A10G.
Also see [this issue](https://github.com/riffusion/riffusion/issues/3) for help.
#### CPU
@ -87,7 +95,7 @@ Riffusion comes with a command line interface for performing common tasks.
See available commands:
```
python -m riffusion-cli -h
python -m riffusion.cli -h
```
Get help for a specific command:
@ -107,8 +115,7 @@ This app is called the Riffusion Playground.
Run with:
```
python -m streamlit run riffusion/streamlit/playground.py --browser.serverAddress 127.0.0.1 --bro
wser.serverPort 8501
python -m streamlit run riffusion/streamlit/playground.py --browser.serverAddress 127.0.0.1 --browser.serverPort 8501
```
And access at http://127.0.0.1:8501/
@ -185,7 +192,7 @@ To run tests using a specific torch device, set `RIFFUSION_TEST_DEVICE`. Tests s
`cpu`, `cuda`, and `mps` backends.
## Development
Install additional packages for dev with `pip install -r dev_requirements.txt`.
Install additional packages for dev with `python -m pip install -r dev_requirements.txt`.
* Linter: `ruff`
* Formatter: `black`

4
pyproject.toml
View File

@ -62,6 +62,10 @@ ignore_missing_imports = true
module = "diffusers.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "numpy.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "plotly.*"
ignore_missing_imports = true