|
Welcome to the synthyverse! An extensive ecosystem for synthetic data generation and evaluation in Python. Read the docs for in-depth usage. The synthyverse is a work in progress. Please provide any suggestions through a GitHub Issue. |
Features
- Tabular synthetic data generators. Use low-level generators directly, or wrap them with shared preprocessing through
SynthyverseGenerator. - Evaluation metrics. Compare synthetic data with fidelity, utility, and privacy metrics through individual metric classes or
TabularMetricEvaluator. - Benchmarking workflows. Train, sample, evaluate, and save benchmark artifacts with
TabularSynthesisBenchmark. - Shared preprocessing. Reuse
DataProcessorfor missing-value handling, schema restoration, and column constraints.
Installation
Install synthyverse from PyPI:
pip install synthyverse
The base package is MIT licensed and does not install the ctgan package.
CTGANGenerator and TVAEGenerator are only available when installing the
optional CTGAN extra:
pip install "synthyverse[ctgan]"
That extra installs the ctgan dependency, which is distributed under the
Business Source License. Review that license before using CTGAN or TVAE
functionality.
Third-party attribution, license, NOTICE, and modification details are listed
in THIRD_PARTY_NOTICES.md.
For local development from a clone:
pip install -e .
Usage
Use a high-level wrapper when you want preprocessing and schema restoration handled for you:
from synthyverse.generators import SynthyverseGenerator
generator = SynthyverseGenerator(
"univariate",
missing_imputation_method="median",
random_state=42,
)
generator.fit(X, discrete_features=["category", "target"])
X_syn = generator.generate(1000)
Use the lower-level APIs when you want explicit control over preprocessing, generator fitting, metrics, or benchmarking. See the docs for complete examples.
Metadata
Release files for synthyverse 0.2.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| synthyverse-0.2.9.tar.gz | 2.1 MB | Without provenance | Details for synthyverse-0.2.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| synthyverse-0.2.9-py3-none-any.whl | Python 3 | none | any | Details for synthyverse-0.2.9-py3-none-any.whl |
Total release size: 2.4 MB
Release files / synthyverse-0.2.9.tar.gz
| Download URL | synthyverse-0.2.9.tar.gz |
|---|---|
| Size | 2.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ea320e4888a4a53a35a99c4a18be918f82f788f2d7ae1d2b62d00b82215943d9
|
|
BLAKE2b-256 checksum How to use checksums |
b0f0621d2e0c0a43a2d3202a0ce0ff66d271459bc24cc9c7acc07a79a368786f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Release files / synthyverse-0.2.9-py3-none-any.whl
| Download URL | synthyverse-0.2.9-py3-none-any.whl |
|---|---|
| Size | 300.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
31c25030c5d026dc9ca24c1f799502da48203cb031635da035441fe086202e7b
|
|
BLAKE2b-256 checksum How to use checksums |
10530a4276f4ac24ff803623d4ab63cdd267e146c8700edfcc28e77dd4cb9442
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Security for synthyverse 0.2.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.