From 3ffc7073f5828318cca2f73e211384b06ababd12 Mon Sep 17 00:00:00 2001
From: BeauregardTA <76680220+BeauregardTA@users.noreply.github.com>
Date: Tue, 17 Jan 2023 08:29:04 -0500
Subject: [PATCH] Include audio file restrictions in DEPLOYMENT.rst

While this information is hinted at elsewhere in the documentation, is is only found in pages concerning training models. People who are looking to deploy pre-trained models are likely to miss this information and it should be explicitly stated in parts of the documentation that they are likely to look.
---
 doc/DEPLOYMENT.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/DEPLOYMENT.rst b/doc/DEPLOYMENT.rst
index 6c5747d10..3a0c71105 100644
--- a/doc/DEPLOYMENT.rst
+++ b/doc/DEPLOYMENT.rst
@@ -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