diff --git a/README.md b/README.md index a8776989..c022af6c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ ![](https://img.shields.io/badge/python-3.9%20%7C%203.10-blue) [![](https://img.shields.io/pypi/v/ydata-synthetic)](https://pypi.org/project/ydata-synthetic/) ![](https://img.shields.io/github/license/ydataai/ydata-synthetic) +

YData Synthetic Logo

diff --git a/docs/README.md b/docs/README.md index 4fca7389..9d64983d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,4 +13,6 @@ mkdocs build To build and serve locally: ``` mkdocs serve -``` \ No newline at end of file +``` + + \ No newline at end of file diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 2ef844ec..d633f51d 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -42,3 +42,5 @@ pip install "ydata-synthetic[streamlit]" Note that Jupyter or Colab Notebooks are not yet supported, so use it in your Python environment. + + diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index d6c97ad0..3814bb39 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -73,4 +73,6 @@ Once the package is [installed](installation.md) with the "streamlit" extra, the The console will then output the URL from which the app can be accessed. -:fontawesome-brands-youtube:{ style="color: #EE0F0F" } Here's a [quick example](https://www.youtube.com/watch?v=6Lzi26szKNo&t=4s) of how to synthesize data with the Streamlit App – :octicons-clock-24: 5min \ No newline at end of file +:fontawesome-brands-youtube:{ style="color: #EE0F0F" } Here's a [quick example](https://www.youtube.com/watch?v=6Lzi26szKNo&t=4s) of how to synthesize data with the Streamlit App – :octicons-clock-24: 5min + + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 4bea54ac..a95ff9ac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -57,3 +57,5 @@ The following architectures are currently supported: - [CTGAN](https://arxiv.org/pdf/1907.00503.pdf) (Conditional Tabular GAN) - [TimeGAN](https://papers.nips.cc/paper/2019/file/c9efe5f26cd17ba6216bbe2a7d26d490-Paper.pdf) (specifically for *time-series* data) - [DoppelGANger](https://dl.acm.org/doi/pdf/10.1145/3419394.3423643) (specifically for *time-series* data) + + \ No newline at end of file diff --git a/docs/integrations/gx_integration.md b/docs/integrations/gx_integration.md index 34a52265..fb87614f 100644 --- a/docs/integrations/gx_integration.md +++ b/docs/integrations/gx_integration.md @@ -104,4 +104,4 @@ And use the following code to view an HTML representation of the Validation resu context.view_validation_result(checkpoint_result) ``` - + diff --git a/docs/support/analytics.md b/docs/support/analytics.md index 6a4955e9..991ade44 100644 --- a/docs/support/analytics.md +++ b/docs/support/analytics.md @@ -39,6 +39,6 @@ environment variable to `True`. os.environ['YDATA_SYNTHETIC_NO_ANALYTICS']='True' ```` - + diff --git a/docs/support/contribute.md b/docs/support/contribute.md index 2145311d..d85cc367 100644 --- a/docs/support/contribute.md +++ b/docs/support/contribute.md @@ -18,3 +18,5 @@ For the commit messages, if you could please read this [commit-message guideline If you need help figuring out where to start or want to learn what other contributors are doing, go to the [Data-Centric AI community Discord](https://discord.com/invite/mw7xjJ7b7s) channel and introduce yourself in the #ydata-synthetic channel. If you can't find an issue that interests you and wants to add an improvement or change, create a new one. + + \ No newline at end of file diff --git a/docs/support/help-troubleshooting.md b/docs/support/help-troubleshooting.md index cf2dbbb8..c576cf13 100644 --- a/docs/support/help-troubleshooting.md +++ b/docs/support/help-troubleshooting.md @@ -13,3 +13,5 @@ If you are just starting, or you are dealing with something new we are always eager to help! Join us in the [Data-Centric AI community Discord](https://discord.com/invite/mw7xjJ7b7s), we have a space reserved for all your questions about **ydata-synthetic**! Don't be shy 😳 + + \ No newline at end of file