Skip to content

Commit 14dc495

Browse files
authored
docs: some documentation cleanup (#52)
* some documentation cleanup * typo
1 parent 362ec51 commit 14dc495

File tree

4 files changed

+13
-12
lines changed

4 files changed

+13
-12
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Whether you're new to the project or ready to dive in, the resources below will
2727

2828
2. **[AGENTS.md](https://github.com/NVIDIA-NeMo/DataDesigner/blob/main/AGENTS.md)** – context and instructions to help AI coding agents work on Data Designer (it's also useful for human developers!)
2929

30-
3. **[Documentation](https://github.com/NVIDIA-NeMo/DataDesigner/blob/main/docs/)** – detailed documentation on Data Designer's capabilities and usage
30+
3. **[Documentation](https://nvidia-nemo.github.io/DataDesigner/)** – detailed documentation on Data Designer's capabilities and usage
3131

3232
## Ways to Contribute
3333

@@ -40,7 +40,7 @@ Found a bug? Before reporting, please
4040
2. Search for duplicates in the [issue tracker](https://github.com/NVIDIA-NeMo/DataDesigner/issues)
4141

4242
When [creating a bug report](https://github.com/NVIDIA-NeMo/DataDesigner/issues/new), please include:
43-
- Data Designer version: `python -c "import data_designer; print(data_designer.__version__)"`
43+
- Data Designer version
4444
- Python version and operating system
4545
- Minimal reproducible example
4646
- Expected vs. actual behavior

docs/concepts/persons.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Each personality trait contains:
194194

195195
## Person Sampling with Faker
196196

197-
If you do not have access to Data Designer's managed Nemotron-Personas datasets or you need locale that is not covered, Data Designer provides a Faker-based person sampler (`sampler_type="person_from_faker"`) that uses the [Faker library](https://faker.readthedocs.io/en/stable/) to generate person data.
197+
If you do not have access to Data Designer's managed Nemotron-Personas datasets or you need a locale that is not covered by Nemotron-Personas, Data Designer provides a Faker-based person sampler (`sampler_type="person_from_faker"`) that uses the [Faker library](https://faker.readthedocs.io/en/stable/) to generate person data.
198198

199199
**Important:** This sampler generates random personal details that are **not grounded in real-world demographic data**. It's best suited for testing, prototyping, or when you need basic person attributes in locales not yet covered by Nemotron-Personas.
200200

docs/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,20 @@ Data Designer helps you create datasets through an intuitive, **iterative** proc
2525
1. **⚙️ Configure** your model settings
2626
- Bring your own OpenAI-compatible model providers and models
2727
- Or use the default model providers and models to get started quickly
28-
- Learn more by reading the [model configuration docs](does-not-exist.md)
28+
- Learn more by reading the [model docs](models/default-model-settings.md)
2929
2. **🏗️ Design** your dataset
3030
- Iteratively design your dataset, column by column
3131
- Leverage tools like statistical samplers and LLMs to generate a variety of data types
32-
- Learn more by reading the [column docs](concepts/columns.md) and checking out the [tutorial notebooks](notebooks/1-the-basics.ipynb)
32+
- Learn more by reading the [column docs](concepts/columns.md)
33+
3334
3. **🔁 Preview** your results and iterate
3435
- Generate a preview dataset stored in memory for fast iteration
3536
- Inspect sample records and analysis results to refine your configuration
36-
- Try for yourself by running the [tutorial notebooks](notebooks/1-the-basics.ipynb)
37+
- Try for yourself by running the [tutorial notebooks](notebooks/intro.md)
3738
4. **🖼️ Create** your dataset
3839
- Generate your full dataset and save results to disk
3940
- Access the generated dataset and associated artifacts for downstream use
40-
- Give it a try by running the [tutorial notebooks](notebooks/2-create-your-dataset.ipynb)!
41+
- Give it a try by running the [tutorial notebooks](notebooks/intro.md)
4142

4243
## Library and Microservice
4344

mkdocs.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ nav:
1212
- Validators: concepts/validators.md
1313
- Persons: concepts/persons.md
1414
# - Plugins: concepts/plugins.md
15-
- Tutorials:
16-
- Overview: notebooks/intro.md
17-
- The Basics: notebooks/1-the-basics.ipynb
18-
- Structured Outputs and Jinja Expressions: notebooks/2-structured-outputs-and-jinja-expressions.ipynb
19-
- Seeding with an External Dataset: notebooks/3-seeding-with-a-dataset.ipynb
2015
- Models:
2116
- Default Model Settings: models/default-model-settings.md
2217
- Configure with the CLI: models/configure-model-settings-with-the-cli.md
2318
- Model Providers: models/model-providers.md
2419
- Model Configs: models/model-configs.md
20+
- Tutorials:
21+
- Overview: notebooks/intro.md
22+
- The Basics: notebooks/1-the-basics.ipynb
23+
- Structured Outputs and Jinja Expressions: notebooks/2-structured-outputs-and-jinja-expressions.ipynb
24+
- Seeding with an External Dataset: notebooks/3-seeding-with-a-dataset.ipynb
2525
- Code Reference:
2626
- column_configs: code_reference/column_configs.md
2727
- config_builder: code_reference/config_builder.md

0 commit comments

Comments
 (0)