Show four MP4 demos and expand section-level documentation links
Browse files- README.md +33 -27
- docs/media/said_demo_1.webp +0 -3
- docs/media/said_demo_3.webp +0 -3
README.md
CHANGED
|
@@ -34,42 +34,42 @@ into a variable set of source maps. The release includes the complete inference,
|
|
| 34 |
evaluation, training, and Online Scene Generation workflows described in the
|
| 35 |
paper.
|
| 36 |
|
| 37 |
-
|
| 38 |
|
| 39 |
-
|
| 40 |
-
Truth is shown on the left and Prediction on the right with a shared timeline,
|
| 41 |
-
class legend, colors, and display scale. Each MP4 includes synchronized audio;
|
| 42 |
-
the inline animation previews the visual output.
|
| 43 |
|
| 44 |
-
|
|
|
|
|
|
|
|
|
|
| 45 |
|
| 46 |
-
|
| 47 |
|
| 48 |
-
|
| 49 |
|
| 50 |
-
###
|
| 51 |
|
| 52 |
-
|
| 53 |
|
| 54 |
-
|
| 55 |
|
| 56 |
-
<
|
| 57 |
-
<summary>Audio2Sph + Panoramic Decoder demonstrations</summary>
|
| 58 |
|
| 59 |
-
|
| 60 |
-
Audio2Sph pretraining.
|
| 61 |
|
| 62 |
-
|
| 63 |
-
- [Sony scene](docs/media/audio2sph_demo_3.mp4)
|
| 64 |
|
| 65 |
-
|
| 66 |
|
| 67 |
## Quick start
|
| 68 |
|
| 69 |
-
SAID supports Python 3.10 through 3.12.
|
| 70 |
-
|
| 71 |
|
| 72 |
```bash
|
|
|
|
|
|
|
|
|
|
| 73 |
pip install -e .
|
| 74 |
```
|
| 75 |
|
|
@@ -90,8 +90,9 @@ The CLI downloads the selected checkpoint from
|
|
| 90 |
`checkpoints/` directory on first use. `recording.wav` may contain the complete
|
| 91 |
32-channel Eigenmike signal or the four selected capsules `[6, 10, 26, 22]` in
|
| 92 |
that order. The default output is readable DCASE JSON. Select the AudioMAE
|
| 93 |
-
variant with `--model said_audiomae`
|
| 94 |
-
|
|
|
|
| 95 |
|
| 96 |
## Results
|
| 97 |
|
|
@@ -120,8 +121,8 @@ The table evaluates all 78 full development-test recordings.
|
|
| 120 |
|
| 121 |
The `(4.2)` AP columns reproduce the evaluator revision used by the paper;
|
| 122 |
`(6.30)` applies the current official evaluator to the same predictions.
|
| 123 |
-
|
| 124 |
-
|
| 125 |
|
| 126 |
## Evaluation
|
| 127 |
|
|
@@ -140,6 +141,8 @@ The default metrics follow the current `(6.30)` official definition;
|
|
| 140 |
The evaluator is acquired from the
|
| 141 |
[official DCASE2026 Task 3 repository](https://github.com/iranroman/DCASE2026_Task3_SAISELD_baseline).
|
| 142 |
|
|
|
|
|
|
|
| 143 |
## Models and checkpoints
|
| 144 |
|
| 145 |
| Model | Role and output | Checkpoint |
|
|
@@ -153,6 +156,10 @@ and SHA256 before loading. They are released for non-commercial research use onl
|
|
| 153 |
under the [SAID Model Weights Non-Commercial Research License 1.0](LICENSES/SAID-Model-Weights-NonCommercial-1.0.txt)
|
| 154 |
and all applicable upstream terms.
|
| 155 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 156 |
## Training and data
|
| 157 |
|
| 158 |
The paper training workflow is:
|
|
@@ -179,9 +186,8 @@ the included adapters:
|
|
| 179 |
- VCTK v0.80 for Audio2Sph pretraining;
|
| 180 |
- an authorized SourceBank manifest for class-labeled Online Scene Generation.
|
| 181 |
|
| 182 |
-
[Training](docs/training.md)
|
| 183 |
-
[
|
| 184 |
-
manifest schema, and license-aware interfaces.
|
| 185 |
|
| 186 |
## Documentation
|
| 187 |
|
|
|
|
| 34 |
evaluation, training, and Online Scene Generation workflows described in the
|
| 35 |
paper.
|
| 36 |
|
| 37 |
+
Details: [Model architecture](docs/model_architecture.md).
|
| 38 |
|
| 39 |
+
## Demos
|
|
|
|
|
|
|
|
|
|
| 40 |
|
| 41 |
+
The following 20-second examples show SAID (PaSST) and Audio2Sph + Panoramic
|
| 42 |
+
Decoder outputs. Ground Truth is shown on the left and Prediction on the right
|
| 43 |
+
with a shared timeline, colors, and display scale. The SAID videos also include
|
| 44 |
+
the sound-event class legend. All four MP4 files include synchronized audio.
|
| 45 |
|
| 46 |
+
### SAID (PaSST) — TAU scene
|
| 47 |
|
| 48 |
+
<video src="https://huggingface.co/IN03X/SAID/resolve/main/docs/media/said_demo_1.mp4" controls playsinline preload="metadata" width="100%"></video>
|
| 49 |
|
| 50 |
+
### SAID (PaSST) — Sony scene
|
| 51 |
|
| 52 |
+
<video src="https://huggingface.co/IN03X/SAID/resolve/main/docs/media/said_demo_3.mp4" controls playsinline preload="metadata" width="100%"></video>
|
| 53 |
|
| 54 |
+
### Audio2Sph + Panoramic Decoder — TAU scene
|
| 55 |
|
| 56 |
+
<video src="https://huggingface.co/IN03X/SAID/resolve/main/docs/media/audio2sph_demo_1.mp4" controls playsinline preload="metadata" width="100%"></video>
|
|
|
|
| 57 |
|
| 58 |
+
### Audio2Sph + Panoramic Decoder — Sony scene
|
|
|
|
| 59 |
|
| 60 |
+
<video src="https://huggingface.co/IN03X/SAID/resolve/main/docs/media/audio2sph_demo_3.mp4" controls playsinline preload="metadata" width="100%"></video>
|
|
|
|
| 61 |
|
| 62 |
+
Details: [Demos and inference](docs/inference.md).
|
| 63 |
|
| 64 |
## Quick start
|
| 65 |
|
| 66 |
+
SAID supports Python 3.10 through 3.12. Create an environment, enter the project
|
| 67 |
+
directory, and install the package:
|
| 68 |
|
| 69 |
```bash
|
| 70 |
+
conda create -n said python=3.10 -y
|
| 71 |
+
conda activate said
|
| 72 |
+
cd /path/to/SAID
|
| 73 |
pip install -e .
|
| 74 |
```
|
| 75 |
|
|
|
|
| 90 |
`checkpoints/` directory on first use. `recording.wav` may contain the complete
|
| 91 |
32-channel Eigenmike signal or the four selected capsules `[6, 10, 26, 22]` in
|
| 92 |
that order. The default output is readable DCASE JSON. Select the AudioMAE
|
| 93 |
+
variant with `--model said_audiomae`.
|
| 94 |
+
|
| 95 |
+
Details: [Inference and Python API](docs/inference.md).
|
| 96 |
|
| 97 |
## Results
|
| 98 |
|
|
|
|
| 121 |
|
| 122 |
The `(4.2)` AP columns reproduce the evaluator revision used by the paper;
|
| 123 |
`(6.30)` applies the current official evaluator to the same predictions.
|
| 124 |
+
|
| 125 |
+
Details: [Metric versions and definitions](docs/evaluation.md#metric-versions).
|
| 126 |
|
| 127 |
## Evaluation
|
| 128 |
|
|
|
|
| 141 |
The evaluator is acquired from the
|
| 142 |
[official DCASE2026 Task 3 repository](https://github.com/iranroman/DCASE2026_Task3_SAISELD_baseline).
|
| 143 |
|
| 144 |
+
Details: [DCASE evaluation and reproduction](docs/evaluation.md).
|
| 145 |
+
|
| 146 |
## Models and checkpoints
|
| 147 |
|
| 148 |
| Model | Role and output | Checkpoint |
|
|
|
|
| 156 |
under the [SAID Model Weights Non-Commercial Research License 1.0](LICENSES/SAID-Model-Weights-NonCommercial-1.0.txt)
|
| 157 |
and all applicable upstream terms.
|
| 158 |
|
| 159 |
+
Details: [SAID (PaSST)](docs/checkpoints/said_passt.md),
|
| 160 |
+
[SAID (AudioMAE)](docs/checkpoints/said_audiomae.md), and
|
| 161 |
+
[Audio2Sph + Panoramic Decoder](docs/checkpoints/audio2sph.md).
|
| 162 |
+
|
| 163 |
## Training and data
|
| 164 |
|
| 165 |
The paper training workflow is:
|
|
|
|
| 186 |
- VCTK v0.80 for Audio2Sph pretraining;
|
| 187 |
- an authorized SourceBank manifest for class-labeled Online Scene Generation.
|
| 188 |
|
| 189 |
+
Details: [Training](docs/training.md), [data preparation](docs/data.md), and
|
| 190 |
+
[configuration](docs/configuration.md).
|
|
|
|
| 191 |
|
| 192 |
## Documentation
|
| 193 |
|
docs/media/said_demo_1.webp
DELETED
Git LFS Details
|
docs/media/said_demo_3.webp
DELETED
Git LFS Details
|