Tutorials#
Learn how to run private synthetic data jobs through hands-on tutorials. Each tutorial provides step-by-step guidance with executable code examples.
Prerequisites#
Before starting any tutorial, ensure you have:
NeMo Safe Synthesizer deployed using Docker Compose or Helm
Python environment with
nemo-microservicesSDK installed:pip install nemo-microservices[safe-synthesizer]
Basic understanding of data privacy concepts
Jupyter environment for running tutorial notebooks
Getting Started#
Learn the basics with your first Safe Synthesizer job, leveraging smart defaults. This tutorial covers uploading data, running a job with PII replacement, and reviewing evaluation reports.
Topics covered:
Installing the SDK
Connecting to Safe Synthesizer
Using
SafeSynthesizerJobBuilderMonitoring job progress
Retrieving synthetic data and evaluation reports
Advanced Topics#
Apply differential privacy to achieve the maximum level of privacy with mathematical guarantees. This tutorial explores the privacy-utility tradeoff and how to configure differential privacy parameters.
Topics covered:
Understanding differential privacy concepts (epsilon, delta)
Configuring privacy hyperparameters
Privacy budget analysis
Evaluating privacy-utility tradeoffs
Interpreting privacy metrics
Detect, redact, or replace PII without creating a fully synthetic version. This tutorial demonstrates using Safe Synthesizer exclusively for PII replacement.
Topics covered:
Configuring PII detection methods
Custom entity definitions
Replacement strategies (fake, redact, hash)
Detection method comparison
PII-only workflows
Additional Resources#
After completing these tutorials, explore:
About Safe Synthesizer: Understand core concepts and components
Need Help?#
Check the GitHub Issues for known issues
Review the Safe Synthesizer Jobs guide for job management