Skip to main content

Synthesized SDK

Project description


Documentation PyPI codecov Quality Gate Status Technical Debt Supported Python Versions Supported OS


Synthesized's Scientific Data Kit (SDK)

The SDK generates high quality, privacy-preserving datasets for machine learning and data science use cases. It's available on PyPi for a free 30-day trial.


A licence key is required to use the full version of the package. If you don't have one, a free 30-day trial licence key will be provided during the installation. See the comparison table in the documentation for details about the features included in the trial.

Please contact us for more information about obtaining a full licence key.


It is assumed that you have Python 3.7+ 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 directly with pip.

pip install synthesized

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:


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.


Once you have set your licence key, the SDK will briefly verify the installation was successful.

With the SDK installed you are now able to get synthesizing! Check out our quick start or user guides for ways that the SDK can be put to use.


Below are the minimum dependencies required to run the SDK.

Package Version
faker >=8.0
matplotlib >=3.4
numpy >=1.19.2
pandas >=1.2
prompt-toolkit >=3.0
PyYAML >=5.2
rsa >=4.7
rstr >=2.2
scikit_learn >=0.23
scipy >=1.5
seaborn >=0.11
synthesized_insight >=0.5
tensorflow_privacy <0.8, >=0.6
tensorflow_probability >=0.14.0
tensorflow <2.11, >=2.6
yamale >=4.0.4

The library can use a GPU but it is not required.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distributions

synthesized-2.5-cp310-cp310-win_amd64.whl (5.4 MB view hashes)

Uploaded cp310

synthesized-2.5-cp39-cp39-win_amd64.whl (5.4 MB view hashes)

Uploaded cp39

synthesized-2.5-cp38-cp38-win_amd64.whl (5.4 MB view hashes)

Uploaded cp38

synthesized-2.5-cp37-cp37m-win_amd64.whl (5.3 MB view hashes)

Uploaded cp37

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page