examples

MT3-Infer Examples

Example scripts demonstrating MT3-Infer usage.

---

Available Examples

Model Comparison (compare_models.py)

Compare MR-MT3 and YourMT3 performance on real audio.

Usage:

uv run python examples/compare_models.py

Output:

• comparison_mr_mt3.mid - MR-MT3 transcription
• comparison_yourmt3.mid - YourMT3 transcription
• Performance comparison table

---

GPU Testing (test_gpu.py)

Test both adapters on GPU with automatic device detection.

Usage:

uv run python examples/test_gpu.py

Requirements:

• CUDA-capable GPU
• CUDA toolkit installed

Output:

• GPU performance metrics
• gpu_test_mr_mt3.mid - MR-MT3 GPU output
• gpu_test_yourmt3.mid - YourMT3 GPU output

---

YourMT3 Quick Test (test_yourmt3_quick.py)

Quick functional test for YourMT3 adapter.

Usage:

uv run python examples/test_yourmt3_quick.py

Output:

• MIDI transcription
• Note count and basic validation

---

YourMT3 Verification (verify_yourmt3.py)

Systematic verification of YourMT3 adapter implementation.

Usage:

uv run python examples/verify_yourmt3.py

Checks:

• Import validation
• MT3Base interface compliance
• Model registry
• Checkpoint verification
• Dependency checks
• Functional test
• MIDI validation

---

Diagnostics Utilities

Additional troubleshooting and regression scripts now live under examples/diagnostics/:

• download_mt3_pytorch.py – Demonstrates manual vs. automatic checkpoint download flows.
• test_all_models.py – End-to-end transcription smoke test for MR-MT3, MT3-PyTorch, and YourMT3.
• test_checkpoint_download.py – Verifies checkpoint download destinations and quick inference sanity checks.
• test_yourmt3.py – Full-length integration test for YourMT3 with audio transcription and MIDI export.

Run them the same way as other examples, e.g. uv run python examples/diagnostics/test_all_models.py.

---

Running Examples

All examples use uv run to ensure correct environment:

# Basic syntax
uv run python examples/<script_name>.py

# With test audio (adjust path as needed)
uv run python examples/compare_models.py

---

Test Outputs

Example scripts generate MIDI files in test_outputs/ directory:

• comparison_*.mid - Model comparison outputs
• gpu_test_*.mid - GPU test outputs
• yourmt3_*.mid - YourMT3 test outputs

Note: Test outputs are gitignored and not included in package distribution.

---

Creating New Examples

When creating new example scripts:

1. Add to this directory: examples/
2. Use uv run python for execution
3. Document in this README
4. Use clear, descriptive names
5. Include docstrings and comments
6. Output to test_outputs/ directory

Template:

#!/usr/bin/env python3
"""
Brief description of what this example demonstrates.
"""

from mt3_infer.adapters.mr_mt3 import MRMT3Adapter
from mt3_infer.utils.audio import load_audio

# Your example code here
adapter = MRMT3Adapter()
adapter.load_model('checkpoint.pth')
# ...