docs: move models docs to concepts > models (#93)

nabinchha · web-flow · commit 8e3080241bd0 · 2025-12-03T14:10:01.000-07:00
diff --git a/README.md b/README.md
@@ -99,7 +99,7 @@ preview.display_sample_record()
 - **[Tutorial Notebooks](https://nvidia-nemo.github.io/DataDesigner/notebooks/)** – Step-by-step interactive tutorials
 - **[Column Types](https://nvidia-nemo.github.io/DataDesigner/concepts/columns/)** – Explore samplers, LLM columns, validators, and more
 - **[Validators](https://nvidia-nemo.github.io/DataDesigner/concepts/validators/)** – Learn how to validate generated data with Python, SQL, and remote validators
-- **[Model Configuration](https://nvidia-nemo.github.io/DataDesigner/models/model-configs/)** – Configure custom models and providers
+- **[Model Configuration](https://nvidia-nemo.github.io/DataDesigner/concepts/models/model-configs/)** – Configure custom models and providers
 - **[Person Sampling](https://nvidia-nemo.github.io/DataDesigner/concepts/person_sampling/)** – Learn how to sample realistic person data with demographic attributes
 
 ### 🔧 Configure models via CLI
diff --git a/docs/concepts/models/configure-model-settings-with-the-cli.md b/docs/concepts/models/configure-model-settings-with-the-cli.md
@@ -132,4 +132,4 @@ The CLI will show which configuration files exist and ask for confirmation befor
 - **[Model Providers](model-providers.md)**: Learn about the `ModelProvider` class and provider configuration
 - **[Model Configurations](model-configs.md)**: Learn about `ModelConfig` and `InferenceParameters`
 - **[Default Model Settings](default-model-settings.md)**: Pre-configured providers and model settings included with Data Designer
-- **[Quick Start Guide](../quick-start.md)**: Get started with a simple example
+- **[Quick Start Guide](../../quick-start.md)**: Get started with a simple example
diff --git a/docs/concepts/models/default-model-settings.md b/docs/concepts/models/default-model-settings.md
@@ -91,5 +91,5 @@ Both methods operate on the same files, ensuring consistency across your entire
 ## See Also
 
 - **[Configure Model Settings With the CLI](configure-model-settings-with-the-cli.md)**: Learn how to use the CLI to manage model settings.
-- **[Quick Start Guide](../quick-start.md)**: Get started with a simple example
+- **[Quick Start Guide](../../quick-start.md)**: Get started with a simple example
 - **[Model Configurations](model-configs.md)**: Learn about model configurations
diff --git a/docs/concepts/models/model-configs.md b/docs/concepts/models/model-configs.md
@@ -241,4 +241,4 @@ model_config = ModelConfig(
 - **[Model Providers](model-providers.md)**: Learn about configuring model providers
 - **[Default Model Settings](default-model-settings.md)**: Pre-configured model settings included with Data Designer
 - **[Configure Model Settings With the CLI](configure-model-settings-with-the-cli.md)**: Use the CLI to manage model settings
-- **[Column Configurations](../code_reference/column_configs.md)**: Learn how to use models in column configurations
+- **[Column Configurations](../../code_reference/column_configs.md)**: Learn how to use models in column configurations
diff --git a/docs/concepts/models/model-providers.md b/docs/concepts/models/model-providers.md
@@ -47,4 +47,4 @@ provider = ModelProvider(
 - **[Model Configurations](model-configs.md)**: Learn about configuring models and inference parameters
 - **[Default Model Settings](default-model-settings.md)**: Pre-configured providers and model settings included with Data Designer
 - **[Configure Model Settings With the CLI](configure-model-settings-with-the-cli.md)**: Use the CLI to manage providers and model settings
-- **[Quick Start Guide](../quick-start.md)**: Get started with a simple example
+- **[Quick Start Guide](../../quick-start.md)**: Get started with a simple example
diff --git a/docs/index.md b/docs/index.md
@@ -25,7 +25,7 @@ Data Designer helps you create datasets through an intuitive, **iterative** proc
 1.  **⚙️ Configure** your model settings
     - Bring your own OpenAI-compatible model providers and models
     - Or use the default model providers and models to get started quickly
-    - Learn more by reading the [model docs](models/default-model-settings.md)
+    - Learn more by reading the [model docs](concepts/models/default-model-settings.md)
 2.  **🏗️ Design** your dataset
     - Iteratively design your dataset, column by column
     - Leverage tools like statistical samplers and LLMs to generate a variety of data types
diff --git a/docs/notebook_source/1-the-basics.py b/docs/notebook_source/1-the-basics.py
@@ -46,7 +46,7 @@
 #
 # - `DataDesigner` is the main object is responsible for managing the data generation process.
 #
-# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) are used.
+# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) are used.
 #
 
 # %%
@@ -59,7 +59,7 @@
 #
 # - The "model alias" is used to reference the model in the Data Designer config (as we will see below).
 #
-# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) docs for more details).
+# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) docs for more details).
 #
 # - By default, we use [build.nvidia.com](https://build.nvidia.com/models) as the model provider.
 #
diff --git a/docs/notebook_source/2-structured-outputs-and-jinja-expressions.py b/docs/notebook_source/2-structured-outputs-and-jinja-expressions.py
@@ -48,7 +48,7 @@
 #
 # - `DataDesigner` is the main object that is used to interface with the library.
 #
-# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) are used.
+# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) are used.
 #
 
 # %%
@@ -61,7 +61,7 @@
 #
 # - The "model alias" is used to reference the model in the Data Designer config (as we will see below).
 #
-# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) docs for more details).
+# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) docs for more details).
 #
 # - By default, we use [build.nvidia.com](https://build.nvidia.com/models) as the model provider.
 #
diff --git a/docs/notebook_source/3-seeding-with-a-dataset.py b/docs/notebook_source/3-seeding-with-a-dataset.py
@@ -42,7 +42,7 @@
 #
 # - `DataDesigner` is the main object is responsible for managing the data generation process.
 #
-# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) are used.
+# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) are used.
 #
 
 # %%
@@ -55,7 +55,7 @@
 #
 # - The "model alias" is used to reference the model in the Data Designer config (as we will see below).
 #
-# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) docs for more details).
+# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) docs for more details).
 #
 # - By default, we use [build.nvidia.com](https://build.nvidia.com/models) as the model provider.
 #
diff --git a/docs/notebook_source/_README.md b/docs/notebook_source/_README.md
@@ -48,7 +48,7 @@ export NVIDIA_API_KEY="your-api-key-here"
 export OPENAI_API_KEY="your-api-key-here"
 ```
 
-For more information, check the [Quick Start](../quick-start.md), [Default Model Settings](../models/default-model-settings.md) and how to [Configure Model Settings Using The CLI](../models/configure-model-settings-with-the-cli.md).
+For more information, check the [Quick Start](../quick-start.md), [Default Model Settings](../concepts/models/default-model-settings.md) and how to [Configure Model Settings Using The CLI](../concepts/models/configure-model-settings-with-the-cli.md).
 
 ## 📚 Tutorial Series
 
diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -82,4 +82,4 @@ preview_results.display_sample_record()
 
 🎉 Congratulations, you successfully ran one iteration designing your synthetic data. Follow along to learn more.
 
-To learn more about the default providers and model configurations available, see the [Default Model Settings](models/default-model-settings.md) guide.
+To learn more about the default providers and model configurations available, see the [Default Model Settings](concepts/models/default-model-settings.md) guide.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,14 +8,14 @@ nav:
       - Quick Start: quick-start.md
       - Contributing: CONTRIBUTING.md
   - Concepts:
+      - Models:
+          - Default Model Settings: concepts/models/default-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
       - Columns: concepts/columns.md
       - Validators: concepts/validators.md
       - Person Sampling: concepts/person_sampling.md
-  - Models:
-      - Default Model Settings: models/default-model-settings.md
-      - Configure with the CLI: models/configure-model-settings-with-the-cli.md
-      - Model Providers: models/model-providers.md
-      - Model Configs: models/model-configs.md
   - Tutorials:
       - Overview: notebooks/README.md
       - The Basics: notebooks/1-the-basics.ipynb
@@ -53,7 +53,6 @@ theme:
             name: Switch to dark mode
   features:
       - navigation.tabs
-      - navigation.sections
       - navigation.expand
       - navigation.path
       - content.code.copy
diff --git a/src/data_designer/interface/data_designer.py b/src/data_designer/interface/data_designer.py
@@ -323,7 +323,7 @@ def _resolve_model_providers(self, model_providers: list[ModelProvider] | None)
                         "🚨 You are trying to use a default model provider but your API keys are missing."
                         "\n\t\t\tSet the API key for the default providers you intend to use and re-initialize the Data Designer object."
                         "\n\t\t\tAlternatively, you can provide your own model providers during Data Designer object initialization."
-                        "\n\t\t\tSee https://nvidia-nemo.github.io/DataDesigner/models/model-providers/ for more information."
+                        "\n\t\t\tSee https://nvidia-nemo.github.io/DataDesigner/concepts/models/model-providers/ for more information."
                     )
                     self._get_interface_info(model_providers).display(InfoType.MODEL_PROVIDERS)
                 return model_providers

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@`
`46`	`46`	`#`
`47`	`47`	# - `DataDesigner` is the main object is responsible for managing the data generation process.
`48`	`48`	`#`
`49`		`-# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) are used.`
	`49`	`+# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) are used.`
`50`	`50`	`#`
`51`	`51`
`52`	`52`	`# %%`
`@@ -59,7 +59,7 @@`
`59`	`59`	`#`
`60`	`60`	`# - The "model alias" is used to reference the model in the Data Designer config (as we will see below).`
`61`	`61`	`#`
`62`		`-# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) docs for more details).`
	`62`	`+# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) docs for more details).`
`63`	`63`	`#`
`64`	`64`	`# - By default, we use [build.nvidia.com](https://build.nvidia.com/models) as the model provider.`
`65`	`65`	`#`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@`
`48`	`48`	`#`
`49`	`49`	# - `DataDesigner` is the main object that is used to interface with the library.
`50`	`50`	`#`
`51`		`-# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) are used.`
	`51`	`+# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) are used.`
`52`	`52`	`#`
`53`	`53`
`54`	`54`	`# %%`
`@@ -61,7 +61,7 @@`
`61`	`61`	`#`
`62`	`62`	`# - The "model alias" is used to reference the model in the Data Designer config (as we will see below).`
`63`	`63`	`#`
`64`		`-# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) docs for more details).`
	`64`	`+# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) docs for more details).`
`65`	`65`	`#`
`66`	`66`	`# - By default, we use [build.nvidia.com](https://build.nvidia.com/models) as the model provider.`
`67`	`67`	`#`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@`
`42`	`42`	`#`
`43`	`43`	# - `DataDesigner` is the main object is responsible for managing the data generation process.
`44`	`44`	`#`
`45`		`-# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) are used.`
	`45`	`+# - When initialized without arguments, the [default model providers](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) are used.`
`46`	`46`	`#`
`47`	`47`
`48`	`48`	`# %%`
`@@ -55,7 +55,7 @@`
`55`	`55`	`#`
`56`	`56`	`# - The "model alias" is used to reference the model in the Data Designer config (as we will see below).`
`57`	`57`	`#`
`58`		`-# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/models/default-model-settings/) docs for more details).`
	`58`	`+# - The "model provider" is the external service that hosts the model (see the [model config](https://nvidia-nemo.github.io/DataDesigner/concepts/models/default-model-settings/) docs for more details).`
`59`	`59`	`#`
`60`	`60`	`# - By default, we use [build.nvidia.com](https://build.nvidia.com/models) as the model provider.`
`61`	`61`	`#`