Skip to content

Commit 31432d7

Browse files
committed
docs: document Stable Audio 3 setup
1 parent 7c45716 commit 31432d7

3 files changed

Lines changed: 80 additions & 8 deletions

File tree

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ Current release: `0.2.0`.
1313
GERM is an independent Sonic Field Labs project. It can use Stable Audio 3
1414
providers, but it is not an official Stability AI product.
1515

16+
The Listening Stack remains model-agnostic at its contracts. GERM's first
17+
fully developed local generation path is more specific: it is designed around
18+
Stable Audio 3 and uses its text-to-audio, audio-to-audio, inpainting,
19+
continuation, variable-length, and LoRA primitives as material for cultivation.
20+
The upstream code is MIT; the currently released local weights are gated and
21+
carry separate Stability AI and component terms.
22+
1623
![GERM dashboard with a prompt module in the cultivation graph](docs/assets/germ-dashboard.png)
1724

1825
## Try It Without a Model
@@ -47,8 +54,9 @@ checks but not a creative quality demonstration.
4754
| Path | Operating system | Hardware and software |
4855
| --- | --- | --- |
4956
| Mock service | macOS or Linux | Python 3.10+, `uv`; CPU only; no weights |
50-
| Stable Audio 3 MLX | Apple Silicon macOS | Official `sa3` MLX tools and separately accepted model weights |
51-
| Stable Audio 3 Python | Upstream-compatible macOS or Linux | Optional Python provider and hardware appropriate to the chosen checkpoint; a supported GPU is strongly recommended |
57+
| Stable Audio 3 Small, MLX | Apple Silicon macOS | Official `sa3` optimized tools and separately accepted Small SFX or Small Music weights |
58+
| Stable Audio 3 Small, Python | macOS or Linux | Upstream CPU path or compatible acceleration; 8 GB minimum and 16 GB system RAM suggested |
59+
| Stable Audio 3 Medium, Python | Linux/NVIDIA | Compatible CUDA GPU; upstream reports about 6.52 GB peak VRAM, while GERM suggests 24 GB system RAM |
5260
| Stability API | Any service-supported system | Network access, an operator-owned account, API key, and acceptance of service terms |
5361
| Native shell | macOS 13+ | Swift 5.9/Xcode command-line tools; the Python service still performs all audio work |
5462

