synthpop-py documentation#

Version: 1.0.0

Useful links: Installation | Source Repository | Issue Tracker | Synthpop R Package

Getting started

New to synthpop-py? Check out the getting started guide. It introduces the key concepts behind synthpop-py and includes step-by-step installation instructions to help you begin creating synthetic datasets.

User guide

The user guide provides in-depth information on the key concepts of synthpop-py, including useful background information, examples, and explanations to help you understand how synthetic datasets are generated and used.

API reference

The reference guide contains a detailed description of the functions, modules, and objects included in synthpop-py. It explains how specific methods work, and which parameters can be used. It assumes that you have a basic understanding of synthpop-py’s core concepts.

Developer’s guide

Saw a typo? Want to contribute to the codebase? Help improve the documentation, add examples, or suggest new features? The developer’s guide will guide you through the process of improving synthpop-py.