Before the DeepTone™ SDK can be used, it must first be initialized. Before you do so, ensure you have your License Key and Model file. If you don't, you can request them at email@example.com.
This page will guide you through the process of setting up the DeepTone™ SDK in your project. Select your platform below to get started.
Note: Python version 3.7 is required.
If you already have python 3.7.x installed on your machine or know how to do it, please skip this section and continue with the environment setup
To install a specific python version
pyenv can be used.
- Mac OS / Linux
pyenv in Mac OS or Linux the
pyenv-installer can be used. Follow
the installation instructions here
or directly use this command to install:
This will add pyenv initialisation commands to your shell's "rc" file. Reload you shell to apply the changes:
Now you are ready to use
pyenv to install a specific python version:
x should be replaced with the latest patch version.
Alternatively, you can use
to get a list of all available python versions.
Once the python version 3.7 is installed, you can either set it as your local python version
such that this version of python will only be used in your current directory, or set it as your global python version with
Now you are ready to install the DeepTone™ SDK.
Set up your environment using your preferred Python Environment Manager.
- Poetry (recommended)
Create a Poetry project if you don’t have one already, by running:
By default, new Poetry projects are created with a Python version constraint allowing the use of Python 3.7 or higher. As the SDK is currently incompatible with Python 3.8, you'll need to adjust the constraint for your project, otherwise you'll get a compatibility error.
To do so, look for the
tool.poetry.dependencies section of your
pyproject.toml file, and replace the Python version
Add the following to your
pyproject.toml, to configure Poetry to fetch packages from OTO’s PyPI repository:
After the repository is configured, run the following to add the dependency to your project:
Validate the SDK was correctly installed, by importing it within a Python shell and executing the following commands:
If the import was successful, congratulations, you are now ready to use DeepTone™! Head to our Usage section to start exploring.