@@ -62,6 +70,7 @@ promising one universal hardware minimum.
6270
| --- | --- |
6371
| How does it work? | [Micro/Matter architecture](docs/germ_micro_architecture.md) and [provider design](docs/provider_design.md) |
6472
| How does it connect? | [The Listening Stack](https://sonicfield.org/stack) and [Oída integration](docs/oida-integration.md) |
73+
| How do I install a tested model? | [Local model setup](docs/local_setup.md) |
6574
| Which models and licenses apply? | [Models and licensing](docs/models-and-licensing.md) |
6675
| What is unfinished? | [Known limitations](#known-limitations) and [roadmap](ROADMAP.md) |
6776
| How can I help? | [Contribution guide](CONTRIBUTING.md) |
@@ -132,6 +141,18 @@ provenance, retention, and lineage between the organs.
132141

133142
## Install
134143

144+
For a guided GERM or complete Listening Stack installation, including model
145+
choice, storage and memory guidance, gated-access checks, downloads, and local
146+
gateway configuration:
147+
148+
```bash
149+
curl -fsSL https://raw.githubusercontent.com/sonicfieldlabs/listening-stack/main/install.sh | bash
150+
```
151+
152+
Choose **GERM only** or **Oída + GERM** in the terminal assistant. GERM remains
153+
in this repository; the installer only coordinates its source, dependencies,
154+
provider, models, and local configuration.
155+
135156
Requirements: Python 3.10+ and `uv`.
136157

137158
```bash

docs/local_setup.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,21 @@ in or have not accepted the Stability AI model terms.
7575
uv run hf auth login
7676
```
7777

78-
3. Start the server and verify access:
78+
3. Download the exact checkpoint. Stable Audio's loader also downloads on first
79+
use, but an explicit download makes storage and access failures visible before
80+
a generation job:
81+
82+
```bash
83+
uv run hf download stabilityai/stable-audio-3-small-sfx
84+
uv run hf download stabilityai/stable-audio-3-small-music
85+
uv run hf download stabilityai/stable-audio-3-medium
86+
```
87+
88+
Download only the models you intend to use. The Hugging Face API currently
89+
reports approximately 3.49 GB for each Small post-trained repository and
90+
10.45 GB for Medium.
91+
92+
4. Start the server and verify access:
7993

8094
```bash
8195
./launch_germ.command
@@ -84,6 +98,23 @@ in or have not accepted the Stability AI model terms.
8498

8599
You can run the same check from the dashboard Status section with `HF Check`.
86100

101+
The exact model page controls. At the time of this public-alpha release, the
102+
three pages are gated and identify the Stability AI Community License plus
103+
additional component terms. GERM cannot accept those terms for an operator.
104+
105+
### Guided Listening Stack Install
106+
107+
The separate installer can prepare GERM or both main applications, show the
108+
combined disk and RAM plan, authenticate Hugging Face, download only selected
109+
models, and leave the gateways ready to start:
110+
111+
```bash
112+
curl -fsSL https://raw.githubusercontent.com/sonicfieldlabs/listening-stack/main/install.sh | bash
113+
```
114+
115+
It keeps model caches, state, logs, outputs, and local paths outside this Git
116+
repository.
117+
87118
## Apple Silicon MLX Provider
88119

89120
```bash

docs/models-and-licensing.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,26 @@ The optional Python provider references the official
1717
Its repository [code license](https://github.com/Stability-AI/stable-audio-3/blob/main/LICENSE)
1818
is MIT at the time of this release.
1919

20-
Stable Audio 3 model weights are separately licensed. For example, the
21-
[Stable Audio 3 Small SFX model card](https://huggingface.co/stabilityai/stable-audio-3-small-sfx)
22-
identifies the Stability AI Community License and may identify additional
23-
component terms. Some checkpoints are gated. The upstream model card and terms
24-
for the exact checkpoint always control.
20+
GERM's first developed local generation path uses three post-trained
21+
checkpoints:
22+
23+
- [Stable Audio 3 Small SFX](https://huggingface.co/stabilityai/stable-audio-3-small-sfx)
24+
- [Stable Audio 3 Small Music](https://huggingface.co/stabilityai/stable-audio-3-small-music)
25+
- [Stable Audio 3 Medium](https://huggingface.co/stabilityai/stable-audio-3-medium)
26+
27+
Stable Audio 3 model weights are separately licensed. These model cards are
28+
gated and currently identify the Stability AI Community License plus
29+
additional component terms. The exact page and terms for the downloaded
30+
checkpoint always control. Locally runnable or downloadable weights should not
31+
be described as unrestricted open-source software solely because the code
32+
repository is MIT.
33+
34+
The upstream release supplies text-to-audio, audio-to-audio editing,
35+
inpainting and continuation, variable-length generation, and LoRA
36+
personalization. GERM places those primitives inside its graph, Micro/Matter
37+
modules, job system, source handling, comparison, metadata, and sonic-lineage
38+
workflows. The wider Listening Stack remains model-agnostic even though this
39+
first GERM provider is intentionally designed around Stable Audio 3.
2540

2641
GERM does not redistribute weights or accept upstream terms for the operator.
2742
Before installing a model:
@@ -34,6 +49,11 @@ Before installing a model:
3449
The MLX installer prepares the official provider path on Apple Silicon; it
3550
does not change the model's license.
3651

52+
See [Local setup](local_setup.md) for explicit `hf download` commands and the
53+
[Listening Stack installer](https://github.com/sonicfieldlabs/listening-stack)
54+
for the guided route. Neither path redistributes weights or records a Hugging
55+
Face token in Git.
56+
3757
## Stability API and Other Providers
3858

3959
The Stability API route is opt-in and uses an operator-supplied key. Service

0 commit comments

Comments
 (0)