Skip to content

docs: add offline model install paths (#509)#514

Open
gitcommit90 wants to merge 1 commit into
altic-dev:mainfrom
gitcommit90:docs/issue-509-offline-model-install
Open

docs: add offline model install paths (#509)#514
gitcommit90 wants to merge 1 commit into
altic-dev:mainfrom
gitcommit90:docs/issue-509-offline-model-install

Conversation

@gitcommit90

Copy link
Copy Markdown

Summary

  • Documents manual/offline model installation paths for users who cannot download from Hugging Face in-app.
  • Lists the local cache folder and required files for Nemotron, Parakeet, Parakeet Flash, Cohere, and Whisper.
  • Calls out that Nemotron models belong under ~/Library/Caches/, not ~/Library/Application Support/, matching the reported issue.

Closes #509

Test Plan

  • python3 /tmp/hermes-verify-fluidvoice-offline-model-docs.py
  • npx --yes prettier@3.6.2 --check README.md
  • git diff --check HEAD~1..HEAD

xcodebuild was not run: this is a README-only change, and my scout host is Linux without Xcode.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 97866083ab

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread README.md
| Parakeet TDT v3 | [`FluidInference/parakeet-tdt-0.6b-v3-coreml`](https://huggingface.co/FluidInference/parakeet-tdt-0.6b-v3-coreml) | `~/Library/Application Support/FluidAudio/Models/parakeet-tdt-0.6b-v3-coreml/` | `Preprocessor.mlmodelc`, `Encoder.mlmodelc`, `Decoder.mlmodelc`, `JointDecision.mlmodelc`, `parakeet_vocab.json` |
| Parakeet TDT v2 | [`FluidInference/parakeet-tdt-0.6b-v2-coreml`](https://huggingface.co/FluidInference/parakeet-tdt-0.6b-v2-coreml) | `~/Library/Application Support/FluidAudio/Models/parakeet-tdt-0.6b-v2-coreml/` | same as Parakeet TDT v3 |
| Parakeet Flash (Beta) | [`FluidInference/parakeet-realtime-eou-120m-coreml`](https://huggingface.co/FluidInference/parakeet-realtime-eou-120m-coreml) | `~/Library/Application Support/FluidAudio/Models/parakeet-eou-streaming/160ms/` | copy the repository's `160ms` folder contents here: `streaming_encoder.mlmodelc`, `decoder.mlmodelc`, `joint_decision.mlmodelc`, `vocab.json` |
| Cohere Transcribe | [`BarathwajAnandan/cohere-transcribe-03-2026-CoreML-6bit`](https://huggingface.co/BarathwajAnandan/cohere-transcribe-03-2026-CoreML-6bit) | `~/Library/Caches/cohere-transcribe-03-2026-CoreML-6bit/` | `coreml_manifest.json`, `cohere_frontend.mlpackage`, `cohere_encoder.mlpackage`, `cohere_cross_kv_projector.mlpackage`, `cohere_decoder_fullseq_masked.mlpackage`, `cohere_decoder_cached.mlpackage` |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Include the Cohere bundle stamp for offline installs

For users who manually copy Cohere into this documented default cache folder, the app will not accept only these listed files: validatesInstalledArtifacts requires the managed cache to also have .fluid_artifact_bundle_version matching the registry's artifactBundleVersion, and ensureArtifactsPresent removes a managed directory when that stamp is missing/stale before trying to download. In an offline install this leaves isInstalled false and can delete the copied artifacts, so this row should either include the required stamp or direct users to configure a non-managed artifacts directory.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to manually install models offline?

1 participant