Skip to main content

Advanced synthetic data generation library

Project description

GENESIS Core Lib

Python Version License PyPI Version PyPI Downloads Test and Build Lib codecov Code Style Type Checking Documentation

What is GENESIS Core Lib?

GENESIS Core Lib is an open-source, advanced synthetic data generation library for Python 3.12+ that provides state-of-the-art machine learning models including VAEs (TabularVAE, TimeSeriesVAE) and CTGAN for generating high-quality tabular and time series data. The library features adaptive on-the-fly training with automatic model adaptation to data characteristics, model persistence for reusing trained models, behavior control through custom mathematical functions, and integrated quality evaluation metrics. Designed with privacy preservation in mind and optimized for both CPU and GPU processing, it offers a comprehensive Job API for data augmentation, privacy preservation, and ML model testing across various data types and use cases.

GENESIS Core Lib is the algorithmic core of the GENESIS project. All developments are focused on building a compact, easy to use system for everyone.

Why use GENESIS core Lib?

GENESIS Core Lib is the ideal solution for synthetic data generation because it specializes in industrial sensor data and time series applications, offering state-of-the-art models like TimeSeriesVAE that preserve temporal patterns and statistical properties essential for real-world scenarios. It provides immediate access to high-quality synthetic data without the costs and delays of physical sensor deployments, enabling rapid prototyping, algorithm development, and comprehensive testing while maintaining data privacy through synthetic data sharing. The library ensures data fidelity with advanced evaluation metrics including Dynamic Time Warping and correlation preservation, making it perfect for manufacturing IoT, environmental monitoring, energy utilities, and medical device applications where realistic temporal data is critical.

Difference Generation

Nyquist plots created merging two time-series of real and imaginary impedances. Can you tell the difference?

✨ Key Features

  • Generative AI Architectures: Advanced VAEs (TabularVAE, TimeSeriesVAE) and CTGAN for Tabular and Time series data
  • Adaptive Training: On-the-fly model training with automatic adaptation to your data characteristics
  • Model Persistence: Save and reuse trained generative models for consistent data generation
  • Behavior Control: Manipulate generation patterns with custom mathematical functions
  • Integrated Evaluation: Built-in quality assessment metrics for comprehensive data evaluation
  • High Performance: Optimized for both CPU and GPU processing

🛠️ Quick Start

Quick Install

pip install sdg-core-lib

🚀 Try it

from sdg_core_lib import Job

# Text-based JSON configuration (no file needed)
config = {
    "n_rows": 1000,
    "model": {
        "algorithm_name": "sdg_core_lib.data_generator.models.VAEs.implementation.TabularVAE.TabularVAE",
        "model_name": "customer_synthetic_model"
    },
    "dataset": {
        "dataset_type": "table",
        "data": [
            {
                "column_data": [13.71, 13.4, 13.27, 13.17, 14.13, 13.88, 13.24, 13.73],
                "column_name": "alcohol",
                "column_type": "continuous",
                "column_datatype": "float64"
            },
            {
                "column_data": [5.65, 3.91, 4.28, 2.59, 4.1, 3.9, 3.8, 4.2],
                "column_name": "malic_acid",
                "column_type": "continuous",
                "column_datatype": "float64"
            },
            {
                "column_data": [1.28, 1.05, 1.02, 1.03, 1.71, 1.23, 1.07, 1.5],
                "column_name": "ash",
                "column_type": "continuous",
                "column_datatype": "float64"
            }
        ]
    },
    "save_filepath": "./models"
}

# Create and run a synthetic data generation job
job = Job(
    n_rows=config["n_rows"],
    model_info=config["model"],
    dataset=config["dataset"],
    save_filepath=config.get("save_filepath", "./models")
)

# Generate synthetic data
results, metrics, model, schema = job.train()
print(f"Generated {len(results)} synthetic rows")
print(f"Quality metrics: {metrics}")

📖 See Quick Start Guide for detailed examples

📚 Documentation

📖 User Documentation

Complete guide for users including:

  • Core concepts and the Job API
  • Data Types and Datasets
  • Fantastic Models and how to use them
  • How to handle raw data with Processors
  • How to control generation of synthetic data with Functions
  • Evaluate your work with Evaluators

🔧 Developer Documentation

Technical documentation for developers:

  • Architecture overview and design patterns
  • Extension points and customization
  • Development setup and testing
  • Code organization and standards

Quick Start Guide

Get started immediately with:

  • Installation instructions
  • Basic examples and tutorials
  • Common use cases
  • Troubleshooting tips

📋 Standalone Installation

Info about installation:

  • Requirements
  • Installation instructions
  • Environment Variables
  • GPU Support

Roadmap

A detailed Roadmap can be found following the Roadmap Link

TL;DR

Pre-1.0: Enhanced model quality, flexible architectures, advanced evaluation metrics, and expansion to images/text generation with auto hyperparameter tuning.

Post-1.0: Production-ready stability, mixed data types, intelligent automation, cloud integration, and advanced AI capabilities including federated learning and quantum computing exploration.

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

📄 License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.

🙏 Acknowledgments

  • Built with TensorFlow and Keras for deep learning models
  • Statistical evaluation using scipy and numpy
  • Inspired by state-of-the-art synthetic data generation research

📞 Support


GENESIS Core Lib - Generating Tomorrow's Data, Today 🚀

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sdg_core_lib-0.1.10.dev0.tar.gz (36.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sdg_core_lib-0.1.10.dev0-py3-none-any.whl (66.7 kB view details)

Uploaded Python 3

File details

Details for the file sdg_core_lib-0.1.10.dev0.tar.gz.

File metadata

  • Download URL: sdg_core_lib-0.1.10.dev0.tar.gz
  • Upload date:
  • Size: 36.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for sdg_core_lib-0.1.10.dev0.tar.gz
Algorithm Hash digest
SHA256 70fe8383be8539f3d725a3d3136b3b0da20d96963b6044ab57357d2422aa10b0
MD5 3079de3f7a1d53a871b317e2af04ecb8
BLAKE2b-256 2839d1649e29fed51c5411241ad26e9092ff888d84e6855a5a14e6e047b5bc0d

See more details on using hashes here.

File details

Details for the file sdg_core_lib-0.1.10.dev0-py3-none-any.whl.

File metadata

  • Download URL: sdg_core_lib-0.1.10.dev0-py3-none-any.whl
  • Upload date:
  • Size: 66.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for sdg_core_lib-0.1.10.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 cca348a3f5d10e17f0fca25246687c307a7149d08775a9a53ec7bbb76e27e501
MD5 60fa0d034a923799cd1d56d6cc48f844
BLAKE2b-256 e9a35f38b7248205174807e67a6999ad3983e0485156f3ff09b41707b77b97cd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page