Skip to main content

torch-dae: an AI skill-based framework for Audio Embedding Models

Project description

torch-dae: an AI skill-based framework for Audio Embedding Models

CI Codecov Documentation Status Python 3.11 | 3.12 License: Apache-2.0 Status: Pre-release

Project status

torch-dae is pre-release research software. Its typed control plane, isolated environment and checkpoint subsystems, and evidence-grounded audio-model onboarding skill are implemented and validated. No model-specific integrations are distributed in the current release. Model support is added through the canonical onboarding workflow and isolated model-specific environments.

Overview

torch-dae turns an official audio-model implementation and a specific checkpoint into a reproducible, evidence-backed PyTorch integration. It separates lightweight repository control from model runtimes so incompatible research dependencies can live in isolated, checkpoint-specific environments.

The project keeps source provenance, scientific decisions, environment resolution, checkpoint identity, wrapper behavior, embeddings, and runtime observations explicit and machine-validatable. One model card always describes exactly one model family, variant, and checkpoint tuple.

Current capabilities

  • Strict typed contracts and generated JSON Schemas for cards, environments, checkpoints, embeddings, onboarding reports, and runtime verification.
  • Reproducible model-specific environment materialization, verification, reuse, and execution.
  • Checkpoint acquisition from HTTPS, GitHub releases, Hugging Face, package resources, and local paths, with hashing, cache validation, offline behavior, and sanitized diagnostics.
  • Static upstream inspection and evidence-grounded analysis without importing untrusted model code.
  • A canonical agent-neutral onboarding skill shared by Codex and Claude.
  • Synthetic grounded evaluations, repository safety validation, and strict quality gates.

Not available yet

  • No real audio model or checkpoint is included.
  • The model inspect and model verify CLI placeholders do not execute model workflows yet.
  • Profiling is reserved until a model is runtime-verified and a profiling workflow is explicitly implemented and invoked.

Architecture

The root package is a model-agnostic control plane:

Model cards belong under model_cards/, verification reports under verification_reports/, and committed environment inputs under environments/. Materialized environments, repositories, checkpoints, diagnostics, and coverage data remain under ignored .torch-dae/.

Installation

The complete user and API documentation is available on Read the Docs.

Install a published package-index release:

pip install torch-deepaudioembedding
torch-dae --help

Install from source with uv:

git clone https://github.com/StefanoGiacomelli/torch_dae.git
cd torch_dae
uv sync --all-groups
uv run torch-dae --help

Quick start

Inspect the empty public registry and validate a synthetic card fixture:

uv run torch-dae card list
uv run torch-dae card validate tests/fixtures/valid/model-card.analyzed.json
uv run torch-dae env --help
uv run torch-dae checkpoint --help

Model-specific environment and checkpoint commands require a committed model card and its environment specification. No such production artifact is included yet.

Available CLI commands

The implemented control-plane CLI currently exposes:

uv run torch-dae card list
uv run torch-dae card show <card-id>
uv run torch-dae card validate <card-id-or-path>

uv run torch-dae env create <card-id>
uv run torch-dae env ensure <card-id>
uv run torch-dae env verify <card-id>
uv run torch-dae env remove <card-id>
uv run torch-dae env info <card-id>
uv run torch-dae env run <card-id> -- <command>

uv run torch-dae checkpoint ensure <card-id>
uv run torch-dae checkpoint info <card-id>
uv run torch-dae checkpoint remove <card-id>

The CLI also exposes uv run torch-dae model inspect <card-id> and uv run torch-dae model verify <card-id> as explicit unavailable-feature placeholders. They do not perform onboarding or runtime verification.

Audio-model-onboarding skill

The canonical skill supports these implemented agent workflows:

  • analyze: static, evidence-grounded upstream analysis.
  • resolve-environment: compatibility resolution and controlled isolated trials.
  • integrate: explicitly authorized wrapper and model-package integration after all prerequisites.
  • verify: controlled acquisition and runtime verification for one selected model/checkpoint.
  • card: checkpoint-specific model-card generation from validated evidence and artifacts.

profile is documented separately as reserved functionality. Agent workflows are not one-shot CLI commands and must not be confused with the control-plane commands above. See the skill guide, artifact guide, and canonical templates.

Copy-paste agent request

Copy the canonical request template and fill in its placeholders:

Use the canonical `audio-model-onboarding` skill available in this repository.

MODE: <analyze | resolve-environment | integrate | verify | card>

MODEL_NAME: <MODEL_NAME>
UPSTREAM_REPOSITORY: <GITHUB_REPOSITORY_URL>
PAPER_OR_TECHNICAL_REFERENCE: <PAPER_URL_OR_NONE>

TARGET_VARIANT: <VARIANT_NAME_OR_AUTO_DISCOVER>
TARGET_CHECKPOINT: <CHECKPOINT_NAME_OR_AUTO_DISCOVER>
PREFERRED_EMBEDDING: <EMBEDDING_NAME_OR_UNRESOLVED>

ADDITIONAL_CONSTRAINTS:
<OPTIONAL_PROJECT_SPECIFIC_CONDITIONING_OR_NONE>

The template also carries the required safety, evidence, isolation, validation, mode-scope, and no-commit instructions.

Expected agent response

The canonical response template requires Summary, Work completed, Problems and resolutions, Open questions, Files, and Validation sections. It lists only files actually changed for the requested model and uses None. when no open question remains.

Repository layout

src/torch_dae/                         Root control-plane package
schemas/                               Generated strict JSON Schemas
scripts/                               Schema, coverage, and repository validation
skills/audio-model-onboarding/         Canonical agent workflow
docs/                                  Public subsystem and workflow guides
tests/                                 Contract, subsystem, safety, and synthetic evaluation tests
environments/                          Committed per-card environment inputs
model_cards/                           Checkpoint-specific production cards
verification_reports/                  Committed runtime observations
.torch-dae/                            Ignored runtime state

The .agents/ and .claude/ skill entries are public relative symlinks to the canonical skill.

Development and validation

uv sync --all-groups
uv run ruff format --check
uv run ruff check
uv run mypy src scripts
uv run pytest
uv run python scripts/generate_schemas.py --check
uv run python scripts/validate_repository.py
uv run python skills/audio-model-onboarding/scripts/validate_skill_artifacts.py . --json

Run coverage with the same local thresholds as CI:

mkdir -p .torch-dae
uv run pytest -q \
  --cov=torch_dae \
  --cov-branch \
  --cov-report=term-missing \
  --cov-report=json:.torch-dae/coverage.json
uv run python scripts/check_coverage.py \
  .torch-dae/coverage.json \
  --min-line 85 \
  --min-branch 70

See CONTRIBUTING.md for contribution and pull-request expectations.

Roadmap

Model support is added through the canonical onboarding workflow after its evidence, isolation, and runtime prerequisites are satisfied. Profiling remains unavailable until a model integration is runtime-verified and a dedicated profiling workflow is implemented.

Funding

The research project title is:

Methods of Computational Auditory Scene Analysis and Synthesis supporting eXtended and Immersive Reality Services

Funding identifiers: DM 118/2023; Mission 4; Component 1; Investment 4.1; PNRR Research; CUP E11I23000100001.

Research activities were mainly funded under the Ministerial Decree (DM) 118/2023, Mission 4, Component 1, Investment 4.1 of the National Recovery and Resilience Plan (PNRR) – “PNRR Research” – CUP: E11I23000100001.

Citations

Cite the software entry when citing this repository or package. Also cite the IEEE ISCC paper when discussing the framework design, standardization rationale, or deployment methodology. The repository's canonical software metadata is in CITATION.cff.

@software{giacomelli2026torch_dae,
  author  = {Giacomelli, Stefano},
  title   = {{torch-dae}: an AI skill-based framework for Audio Embedding Models},
  year    = {2026},
  version = {0.1.0},
  url     = {https://github.com/StefanoGiacomelli/torch_dae},
  license = {Apache-2.0}
}
@inproceedings{giacomelli2025torch_dae,
  author    = {Giacomelli, Stefano and Centofanti, Carlo and
               Graziosi, Fabio and Rinaldi, Claudia},
  title     = {{Design and Deployment of a Standard Framework for
                Audio Neural Networks Embedding Models}},
  booktitle = {2025 IEEE Symposium on Computers and Communications (ISCC)},
  year      = {2025},
  pages     = {1--6},
  doi       = {10.1109/ISCC65549.2025.11326439},
  publisher = {IEEE}
}

License

Licensed under the Apache License 2.0. Attribution information is provided in NOTICE.

Contact

Stefano Giacomelli
ICT - Ph.D. Candidate
Department of Information Engineering, Computer Science and Mathematics (DISIM)
University of L'Aquila, Italy

University of L'Aquila — DISIM

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

torch_deepaudioembedding-0.1.0.tar.gz (310.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

torch_deepaudioembedding-0.1.0-py3-none-any.whl (106.4 kB view details)

Uploaded Python 3

File details

Details for the file torch_deepaudioembedding-0.1.0.tar.gz.

File metadata

  • Download URL: torch_deepaudioembedding-0.1.0.tar.gz
  • Upload date:
  • Size: 310.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for torch_deepaudioembedding-0.1.0.tar.gz
Algorithm Hash digest
SHA256 90c1aeaddbd6d61db2871c18f44881fe2f4b24750b8569c34e17083469aa91c1
MD5 483fbb5531541a128d35b0f68ebb81a3
BLAKE2b-256 e166f238104cb2b98b919bd0b3b6659b8b48781b7bb9f887c22f7169446ef5fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for torch_deepaudioembedding-0.1.0.tar.gz:

Publisher: publish.yml on StefanoGiacomelli/torch_dae

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file torch_deepaudioembedding-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for torch_deepaudioembedding-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f7b461eead6fa793c8d0d83b26bc3366b59ee4c3950b8fab0ac6c814e323fb6
MD5 3947d5a5105aed520d488fb2f067c9fc
BLAKE2b-256 cbec3492547dd9a457765ad61d062bad553d397b66b3ade77b14657eca95d404

See more details on using hashes here.

Provenance

The following attestation bundles were made for torch_deepaudioembedding-0.1.0-py3-none-any.whl:

Publisher: publish.yml on StefanoGiacomelli/torch_dae

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page