synthesizedio/sdk repository overview

⁠Synthesized's Scientific Data Kit (SDK)

The SDK generates high quality, privacy-preserving datasets for machine learning and data science use cases.

⁠Usage

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.

⁠Installation

It is assumed that you have docker already installed.

The quickest way to get started is to run the docker container interactively.

docker run -it synthesizedio/sdk

⁠Setting the licence key

Once you have the docker container running, 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:

synth-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.

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.