Docker

Docker is a containerization platform that allows you to run applications in a sandboxed environment. This is a great way to run Synthesized without having to install anything on your machine.

Synthesized’s Docker image contains the SDK bundled up with a jupyter notebook. This provides an easy platform to start experimenting with synthetic data. You can find the Docker image here: synthesizedio/sdk-jupyter-server.

Getting Started

To install and run the container, you will need to have docker installed on your machine. You can find instructions on how to install docker here: https://docs.docker.com/get-docker/. Once installed, you can use the following command:

docker run -p 8888:8888 -v /path/to/your/notebooks:/synthesized \
synthesizedio/sdk-jupyter-server

This will start a jupyter notebook server on port 8888. You can then navigate to http://localhost:8888 to start using the sdk.

In order to run Synthesized, you will need to have a valid licence key. The key can be set at the start of the notebook by running the following command:

import os
os.environ['SYNTHESIZED_KEY'] = 'LICENCE_KEY_HERE'

You can also set the key when running the docker container by using the following command:

docker run -p 8888:8888 -v /path/to/your/notebooks:/synthesized \
-e SYNTHESIZED_KEY=LICENCE_KEY_HERE synthesizedio/sdk-jupyter-server