Skip to content

Commit

Permalink
docs: update doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
Fabiana Clemente authored and fabclmnt committed May 7, 2024
1 parent 57e0f23 commit 251facc
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 4 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=ab07c7a0-c1ee-481e-9368-baf70185cf40" />

<p align="center"><img width="300" src="https://assets.ydata.ai/oss/ydata-synthetic_black.png" alt="YData Synthetic Logo"></p>

Expand Down
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,6 @@ mkdocs build
To build and serve locally:
```
mkdocs serve
```
```

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dd69a9f9-0901-4cb4-9e56-b1e69877dca1" />
2 changes: 2 additions & 0 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dd69a9f9-0901-4cb4-9e56-b1e69877dca1" />

4 changes: 3 additions & 1 deletion docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
: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

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dd69a9f9-0901-4cb4-9e56-b1e69877dca1" />
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dd69a9f9-0901-4cb4-9e56-b1e69877dca1" />
2 changes: 1 addition & 1 deletion docs/integrations/gx_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@ And use the following code to view an HTML representation of the Validation resu
context.view_validation_result(checkpoint_result)
```


<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dd69a9f9-0901-4cb4-9e56-b1e69877dca1" />
2 changes: 1 addition & 1 deletion docs/support/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ environment variable to `True`.
os.environ['YDATA_SYNTHETIC_NO_ANALYTICS']='True'
````


<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dd69a9f9-0901-4cb4-9e56-b1e69877dca1" />


2 changes: 2 additions & 0 deletions docs/support/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dd69a9f9-0901-4cb4-9e56-b1e69877dca1" />
2 changes: 2 additions & 0 deletions docs/support/help-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 😳

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dd69a9f9-0901-4cb4-9e56-b1e69877dca1" />

0 comments on commit 251facc

Please sign in to comment.