Introduction
Welcome to the documentation of the aindo.rdml
library.
aindo.rdml
is a library for the generation of synthetic tabular and relational data
using neural generative models.
With this library, users can:
- Preprocess tabular and relational data.
- Train generative models for synthetic data generation.
- Generate synthetic data and assess its quality.
This documentation serves as a comprehensive guide to the functionalities offered by the aindo.rdml
library.
In the next sections, we present the installation instructions and a quick start guide to the library.
In the User guide section, we provide an in-depth discussion on how to use
the aindo.rdml
library in a variety of scenarios.
Next, we present the API reference for the library, including descriptions of all the available classes and functions in each of the three modules:
- The
aindo.rdml.relational
module is designed for transforming and preprocessing data organized in tabular and relational structures. - The
aindo.rdml.synth
module handles the training of generative models and the generation of synthetic data using the trained models. - The
aindo.rdml.eval
module supports the evaluation of synthetic data quality, providing metrics to assess the similarity between synthetic and real data, as well as to evaluate privacy-related performance.
Finally, we present a few example scripts, covering end-to-end examples
of the most common use cases of the aindo.rdml
library to generate synthetic data.