Setting up Synthetic Data

Installation instructions for the Synthetic Data feature.

Prerequisites

Ensure that the following prerequisites are met before running these examples for Synthetic Data:

Docker CLI, Docker Compose, and Python are installed. For more information, refer to Setting Up AI Developer Edition.
For shell samples: Bash version greater than or equal to 5.1.8 and curl version greater than or equal to 7.76.1.
For notebook samples: JupyterLab version greater than or equal to 4.5.6.

Use the containers to set up the Synthetic Data feature for data generation.

Open a command prompt.
Navigate to the cloned repository location for protegrity-ai-developer-edition.
Run the following command to download and start the containers. The dependent containers are large in size. Based on the network connection, the containers might take time to download and deploy.
```
cd synthetic-data
docker compose up -d
```
Based on your configuration use the docker-compose up -d command.
Note: By default images are obtained from ghcr.io. To obtain images from public.ecr.aws, navigate to the synthetic-data directory and copy the .env.example file to .env. Open the .env file and uncomment the REGISTRY=public.ecr.aws/protegrity-ai-developer-edition line in the file. Save the file and run the docker compose up -d command to download and start the containers.
Verify that the containers started successfully.
```
docker compose logs
```
Set up the Jupyter notebook for working with the notebooks provided from the cloned repository location for protegrity-ai-developer-edition.
```
pip install -r shared/requirements.txt
```

Install the Synthetic Data SDK package.

pip install protegrity-synthetic-data-sdk

Open a command prompt.
Navigate to the cloned repository location for protegrity-ai-developer-edition.
If the step to stop containers was missed earlier, then use the following commands to identify and remove the AI Developer Edition containers.
```
docker compose down --remove-orphans
```

Delete the docker network resources.

docker network rm -f <network_name_or_id>

For example,

docker network rm -f protegrity-network

Run the following command to download and start the containers. The dependent containers are large in size. Based on the network connection, the containers might take time to download and deploy.
```
cd synthetic-data
docker compose up -d
```
Based on your configuration use the docker-compose up -d command.
Verify that the containers started successfully.
```
docker compose logs
```
Set up the Jupyter notebook for working with the notebooks provided from the cloned repository location for protegrity-ai-developer-edition.
```
pip install -r shared/requirements.txt
```

Upgrade the Synthetic Data SDK package.

pip install --upgrade protegrity-synthetic-data-sdk

Was this page helpful?

Last modified : July 08, 2026