From 8a03f4bce500c31cac25be5afffe93f85815b3e5 Mon Sep 17 00:00:00 2001 From: Kelly Davis Date: Sun, 7 Mar 2021 19:50:30 +0100 Subject: [PATCH] Note on supported platforms --- doc/SUPPORTED_PLATFORMS.rst | 2 +- doc/USING.rst | 2 +- doc/index.rst | 4 +++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/SUPPORTED_PLATFORMS.rst b/doc/SUPPORTED_PLATFORMS.rst index 800d92f2..94c36c1d 100644 --- a/doc/SUPPORTED_PLATFORMS.rst +++ b/doc/SUPPORTED_PLATFORMS.rst @@ -3,7 +3,7 @@ Supported platforms for inference ================================= -Here we maintain the list of supported platforms for running inference. +Here we maintain the list of supported platforms for running inference. Note that for now we only have working packages for Python on Linux, without GPU support. We're working to get the rest of our supported languages and architectures up and running. Linux / AMD64 without GPU ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/USING.rst b/doc/USING.rst index 9ca9c4d4..03101e85 100644 --- a/doc/USING.rst +++ b/doc/USING.rst @@ -3,7 +3,7 @@ Using a Pre-trained Model ========================= -Inference using a 🐸STT pre-trained model can be done with a client/language binding package. We have four clients/language bindings in this repository, listed below, and also a few community-maintained clients/language bindings in other repositories, listed `further down in this README <#third-party-bindings>`_. +Inference using a 🐸STT pre-trained model can be done with a client/language binding package. We have four clients/language bindings in this repository, listed below, and also a few community-maintained clients/language bindings in other repositories, listed `further down in this README <#third-party-bindings>`_. Note that for now we only have working packages for Python on Linux, without GPU support. We're working to get the rest of our supported languages and architectures up and running. * :ref:`The C API `. * :ref:`The Python package/language binding ` diff --git a/doc/index.rst b/doc/index.rst index e7de654c..acc694f4 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,6 +8,8 @@ Coqui STT **Coqui STT** (🐸STT) is an open-source deep-learning toolkit for training and deploying speech-to-text models. 🐸STT is battle tested in both production and research 🚀 +For now we only have working packages for Python on Linux, without GPU support. We're working to get the rest of our supported languages and architectures up and running. + To install and use 🐸STT all you have to do is: .. code-block:: bash @@ -32,7 +34,7 @@ To install and use 🐸STT all you have to do is: A pre-trained English model is available for use and can be downloaded following the instructions in :ref:`the usage docs `. For the latest release, including pre-trained models and checkpoints, `see the GitHub releases page `_. -Quicker inference can be performed using a supported NVIDIA GPU on Linux. See the `release notes `_ to find which GPUs are supported. To run ``stt`` on a GPU, install the GPU specific package: +Quicker inference can be performed using a supported NVIDIA GPU on Linux. See the `release notes `_ to find which GPUs are supported. To run ``stt`` on a GPU, install the GPU specific package. Note that for now the GPU package is not available. We're working to get all of our supported languages and architectures up and running. .. code-block:: bash