Metadata-Version: 2.1
Name: clearbox-synthetic-kit
Version: 0.6.2
Summary: Clearbox AI's all-in-one solution for generation and evaluation of synthetic tabular and time-series data.
Home-page: https://github.com/Clearbox-AI/clearbox-synthetic-kit
Author: Clearbox AI
Author-email: info@clearbox.ai
Requires-Python: >=3.9.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: diffrax
Requires-Dist: equinox
Requires-Dist: jax==0.4.30
Requires-Dist: flax==0.8.5
Requires-Dist: numpy<2.0.0
Requires-Dist: pydantic
Requires-Dist: typing
Requires-Dist: pandas
Requires-Dist: loguru
Requires-Dist: dateparser
Requires-Dist: pydateinfer
Requires-Dist: pytest
Requires-Dist: pytest-cov
Requires-Dist: pytest-lazy-fixture
Requires-Dist: scikit-learn
Requires-Dist: cython
Requires-Dist: xgboost
Requires-Dist: optax
Requires-Dist: tqdm
Requires-Dist: requests
Requires-Dist: sphinx-rtd-theme
Requires-Dist: myst-parser

[![Documentation Status](https://readthedocs.org/projects/clearbox-synthetic-kit/badge/?version=latest)](https://clearbox-synthetic-kit.readthedocs.io/en/latest/?badge=latest)
![PyPI Version](https://img.shields.io/pypi/v/clearbox-synthetic-kit.svg?cache-bust=1)
[![Downloads](https://pepy.tech/badge/clearbox-synthetic-kit?cache-bust=1)](https://pepy.tech/project/clearbox-synthetic-kit)
[![GitHub stars](https://img.shields.io/github/stars/Clearbox-AI/clearbox-synthetic-kit?style=social)](https://github.com/Clearbox-AI/clearbox-synthetic-kit)

<img src="docs/source/img/cb_purple_logo.png" width="450">

# Clearbox Synthetic Kit
### The synthetic data generation library.

Clearbox AI's all-in-one solution for generation and evaluation of synthetic **tabular** and **time-series** data.

In addition to its data generation modules, Clearbox Synthetic Kit includes a high-speed preprocessing module to prepare data for training, as well as an evaluation package designed to assess the informative content and, when necessary, the privacy level of synthetic data.

## Installation

```shell
$ pip install clearbox-synthetic-kit
```

## Try it out
Get a quick overview of the generation and evaluation process with Clearbox Synthetic Kit.

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Clearbox-AI/clearbox-synthetic-kit/blob/main/examples/tabular_data_generation.ipynb)

Find other examples [here](https://github.com/Clearbox-AI/clearbox-synthetic-kit/tree/main/examples).


---

### References
* Using Cython to protect a Python codebase [[Link](https://bucharjan.cz/blog/using-cython-to-protect-a-python-codebase.html)]
* Package only binary compiled so files of a python library compiled with Cython [[Link](https://stackoverflow.com/questions/39499453/package-only-binary-compiled-so-files-of-a-python-library-compiled-with-cython)]
* Distributing python packages protected with Cython [[Link](https://medium.com/swlh/distributing-python-packages-protected-with-cython-40fc29d84caf)]
* The time series generation features a modified version of TimeVQVAE [[Link](https://github.com/ML4ITS/TimeVQVAE)]

---

### Contacts
<img src="https://github.com/Clearbox-AI/clearbox-synthetic-kit/blob/main/docs/source/img/email.svg" alt="Email" width="20" height="20"> &nbsp; &#8203;`info@clearbox.ai`

<img src="https://github.com/Clearbox-AI/clearbox-synthetic-kit/blob/main/docs/source/img/website.svg" alt="Website" width="20" height="20">&nbsp; <a href="https://clearbox.ai" target="_blank">`https://clearbox.ai`</a>
