Commit Graph
3 Commits
Author SHA1 Message Date
Alex 637b609af0 Update ModelConversion.md with PR referencing and validation steps
Clarify instructions for referencing models in PRs and add additional steps for validation and documentation.
2026-04-07 19:45:51 -04:00
Alex 4cf1914e4b docs: add existing benchmark datasets to model conversion guide (#392)
## Summary
- Follow-up to #391 — adds an **Existing benchmark datasets** table to
`Documentation/ModelConversion.md`
- Documents all 11 datasets already available in FluidAudio
(LibriSpeech, FLEURS, AISHELL-1, Earnings22, Buckeye, VOiCES, MUSAN,
AMI-SDM, VoxConverse, CharsiuG2P, text normalization) with domain, size,
format, and download location
- Notes that most CLI commands auto-download datasets, and explains
when/how to add new ones
- Updates the checklist to reference the dataset table

## Context
PR #391 added the model conversion guide but didn't mention the existing
benchmark datasets. Contributors and coding agents should use the
existing datasets for benchmarking rather than creating new ones unless
a domain gap exists.

## Test plan
- [x] Verify all dataset names, sizes, and paths match the current
codebase
- [ ] Review table formatting renders correctly on GitHub
<!-- devin-review-badge-begin -->

---

<a href="https://app.devin.ai/review/fluidinference/fluidaudio/pull/392"
target="_blank">
  <picture>
<source media="(prefers-color-scheme: dark)"
srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1">
<img
src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1"
alt="Open with Devin">
  </picture>
</a>
<!-- devin-review-badge-end -->
2026-03-17 18:41:37 -04:00
Alex a7b044a920 docs: add model conversion guide (#391)
## Summary
- Adds `Documentation/ModelConversion.md` — an end-to-end guide for
converting models to CoreML and integrating them into FluidAudio
- Covers both stages: mobius (conversion + HuggingFace upload) and
FluidAudio (registration, inference code, CLI, tests)
- Includes checklists for both repositories so nothing gets missed
- Intended audience: contributors and coding agents working on new model
integrations

## Test plan
- [ ] Review documentation for accuracy against current codebase
patterns
- [ ] Verify all referenced file paths and code patterns match the repo
<!-- devin-review-badge-begin -->

---

<a href="https://app.devin.ai/review/fluidinference/fluidaudio/pull/391"
target="_blank">
  <picture>
<source media="(prefers-color-scheme: dark)"
srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1">
<img
src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1"
alt="Open with Devin">
  </picture>
</a>
<!-- devin-review-badge-end -->
2026-03-17 18:27:22 -04:00