Installation

Synthesized’s SDK3 is available on PyPI which makes the installation process straight forward.

A licence key is required to use this beta version of the package.

Installing the python package

It is assumed that you have Python 3.9-3.11 already installed on a Windows, Linux or MacOS machine.

Before starting, ensure that pip and wheel are installed and up to date.

pip install -U pip wheel

Synthesized can then be installed with pip.

pip install synthesized3

Setting the licence key

Once you have installed the package, you’ll need a licence key to run the software. The quickest way to check if the SDK is working is by running the command:

synth3-validate

The first time this is run you will be asked if you have a licence key. If you do not have one simply select "no" and the prompts will guide you in acquiring one by entering your email address.

With the SDK installed you are now able to get synthesizing! Check out our tutorials or API reference documentation for ways that the SDK can be put to use.

Dependencies

Below are the minimum dependencies required to run the SDK3.

Package Version

ff3

numpy

pandas

prompt-toolkit

>=3.0.0

pyarrow

pycryptodome

pyspark

>=3.4

pydantic

<2

PyYAML

rsa

>=4.7

rstr

scipy

tensorflow-cpu

>=2.13

tensorflow-probability

>=0.20