musegauge 0.1.0__tar.gz

musegauge-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,82 @@
+# Every push and pull request (spec section 11.7, as changed at GATE 3, amendment A17):
+# the fast test set (it includes the fake plugins), the wheel checks, and the slim image build.
+# Real plugins are not run on hosted runners. Not run yet: the repository has no GitHub remote (D3).
+name: ci
+on: [push, pull_request]
+
+jobs:
+  core:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.10", "3.11", "3.12"]
+    env:
+      UV_PYTHON_DOWNLOADS: never   # fast fakes use the runner's own Python
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install uv
+        run: python -m pip install uv
+      - name: Install musegauge with dev tools
+        run: |
+          uv venv --python ${{ matrix.python }} .venv
+          uv pip install --python .venv/bin/python -e ".[dev]"
+      - name: ruff
+        run: .venv/bin/ruff check
+      - name: Fast tests
+        run: .venv/bin/pytest -m "not slow and not network and not gpu and not docker"
+      - name: Build the wheel
+        run: uv build
+      - name: Check the wheel contents
+        run: |
+          python - <<'PY'
+          import glob, zipfile, pathlib
+          (whl,) = glob.glob("dist/*.whl")
+          names = set(zipfile.ZipFile(whl).namelist())
+          root = pathlib.Path("src")
+          needed = [str(p.relative_to(root)) for p in root.glob("musegauge/plugins/*/manifest.yaml")]
+          needed += [str(p.relative_to(root)) for p in root.glob("musegauge/plugins/*/locks/*.txt")]
+          needed += [str(p.relative_to(root)) for p in root.glob("musegauge/suites/*.yaml")]
+          needed += ["musegauge/_runtime/musegauge_runtime/run.py", "musegauge/_runtime/musegauge_runtime/__init__.py"]
+          missing = [n for n in needed if n not in names]
+          print(f"{len(needed)} required files, {len(missing)} missing")
+          assert not missing, missing
+          PY
+      - name: Install the wheel in a clean environment and run it
+        run: |
+          python -m venv /tmp/clean
+          /tmp/clean/bin/pip install dist/*.whl
+          /tmp/clean/bin/musegauge --version
+          /tmp/clean/bin/musegauge list
+          /tmp/clean/bin/musegauge doctor
+
+  slim-image:
+    # Builds the image only; never pushes (D7). The fake plugins run with no network.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build the wheel
+        run: |
+          python -m pip install uv numpy soundfile
+          uv build --wheel
+      - name: Build the slim image
+        run: docker build -f docker/Dockerfile --target slim -t musegauge:slim .
+      - name: doctor
+        run: docker run --rm musegauge:slim doctor
+      - name: Fake plugins with no network
+        run: |
+          python tests/make_fixtures.py fixtures
+          mkdir -p out && chmod 777 out
+          docker run --rm --network none \
+            -v "$PWD/tests/fake_plugins:/plugins:ro" -e MUSEGAUGE_PLUGIN_PATH=/plugins \
+            -v "$PWD/fixtures:/data:ro" -v "$PWD/out:/out" \
+            musegauge:slim run --generated /data/gen_small --reference /data/ref_small \
+              --metrics fake.clip@1,fake.set@1 --out /out
+          test -f out/results.json
+

musegauge-0.1.0/.github/workflows/slow.yml

@@ -0,0 +1,29 @@
+# Nightly and on request (spec section 11.7, as changed at GATE 3, amendment A17): the isolation
+# test with the fake plugins (two real environments with different numpy and Python), and the
+# upstream fact check. No real metric plugins: their environments take about 24 GB and their
+# golden numbers are tied to the server they were recorded on. Real golden tests are run by hand
+# with scripts/run_golden.sh (docs/TESTING_REAL_PLUGINS.md).
+# Not run yet: the repository has no GitHub remote (D3).
+name: slow
+on:
+  schedule:
+    - cron: "0 3 * * *"
+  workflow_dispatch:
+
+jobs:
+  slow:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install uv and musegauge
+        run: |
+          python -m pip install uv
+          uv venv --python 3.12 .venv
+          uv pip install --python .venv/bin/python -e ".[dev]"
+      - name: Re-check upstream facts (fails when an upstream package changed)
+        run: .venv/bin/python scripts/verify_facts.py
+      - name: Isolation test (fake_np1 and fake_np2)
+        run: .venv/bin/pytest -m slow -v tests/integration/test_isolation.py

musegauge-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+musegauge-out/
+# Roy's build spec: kept private
+specs/

musegauge-0.1.0/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## 0.1.0 (2026-10-03, not published)
+
+First version. No PyPI or TestPyPI upload and no image pushed (D7 is open). The code is under the
+Apache License 2.0 (`LICENSE`, decision D2).
+
+Metrics, all at version `@1`:
+
+- `fad.vggish@1`, `fad.clap-laion-music@1`, `fad.encodec-emb@1`: plugin `fad_fadtk`, fadtk 1.1.0, torch 2.7.0
+- `kad.vggish@1`, `kad.clap-laion-music@1`: plugin `kad_kadtk`, kadtk 1.1.0, torch 2.5.1
+- `clapscore.laion-music@1`: plugin `clapscore_laion`, laion-clap 1.1.7, torch 2.7.0 (harness-defined metric)
+- `aesthetics.audiobox@1`: plugin `aesthetics_audiobox`, audiobox-aesthetics 0.0.4, torch 2.7.0
+
+Suites: `t2m-basic@1` (default), `t2m-full@1`.
+
+Commands: `run`, `list`, `info`, `doctor`, `setup`, `clean`, `report`, `validate`.
+
+Install: pip and uvx (tested), Docker `slim` image and Apptainer (written, not built or tested).
+
+Changes from the build spec are listed in `docs/DECISIONS.md` (C1 to C4, A1 to A22). The metric
+ids were not bumped during development, because nothing had been released; from this version on,
+every change that can move a metric's numbers bumps its `@N` with a line here.

musegauge-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

musegauge-0.1.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.5
+Name: musegauge
+Version: 0.1.0
+Summary: Run several existing music generation metrics in one command, each in its own environment.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: numpy
+Requires-Dist: pyyaml
+Requires-Dist: soundfile
+Requires-Dist: uv
+Provides-Extra: dev
+Requires-Dist: jsonschema; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# musegauge
+
+Needs a GPU, about 28 GB free disk, Linux x86_64.
+
+musegauge scores a folder of generated music with several existing metrics in one command:
+Frechet Audio Distance (fadtk), Kernel Audio Distance (kadtk), a CLAP text-audio score
+(laion-clap) and Audiobox Aesthetics. Each metric runs in its own Python environment, which the
+tool builds by itself with uv, so tools that need different torch versions can be used together.
+One run writes a `results.json` and a short report card for a paper appendix.
+
+Version 0.1.0. Source: https://github.com/aroy1990-dev/musegauge. Not on PyPI; no container image is published.
+Linux x86_64 is supported; macOS is best effort; Windows is not supported.
+
+## Quick start
+
+**pip** (Python 3.10 or newer):
+
+```bash
+python3 -m venv .venv && source .venv/bin/activate
+pip install musegauge
+musegauge doctor
+musegauge run --generated ./my_audio --prompts prompts.csv --out ./out
+```
+
+If `python3 -m venv` fails because `ensurepip` is missing (a Debian or Ubuntu system Python
+without the `python3-venv` package), use another Python, or `uv venv`.
+
+**uvx** (no install; needs uv):
+
+```bash
+uvx musegauge run --generated ./my_audio --out ./out
+uvx --from . musegauge --version                         # from a clone
+```
+
+**Docker** (`slim` image; not built or tested by the builder, see `docker/README.md`):
+
+```bash
+uv build && docker build -f docker/Dockerfile --target slim -t musegauge:slim .
+docker run --rm --gpus all -v "$PWD/my_audio:/data/audio:ro" -v musegauge-cache:/cache \
+  -v "$PWD/out:/out" musegauge:slim run --generated /data/audio --out /out
+```
+
+The first run builds the plugin environments and downloads the model weights into the cache
+folder (`~/.cache/musegauge`, or `/cache` in the container): about 24 GB of environments and
+3.7 GB of weights for all four plugins. `musegauge setup --all --fetch-weights` does this ahead of
+time. All install paths: `docs/INSTALL.md`.
+
+## Try it on synthetic audio
+
+From a fresh clone, in a new shell:
+
+```bash
+git clone https://github.com/aroy1990-dev/musegauge.git && cd musegauge
+python3 -m venv .venv && source .venv/bin/activate
+pip install .
+python tests/make_fixtures.py fixtures
+musegauge run --generated fixtures/gen_small --metrics aesthetics.audiobox@1 --out out
+cat out/report.md
+```
+
+`tests/make_fixtures.py` writes synthetic sine-and-noise clips (no real music). The first run
+builds the Audiobox environment (about 5 GB) and downloads its weights (about 400 MB). Scores on
+synthetic audio mean nothing about quality.
+
+## Input and output
+
+- Input: a folder of `.wav`, `.flac`, `.ogg` or `.mp3` files (`--generated DIR`, with optional
+  `--prompts FILE`), or a clips file in JSON lines (`--manifest FILE`).
+- Metrics: a suite (`--suite t2m-basic`, the default, or `t2m-full`) or `--metrics ID,ID`.
+  `musegauge list` shows them; `musegauge info METRIC_ID` shows a definition and its licences.
+- Reference: `--reference DIR` or `--reference bundled:fma_pop` (FAD only).
+- Output folder: `results.json`, `report.md`, `per_clip/`, `logs/`, `requests/`, `responses/`.
+
+One example output, from `docs/examples/report.md` (synthetic audio; the numbers mean nothing):
+
+```text
+| Metric | Score | Mean ± std | 95% CI | n | Status |
+| --- | --- | --- | --- | --- | --- |
+| fad.vggish@1 | fad | 25.369 | — | — | ok |
+| fad.clap-laion-music@1 | fad | 1.274 | — | — | ok |
+| clapscore.laion-music@1 | clap_cosine | 0.232 ± 0.059 | [0.200, 0.262] | 12 | ok |
+| aesthetics.audiobox@1 | CE | 2.405 ± 0.557 | [2.115, 2.705] | 12 | ok |
+| aesthetics.audiobox@1 | PQ | 6.228 ± 0.827 | [5.757, 6.655] | 12 | ok |
+```
+
+## Things to know
+
+- **Offline use.** `--no-fetch` blocks downloads from libraries that honour the proxy settings,
+  and sets the Hugging Face offline variables. It is best effort, not a guarantee; for a hard
+  guarantee cut the network outside the tool (for example a container with no network). It was
+  tested only with the proxy method, not with a truly blocked network. Run
+  `musegauge setup --fetch-weights` first; `run --no-fetch` never builds an environment.
+- **Network without `--no-fetch`.** FAD and KAD with VGGish contact github.com on every run
+  (torch.hub). An HTTP error there is reported as `NETWORK_ERROR`.
+- **Licences.** Every metric's `commercial_ok` is `unknown`, so every run warns
+  `UNKNOWN_LICENCE`. `--commercial` refuses such metrics. Details: `docs/LICENCES.md`.
+- **Comparability.** Numbers are comparable only with the same metric ids, reference set, clip
+  length, device and thread setting. `fad_inf` is random from run to run. See `docs/METRICS.md`.
+- **Shared machines.** `--threads N` limits CPU threads in each plugin (`docs/INSTALL.md`).
+
+## Documentation
+
+- `docs/INSTALL.md`: install paths, offline use, disk space, GPU driver, threads
+- `docs/METRICS.md`: what each metric is and where numbers can differ
+- `docs/LICENCES.md`: code, weights and data licence status per metric
+- `docs/plugins/`: one page per plugin (commands, files, downloads, differences from upstream)
+- `docs/PLUGIN_GUIDE.md`: how to write a plugin
+- `docs/UPSTREAM_NOTES.md`: problems found in the upstream tools
+- `docs/TESTING_REAL_PLUGINS.md`: golden tests with the real tools
+- `docs/DECISIONS.md`: choices made, and every change from the build spec
+- `docs/VERIFIED_FACTS.md`, `docs/PROGRESS.md`, `docs/BUILD_REPORT.md`: checks and build record
+
+## Licence of this code
+
+Apache License 2.0 (`LICENSE`; decision D2). The metric packages and model weights that the
+plugins download have their own licences: `docs/LICENCES.md`.

musegauge-0.1.0/README.md

@@ -0,0 +1,116 @@
+# musegauge
+
+Needs a GPU, about 28 GB free disk, Linux x86_64.
+
+musegauge scores a folder of generated music with several existing metrics in one command:
+Frechet Audio Distance (fadtk), Kernel Audio Distance (kadtk), a CLAP text-audio score
+(laion-clap) and Audiobox Aesthetics. Each metric runs in its own Python environment, which the
+tool builds by itself with uv, so tools that need different torch versions can be used together.
+One run writes a `results.json` and a short report card for a paper appendix.
+
+Version 0.1.0. Source: https://github.com/aroy1990-dev/musegauge. Not on PyPI; no container image is published.
+Linux x86_64 is supported; macOS is best effort; Windows is not supported.
+
+## Quick start
+
+**pip** (Python 3.10 or newer):
+
+```bash
+python3 -m venv .venv && source .venv/bin/activate
+pip install musegauge
+musegauge doctor
+musegauge run --generated ./my_audio --prompts prompts.csv --out ./out
+```
+
+If `python3 -m venv` fails because `ensurepip` is missing (a Debian or Ubuntu system Python
+without the `python3-venv` package), use another Python, or `uv venv`.
+
+**uvx** (no install; needs uv):
+
+```bash
+uvx musegauge run --generated ./my_audio --out ./out
+uvx --from . musegauge --version                         # from a clone
+```
+
+**Docker** (`slim` image; not built or tested by the builder, see `docker/README.md`):
+
+```bash
+uv build && docker build -f docker/Dockerfile --target slim -t musegauge:slim .
+docker run --rm --gpus all -v "$PWD/my_audio:/data/audio:ro" -v musegauge-cache:/cache \
+  -v "$PWD/out:/out" musegauge:slim run --generated /data/audio --out /out
+```
+
+The first run builds the plugin environments and downloads the model weights into the cache
+folder (`~/.cache/musegauge`, or `/cache` in the container): about 24 GB of environments and
+3.7 GB of weights for all four plugins. `musegauge setup --all --fetch-weights` does this ahead of
+time. All install paths: `docs/INSTALL.md`.
+
+## Try it on synthetic audio
+
+From a fresh clone, in a new shell:
+
+```bash
+git clone https://github.com/aroy1990-dev/musegauge.git && cd musegauge
+python3 -m venv .venv && source .venv/bin/activate
+pip install .
+python tests/make_fixtures.py fixtures
+musegauge run --generated fixtures/gen_small --metrics aesthetics.audiobox@1 --out out
+cat out/report.md
+```
+
+`tests/make_fixtures.py` writes synthetic sine-and-noise clips (no real music). The first run
+builds the Audiobox environment (about 5 GB) and downloads its weights (about 400 MB). Scores on
+synthetic audio mean nothing about quality.
+
+## Input and output
+
+- Input: a folder of `.wav`, `.flac`, `.ogg` or `.mp3` files (`--generated DIR`, with optional
+  `--prompts FILE`), or a clips file in JSON lines (`--manifest FILE`).
+- Metrics: a suite (`--suite t2m-basic`, the default, or `t2m-full`) or `--metrics ID,ID`.
+  `musegauge list` shows them; `musegauge info METRIC_ID` shows a definition and its licences.
+- Reference: `--reference DIR` or `--reference bundled:fma_pop` (FAD only).
+- Output folder: `results.json`, `report.md`, `per_clip/`, `logs/`, `requests/`, `responses/`.
+
+One example output, from `docs/examples/report.md` (synthetic audio; the numbers mean nothing):
+
+```text
+| Metric | Score | Mean ± std | 95% CI | n | Status |
+| --- | --- | --- | --- | --- | --- |
+| fad.vggish@1 | fad | 25.369 | — | — | ok |
+| fad.clap-laion-music@1 | fad | 1.274 | — | — | ok |
+| clapscore.laion-music@1 | clap_cosine | 0.232 ± 0.059 | [0.200, 0.262] | 12 | ok |
+| aesthetics.audiobox@1 | CE | 2.405 ± 0.557 | [2.115, 2.705] | 12 | ok |
+| aesthetics.audiobox@1 | PQ | 6.228 ± 0.827 | [5.757, 6.655] | 12 | ok |
+```
+
+## Things to know
+
+- **Offline use.** `--no-fetch` blocks downloads from libraries that honour the proxy settings,
+  and sets the Hugging Face offline variables. It is best effort, not a guarantee; for a hard
+  guarantee cut the network outside the tool (for example a container with no network). It was
+  tested only with the proxy method, not with a truly blocked network. Run
+  `musegauge setup --fetch-weights` first; `run --no-fetch` never builds an environment.
+- **Network without `--no-fetch`.** FAD and KAD with VGGish contact github.com on every run
+  (torch.hub). An HTTP error there is reported as `NETWORK_ERROR`.
+- **Licences.** Every metric's `commercial_ok` is `unknown`, so every run warns
+  `UNKNOWN_LICENCE`. `--commercial` refuses such metrics. Details: `docs/LICENCES.md`.
+- **Comparability.** Numbers are comparable only with the same metric ids, reference set, clip
+  length, device and thread setting. `fad_inf` is random from run to run. See `docs/METRICS.md`.
+- **Shared machines.** `--threads N` limits CPU threads in each plugin (`docs/INSTALL.md`).
+
+## Documentation
+
+- `docs/INSTALL.md`: install paths, offline use, disk space, GPU driver, threads
+- `docs/METRICS.md`: what each metric is and where numbers can differ
+- `docs/LICENCES.md`: code, weights and data licence status per metric
+- `docs/plugins/`: one page per plugin (commands, files, downloads, differences from upstream)
+- `docs/PLUGIN_GUIDE.md`: how to write a plugin
+- `docs/UPSTREAM_NOTES.md`: problems found in the upstream tools
+- `docs/TESTING_REAL_PLUGINS.md`: golden tests with the real tools
+- `docs/DECISIONS.md`: choices made, and every change from the build spec
+- `docs/VERIFIED_FACTS.md`, `docs/PROGRESS.md`, `docs/BUILD_REPORT.md`: checks and build record
+
+## Licence of this code
+
+Apache License 2.0 (`LICENSE`; decision D2). The metric packages and model weights that the
+plugins download have their own licences: `docs/LICENCES.md`.

musegauge-0.1.0/docker/Dockerfile

@@ -0,0 +1,35 @@
+# syntax=docker/dockerfile:1
+# musegauge container image, target `slim` (spec section 8.3). There is no `full` target in 0.1
+# (amendment A16, Roy's decision at GATE 3; see docs/IDEAS.md).
+#
+# NOT BUILT on the builder's machine: Docker is not installed there (docs/INSTALL.md).
+#
+# Build from the repository root after `uv build`, so dist/ holds exactly one musegauge wheel:
+#   docker build -f docker/Dockerfile --target slim -t musegauge:slim .
+# The plugin lock files are for linux-x86_64, so build for linux/amd64.
+
+# Base: Debian bookworm with Python 3.12. The tag was checked on Docker Hub (HTTP API) on
+# 2026-10-03, not with `docker manifest inspect`. Pin it by digest for a release.
+FROM python:3.12-slim-bookworm AS slim
+
+# System packages from section 8.3. No 0.1 plugin runs sox (amendment A6); it is kept for
+# `musegauge doctor` and later plugins. ffmpeg also gives torchaudio its FFmpeg backend.
+RUN apt-get update \
+ && apt-get install -y --no-install-recommends sox ffmpeg ca-certificates curl \
+ && rm -rf /var/lib/apt/lists/*
+
+# uv, the way the uv Docker guide shows (read 2026-10-03): copy the binaries from the uv image
+# at a fixed version (the guide recommends a fixed version or a digest over `latest`).
+COPY --from=ghcr.io/astral-sh/uv:0.12.22 /uv /uvx /bin/
+
+# musegauge from the wheel in the build context, never from PyPI, so CI tests the exact wheel.
+COPY dist/*.whl /tmp/wheels/
+RUN pip install --no-cache-dir /tmp/wheels/*.whl && rm -rf /tmp/wheels
+
+# /cache holds the plugin environments (about 24 GB once all are built) and the weights. Mount a
+# writable volume or folder there from outside the image. It is world-writable so the image also
+# works with `docker run --user`.
+RUN mkdir -p /cache && chmod 777 /cache
+ENV MUSEGAUGE_HOME=/cache
+ENTRYPOINT ["musegauge"]
+CMD ["--help"]