Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include audio file restrictions in DEPLOYMENT.rst #2336

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/DEPLOYMENT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ Model compatibility

🐸STT models are versioned to mitigate incompatibilities with clients and language bindings. If you get an error saying your model file version is too old for the client, you should either (1) upgrade to a newer model, (2) re-export your model from the checkpoint using a newer version of the code, or (3) downgrade your client if you need to use the old model and can't re-export it.

Data compatibility
^^^^^^^^^^^^^^^^^^

Currently, 🐸STT can is only compatable with audio that is saved in the .WAV format. Files in other formats will need to be converted using other software before they can be transcribed using 🐸STT.

.. _py-usage:

Using the Python package
Expand Down