Skip to content

Commit 5139457

Browse files
fabclmntfabiana
andauthored
feat: Update Regular synthesizers interface (#182)
* feat: Add singular caller for the synthesizers. * feat: Update CWGANGP example. Add bigger conditional vector. * chore: Update DRAGAN example. * chore: Update Cramer and Dragan examples. * fix: Upadte fit method for the synthesizer architectures * chore: Organize examples folder. * fix: Fix data path examples. * fix: Sampling from conditional architectures. * chore: Update cramergan example. * fix: Remove unused imports. * chore: Improve readme Co-authored-by: fabiana <fabiana@pop-os.localdomain>
1 parent 78f4e3c commit 5139457

24 files changed

Lines changed: 525 additions & 1774 deletions

File tree

README.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,24 @@
99

1010
Join us on [![slack](https://img.shields.io/badge/slack-brightgreen.svg?logo=slack)](http://slack.ydata.ai/)
1111

12-
# What is Synthetic Data?
12+
# YData Synthetic
13+
A package to generate synthetic tabular and time-series data leveraging the state of the art generative models.
14+
## Synthetic data
15+
### What is synthetic data?
1316
Synthetic data is artificially generated data that is not collected from real world events. It replicates the statistical components of real data without containing any identifiable information, ensuring individuals' privacy.
1417

15-
# Why Synthetic Data?
18+
### Why Synthetic Data?
1619
Synthetic data can be used for many applications:
17-
- Privacy
18-
- Remove bias
19-
- Balance datasets
20-
- Augment datasets
20+
- Privacy
21+
- Remove bias
22+
- Balance datasets
23+
- Augment datasets
2124

2225
# ydata-synthetic
2326
This repository contains material related with Generative Adversarial Networks for synthetic data generation, in particular regular tabular data and time-series.
2427
It consists a set of different GANs architectures developed using Tensorflow 2.0. Several example Jupyter Notebooks and Python scripts are included, to show how to use the different architectures.
2528

26-
# Quickstart
29+
## Quickstart
2730

2831
The source code is currently hosted on GitHub at: https://github.com/ydataai/ydata-synthetic
2932

@@ -32,12 +35,11 @@ Binary installers for the latest released version are available at the [Python P
3235
pip install ydata-synthetic
3336
```
3437

35-
## Examples
38+
### Examples
3639
Here you can find usage examples of the package and models to synthesize tabular data.
37-
38-
- Synthesizing the minority class with VanillaGAN on credit fraud dataset [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ydataai/ydata-synthetic/blob/master/examples/regular/gan_example.ipynb)
39-
- Time Series synthetic data generation with TimeGAN on stock dataset [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ydataai/ydata-synthetic/blob/master/examples/timeseries/TimeGAN_Synthetic_stock_data.ipynb)
40-
- More examples are continously added and can be found in `/examples` directory.
40+
- Synthesizing the minority class with VanillaGAN on credit fraud dataset [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ydataai/ydata-synthetic/blob/master/examples/regular/gan_example.ipynb)
41+
- Time Series synthetic data generation with TimeGAN on stock dataset [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ydataai/ydata-synthetic/blob/master/examples/timeseries/TimeGAN_Synthetic_stock_data.ipynb)
42+
- More examples are continously added and can be found in `/examples` directory.
4143

4244
### Datasets for you to experiment
4345
Here are some example datasets for you to try with the synthesizers:
@@ -50,30 +52,30 @@ Here are some example datasets for you to try with the synthesizers:
5052
- [Stock data](https://github.com/ydataai/ydata-synthetic/tree/master/data)
5153

5254

53-
# Project Resources
55+
## Project Resources
5456

5557
In this repository you can find the several GAN architectures that are used to create synthesizers:
5658

57-
#### Tabular data
58-
- [GAN](https://arxiv.org/abs/1406.2661)
59-
- [CGAN (Conditional GAN)](https://arxiv.org/abs/1411.1784)
60-
- [WGAN (Wasserstein GAN)](https://arxiv.org/abs/1701.07875)
61-
- [WGAN-GP (Wassertein GAN with Gradient Penalty)](https://arxiv.org/abs/1704.00028)
62-
- [DRAGAN (On Convergence and stability of GANS)](https://arxiv.org/pdf/1705.07215.pdf)
63-
- [Cramer GAN (The Cramer Distance as a Solution to Biased Wasserstein Gradients)](https://arxiv.org/abs/1705.10743)
64-
- [CWGAN-GP (Conditional Wassertein GAN with Gradient Penalty)](https://cameronfabbri.github.io/papers/conditionalWGAN.pdf)
59+
### Tabular data
60+
- [GAN](https://arxiv.org/abs/1406.2661)
61+
- [CGAN (Conditional GAN)](https://arxiv.org/abs/1411.1784)
62+
- [WGAN (Wasserstein GAN)](https://arxiv.org/abs/1701.07875)
63+
- [WGAN-GP (Wassertein GAN with Gradient Penalty)](https://arxiv.org/abs/1704.00028)
64+
- [DRAGAN (On Convergence and stability of GANS)](https://arxiv.org/pdf/1705.07215.pdf)
65+
- [Cramer GAN (The Cramer Distance as a Solution to Biased Wasserstein Gradients)](https://arxiv.org/abs/1705.10743)
66+
- [CWGAN-GP (Conditional Wassertein GAN with Gradient Penalty)](https://cameronfabbri.github.io/papers/conditionalWGAN.pdf)
6567

66-
#### Sequential data
67-
- [TimeGAN](https://papers.nips.cc/paper/2019/file/c9efe5f26cd17ba6216bbe2a7d26d490-Paper.pdf)
68+
### Sequential data
69+
- [TimeGAN](https://papers.nips.cc/paper/2019/file/c9efe5f26cd17ba6216bbe2a7d26d490-Paper.pdf)
6870

69-
# Contributing
71+
## Contributing
7072
We are open to collaboration! If you want to start contributing you only need to:
71-
1. Search for an issue in which you would like to work. Issues for newcomers are labeled with good first issue.
72-
2. Create a PR solving the issue.
73-
3. We would review every PRs and either accept or ask for revisions.
73+
1. Search for an issue in which you would like to work. Issues for newcomers are labeled with good first issue.
74+
2. Create a PR solving the issue.
75+
3. We would review every PRs and either accept or ask for revisions.
7476

75-
# Support
77+
## Support
7678
For support in using this library, please join the #help Slack channel. The Slack community is very friendly and great about quickly answering questions about the use and development of the library. [Click here to join our Slack community!](http://slack.ydata.ai/)
7779

78-
# License
80+
## License
7981
[MIT License](https://github.com/ydataai/ydata-synthetic/blob/master/LICENSE)
File renamed without changes.

0 commit comments

Comments
 (0)