User Guide
Welcome to the User Guide section of the Avatars documentation.
This is where theory turns into practice.
Whether you're here for a quick hands-on experience or looking to deeply integrate Avatars into your data workflows, this guide will show you how to use the tool efficiently and securely.
Choose your path 👇
We offer two complementary ways to learn how to use Avatars, depending on your needs and level of familiarity.
🚀 Quickstart – Get started in under 5 minutes
If you're new to Avatars or just want to try it out quickly, we recommend starting with one of our Quickstart guides.
They’ll walk you through a simple example using either the Web client or the Python client, so you can see how it works—fast.
🔍 Step-by-Step – Master the tool with detailed instructions
If you're planning a more advanced or production-grade use of Avatars, the step-by-step guide is for you.
It covers the entire anonymization process in detail, broken down into three key stages:
- Prepare – Understand data requirements and how to format your dataset
- Run – Launch the anonymization using the Web or Python client
- Enhance – Evaluate quality, review privacy reports, and export your synthetic data
👉 Go to the Step-by-Step guide
Whichever path you choose, you can switch at any time or explore both.
Let’s get started! ✨