DataDesigner/mkdocs.yml
Johnny Greco ae0665fa16
refactor: slim package refactor into three subpackages (#240)
* remove old structure

* major shuffle

* streamline project configs

* update make commands

* updates to make commands

* remove essentials

* initialize logger in interface

* uv lock

* ignore notepad

* update workflows

* fix e2e project config

* generate colab notebooks

* resolve default model settings in interface

* fix build commands

* update perf import make command

* cleaning up some slop

* update recipes

* move conftest files to tests/

* update subpackage readmes

* streamline config_logging

* use exports

* update perf import usage pattern

* update for IDE behavior with ruff

* remove engine's fixtures file

* add note to about lazy imports

* update dependencies

* update docs

* doc fixes

* uv lock

* updates to catch up with main

* clean up makefile

* remove package gitignores

* define deps only once

* isolate tests

* add test for protetion rule

* create temp dirs for isolated tests

* catch up to main

* update headers

* re apply changes

* better result summaries for isolated tests

* move exports into top-level init

* fix client importlib version syntax

* catch up with main
2026-01-27 13:53:20 -05:00

151 lines
4.8 KiB
YAML

site_name: NeMo Data Designer
site_url: https://nvidia-nemo.github.io/DataDesigner/
repo_url: https://github.com/NVIDIA-NeMo/DataDesigner
nav:
- Getting Started:
- Welcome: index.md
- Installation: installation.md
- Quick Start: quick-start.md
- Contributing: CONTRIBUTING.md
- Concepts:
- Models:
- Default Model Settings: concepts/models/default-model-settings.md
- Custom Model Settings: concepts/models/custom-model-settings.md
- Configure with the CLI: concepts/models/configure-model-settings-with-the-cli.md
- Model Providers: concepts/models/model-providers.md
- Model Configs: concepts/models/model-configs.md
- Inference Parameters: concepts/models/inference-parameters.md
- Columns: concepts/columns.md
- Validators: concepts/validators.md
- Processors: concepts/processors.md
- Person Sampling: concepts/person_sampling.md
- Tutorials:
- Overview: notebooks/README.md
- The Basics: notebooks/1-the-basics.ipynb
- Structured Outputs and Jinja Expressions: notebooks/2-structured-outputs-and-jinja-expressions.ipynb
- Seeding with an External Dataset: notebooks/3-seeding-with-a-dataset.ipynb
- Providing Images as Context: notebooks/4-providing-images-as-context.ipynb
- Recipes:
- Recipe Cards: recipes/cards.md
- Code Generation:
- Text to Python: recipes/code_generation/text_to_python.md
- Text to SQL: recipes/code_generation/text_to_sql.md
- QA and Chat:
- Product Info QA: recipes/qa_and_chat/product_info_qa.md
- Multi-Turn Chat: recipes/qa_and_chat/multi_turn_chat.md
- Plugins:
- Overview: plugins/overview.md
- Example Plugin: plugins/example.md
- Available Plugin List: plugins/available.md
- Code Reference:
- models: code_reference/models.md
- column_configs: code_reference/column_configs.md
- config_builder: code_reference/config_builder.md
- data_designer_config: code_reference/data_designer_config.md
- run_config: code_reference/run_config.md
- sampler_params: code_reference/sampler_params.md
- validator_params: code_reference/validator_params.md
- processors: code_reference/processors.md
- analysis: code_reference/analysis.md
theme:
name: material
custom_dir: docs/overrides
font:
text: Roboto
code: Fira Code
icon:
logo: fontawesome/solid/palette
repo: fontawesome/brands/github-alt
favicon: assets/palette-favicon.png
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- navigation.tabs
- navigation.expand
- navigation.path
- navigation.footer
- content.code.copy
- content.code.select
- content.code.annotate
extra:
version:
provider: mike
alias: true
default: latest
watch:
- packages/data-designer-config/src/data_designer
- packages/data-designer-engine/src/data_designer
- packages/data-designer/src/data_designer
- docs/
plugins:
- search
- mike:
alias_type: symlink
canonical_version: latest
- mkdocs-jupyter:
execute: false
include_requirejs: true
ignore_h1_titles: True
include_source: True
ignore:
- "assets/recipes/**/*.py"
- mkdocstrings:
handlers:
python:
paths:
- packages/data-designer-config/src
- packages/data-designer-engine/src
- packages/data-designer/src
options:
show_symbol_type_heading: true
show_symbol_type_toc: true
show_root_toc_entry: true
show_object_full_path: false
filters: ["!^_"]
docstring_options:
ignore_init_summary: false
merge_init_into_class: true
docstring_section_style: table
summary: true
extra_css:
- css/style.css
- css/mkdocstrings.css
extra_javascript:
- js/toc-toggle.js
markdown_extensions:
- tables
- pymdownx.superfences
- attr_list
- md_in_html
- admonition
- pymdownx.snippets:
base_path:
- docs/
- .
- pymdownx.highlight:
pygments_lang_class: true
use_pygments: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg