Skip to content

Commit 9427973

Browse files
docs: fix requirements and minor changes (#355)
fix requirements and minor changes
1 parent 9bf18bd commit 9427973

6 files changed

Lines changed: 24 additions & 20 deletions

File tree

docs/getting-started/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ However, it was not optimized for the quality, performance, and scalability need
3030

3131
Additionally, tabular data usually comprises both *numeric* and *categorical* features. **Numeric** features are those that encode **quantitative** values, whereas **categorical** represent **qualitative** measurements. Categorical features can further divided in *ordinal*, *binary* or *boolean*, and *nominal* features.
3232

33-
Learn more about synthesizing tabular data in this [article](https://ydata.ai/resources/gans-for-synthetic-data-generation), or check the [quickstart guide](getting-started/quickstart.md#synthesizing-a-tabular-dataset) to get started with the synthesization of tabular datasets.
33+
Learn more about synthesizing tabular data in this [article](https://ydata.ai/resources/gans-for-synthetic-data-generation), or check the [quickstart guide](/synthetic_data/single_table/ctgan_example) to get started with the synthesization of tabular datasets.
3434

3535
=== "Time-Series Data"
3636
**Time-series data** exhibit a sequencial, **temporal dependency** between records, and may present a wide range of patterns and trends, including **seasonality** (patterns that repeat at calendar periods -- days, weeks, months -- such as holiday sales, for instance) or **periodicity** (patterns that repeat over time).
3737

38-
Read more about generating [time-series data in this article](https://ydata.ai/resources/synthetic-time-series-data-a-gan-approach) and check this [quickstart guide](getting-started/quickstart.md#synthesizing-a-time-series-dataset) to get started with time-series data synthesization.
38+
Read more about generating [time-series data in this article](https://ydata.ai/resources/synthetic-time-series-data-a-gan-approach) and check this [quickstart guide](/synthetic_data/time_series/timegan_example) to get started with time-series data synthesization.
3939

4040
=== "Multi-Table Data"
4141
**Multi-Table data** or databases exhibit a referential behaviour between and database schema that is expected to be replicated and respected by the synthetic data generated.
42-
Read more about database [synthetic data generation in this article]() and check this [quickstart guide for Multi-Table synthetic data generation]()
42+
Read more about database [synthetic data generation in this article](https://ydata.ai/resources/whitepaper-relational-databases-synthetic-data) and check this [video guide for Multi-Table synthetic data generation](https://www.youtube.com/watch?v=40Q56xZbv00&ab_channel=YData)
4343
**Time-series data** exhibit a sequential, **temporal dependency** between records, and may present a wide range of patterns and trends, including **seasonality** (patterns that repeat at calendar periods -- days, weeks, months -- such as holiday sales, for instance) or **periodicity** (patterns that repeat over time).
4444

4545
## Validate the quality of your synthetic data generated

docs/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@
1212
Heading towards the future of synthetic data generation we recommend everyone to transition to [ydata-sdk](https://docs.sdk.ydata.ai/latest/), which provides a superior experience with enhanced performance, precision, and ease of use, making it the preferred tool for synthetic data generation and a perfect introduction to Generative AI.
1313

1414

15-
### Older version with open-source models
16-
[Check the deprecated documentation](docs/getting-started/index.md)
15+
16+
17+
18+
19+
#### Older version with open-source models
20+
Check the deprecated documentation [here](getting-started/index.md).
1721

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

docs/support/help-troubleshooting.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
If you are just starting, or you are dealing with something new we are always eager to help!
1313

14-
Join us in the [Data-Centric AI community Discord](https://discord.com/invite/mw7xjJ7b7s), we have a space reserved for all your questions about Synthetic Data! Don't be shy 😳
14+
Join us in the [Data-Centric AI community Discord](https://discord.com/invite/mw7xjJ7b7s), we have a space reserved for all your questions about Synthetic Data!
15+
16+
Don't be shy! 😳
1517

1618
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dd69a9f9-0901-4cb4-9e56-b1e69877dca1" />
Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,4 @@ These KPIs, such as data fidelity and privacy scores, are displayed on the dashb
2222
Users have access to advanced settings, such as [conditional synthetic data generation](https://ydata.ai/resources/conditional-synthetic-data-generation-for-robust-machine-learning-applications) or business rules.
2323
- **Preserving Data Integrity:** For datasets requiring strict adherence to structural patterns (e.g., time-series data, healthcare records or databases).
2424

25-
### Getting started with YData Fabric (Community version)
26-
YData Fabric’s Community Version offers users a free, accessible entry point to explore synthetic data generation.
27-
To get started, users can [sign up for the Community Version and access the guided UI directly](https://ydata.ai/register).
28-
Once registered, users are provided with a range of features, including data profiling, synthetic data generation, pipelines and access to YData’s proprietary models for data quality!
25+
[Reach out to the YData team](https://ydata.ai/contact-us) to learn more about YData Fabric.

mkdocs.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@ edit_uri: ""
55
dev_addr: 0.0.0.0:1234
66
site_dir: "static/docs"
77
nav:
8-
- Getting started:
9-
- 'index.md'
8+
- Getting started: 'index.md'
9+
- YData Fabric (GUI): "ydata_fabric_app.md"
1010
- Older versions:
11-
- 'getting-started/index.md'
12-
- Overview: 'index.md'
11+
- Overview: 'getting-started/index.md'
1312
- Installation: 'getting-started/installation.md'
1413
- Synthetic Data Generation:
1514
- "synthetic_data/index.md"
16-
- UI interface - YData Fabric: "synthetic_data/ydata_fabric_app.md"
15+
1716
- Generate Single Table:
1817
- GMM: "synthetic_data/single_table/gmm_example.md"
1918
- CGAN: "synthetic_data/single_table/cgan_example.md"

requirements-docs.txt

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
mkdocs==1.5.3
2-
mkdocs-material==9.0.9
3-
mkdocs-material-extensions==1.1.1
4-
mike==1.1.2
5-
mkdocstrings[python]==0.24.0
1+
mkdocs==1.6.*
2+
mkdocs-material==9.6.*
3+
mkdocs-material-extensions==1.3.*
4+
mkdocs-table-reader-plugin==3.1.*
5+
mike==2.1.*
6+
mkdocstrings[python]==0.27.*
7+
mkdocs-badges==0.4.*

0 commit comments

Comments
 (0)