Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions site/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -326,8 +326,10 @@ notebooks:
@rm -rf $(DEST_DIR_NB)/templates
@echo "Copying _metadata.yml into notebooks/ ..."
@cp developer/_metadata.yml $(DEST_DIR_NB)/_metadata.yml
@echo "Updating developer/_sidebar.yaml with code_samples directories ..."
@python scripts/update_code_samples_sidebar.py
@echo "Updating developer/_sidebar.yaml with use_cases directories ..."
@python scripts/developer-sidebar/update_use_cases.py
@echo "Updating developer/_sidebar.yaml with how-to directories ..."
@python scripts/developer-sidebar/update_how_tos.py
@echo "Zip up notebooks.zip ..."
@zip -r notebooks.zip $(DEST_DIR_NB) > /dev/null 2>&1

Expand Down
4 changes: 2 additions & 2 deletions site/about/overview-model-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ How the {{< var validmind.developer >}} works:

[^3]: [Customize document templates](/guide/templates/customize-document-templates.qmd)

[^4]: [Implement custom tests](/notebooks/code_samples/custom_tests/implement_custom_tests.ipynb)
[^4]: [Implement custom tests](/notebooks/how_to/tests/custom_tests/implement_custom_tests.ipynb)

[^5]: [Integrate external test providers](/notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb)
[^5]: [Integrate external test providers](/notebooks/how_to/tests/custom_tests/integrate_external_test_providers.ipynb)


4 changes: 2 additions & 2 deletions site/about/use-cases/e-23.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Use this checklist to track your E-23 implementation progress:

[^3]: [Working with document templates](/guide/templates/working-with-document-templates.qmd)

[^4]: [Run tests and test suites](/developer/model-testing/testing-overview.qmd)
[^4]: [Run tests and test suites](/developer/how-to/testing-overview.qmd)

[^5]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)

Expand All @@ -149,7 +149,7 @@ Use this checklist to track your E-23 implementation progress:

[^8]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)

[^9]: [Run tests and test suites](/developer/model-testing/testing-overview.qmd)
[^9]: [Run tests and test suites](/developer/how-to/testing-overview.qmd)

[^10]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)

Expand Down
4 changes: 2 additions & 2 deletions site/about/use-cases/eu-ai-act.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -233,11 +233,11 @@ Integrate all components into a complete compliance workflow addressing Articles
[^4]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd)

[^5]:
[Run tests and test suites](/developer/model-testing/testing-overview.qmd)
[Run tests and test suites](/developer/how-to/testing-overview.qmd)

[^6]: [Work with document templates](/guide/templates/working-with-document-templates.qmd)

[^7]: [Test descriptions](/developer/model-testing/test-descriptions.qmd)
[^7]: [Test descriptions](/developer/test-descriptions.qmd)

[^8]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd)

Expand Down
2 changes: 1 addition & 1 deletion site/about/use-cases/sr-11-7.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ Establish governance framework aligned to SR 11-7.

[^5]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)

[^6]: [Run tests and test suites](/developer/model-testing/testing-overview.qmd)
[^6]: [Run tests and test suites](/developer/how-to/testing-overview.qmd)

[^7]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)

Expand Down
109 changes: 68 additions & 41 deletions site/developer/_sidebar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,65 +19,92 @@ website:
file: developer/model-documentation/install-and-initialize-validmind-library.qmd
- developer/model-documentation/store-credentials-in-env-file.qmd
- text: "---"
- text: "Model Development"
- text: "End-to-End Tutorials"
# USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
- text: "1 — Set up ValidMind Library"
file: notebooks/tutorials/model_development/1-set_up_validmind.ipynb
- text: "2 — Start model development process"
file: notebooks/tutorials/model_development/2-start_development_process.ipynb
- text: "3 — Integrate custom tests"
file: notebooks/tutorials/model_development/3-integrate_custom_tests.ipynb
- text: "4 — Finalize testing & documentation"
file: notebooks/tutorials/model_development/4-finalize_testing_documentation.ipynb
- text: "---"
- text: "Model Validation"
# USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
- text: "1 — Set up ValidMind Library for validation"
file: notebooks/tutorials/model_validation/1-set_up_validmind_for_validation.ipynb
- text: "2 — Start model validation process"
file: notebooks/tutorials/model_validation/2-start_validation_process.ipynb
- text: "3 — Developing a challenger model"
file: notebooks/tutorials/model_validation/3-developing_challenger_model.ipynb
- text: "4 — Finalize validation & reporting"
file: notebooks/tutorials/model_validation/4-finalize_validation_reporting.ipynb
- section: "Model development"
contents:
- text: "1 — Set up ValidMind Library"
file: notebooks/tutorials/model_development/1-set_up_validmind.ipynb
- text: "2 — Start model development process"
file: notebooks/tutorials/model_development/2-start_development_process.ipynb
- text: "3 — Integrate custom tests"
file: notebooks/tutorials/model_development/3-integrate_custom_tests.ipynb
- text: "4 — Finalize testing & documentation"
file: notebooks/tutorials/model_development/4-finalize_testing_documentation.ipynb
- section: "Model validation"
contents:
- text: "1 — Set up ValidMind Library for validation"
file: notebooks/tutorials/model_validation/1-set_up_validmind_for_validation.ipynb
- text: "2 —\u00A0Start model validation process"
file: notebooks/tutorials/model_validation/2-start_validation_process.ipynb
- text: "3 — Developing a challenger model"
file: notebooks/tutorials/model_validation/3-developing_challenger_model.ipynb
- text: "4 — Finalize validation & reporting"
file: notebooks/tutorials/model_validation/4-finalize_validation_reporting.ipynb
- text: "---"
- text: "Model Testing"
- text: "How-To"
- text: "Run tests & test suites"
file: developer/model-testing/testing-overview.qmd
contents: "notebooks/how_to/**"
- text: "Test descriptions"
file: developer/model-testing/test-descriptions.qmd
contents: tests/**
- developer/model-testing/test-sandbox.qmd
file: developer/how-to/testing-overview.qmd
contents:
- section: "Explore tests"
contents:
- notebooks/how_to/tests/explore_tests/explore_tests.ipynb
- notebooks/how_to/tests/explore_tests/explore_test_suites.ipynb
- developer/how-to/test-sandbox.qmd
- section: "Run tests"
contents:
- notebooks/how_to/tests/run_tests/1_run_dataset_based_tests.ipynb
- notebooks/how_to/tests/run_tests/2_run_comparison_tests.ipynb
- section: "Configuring tests"
contents: "notebooks/how_to/tests/run_tests/configure_tests/*.ipynb"
- section: "Using tests in documentation"
contents: "notebooks/how_to/tests/run_tests/documentation_tests/*.ipynb"
- section: "Custom tests"
contents:
- notebooks/how_to/tests/custom_tests/implement_custom_tests.ipynb
- notebooks/how_to/tests/custom_tests/integrate_external_test_providers.ipynb
- text: "Use library features"
file: developer/how-to/feature-overview.qmd
contents:
- section: "Data and datasets"
contents:
- notebooks/how_to/data_and_datasets/use_dataset_model_objects.ipynb
- section: "Dataset inputs"
contents: "notebooks/how_to/data_and_datasets/dataset_inputs/**/*.ipynb"
- section: "Metrics"
contents: "notebooks/how_to/metrics/**/*.ipynb"
- section: "Scoring"
contents: "notebooks/how_to/scoring/**/*.ipynb"
- text: "---"
- text: "Notebooks"
- text: "Code samples"
file: developer/samples-jupyter-notebooks.qmd
contents:
- section: "Agents"
contents: "notebooks/code_samples/agents/**"
contents: "notebooks/use_cases/agents/**/*.ipynb"
- section: "Capital markets"
contents: "notebooks/code_samples/capital_markets/**"
contents: "notebooks/use_cases/capital_markets/**/*.ipynb"
- section: "Code explainer"
contents: "notebooks/code_samples/code_explainer/**"
contents: "notebooks/use_cases/code_explainer/**/*.ipynb"
- section: "Credit risk"
contents: "notebooks/code_samples/credit_risk/**"
- section: "Custom tests"
contents: "notebooks/code_samples/custom_tests/**"
contents: "notebooks/use_cases/credit_risk/**/*.ipynb"
- section: "Model validation"
contents: "notebooks/code_samples/model_validation/**"
contents: "notebooks/use_cases/model_validation/**/*.ipynb"
- section: "NLP and LLM"
contents: "notebooks/code_samples/nlp_and_llm/**"
contents: "notebooks/use_cases/nlp_and_llm/**/*.ipynb"
- section: "Ongoing monitoring"
contents: "notebooks/code_samples/ongoing_monitoring/**"
contents: "notebooks/use_cases/ongoing_monitoring/**/*.ipynb"
- section: "Regression"
contents: "notebooks/code_samples/regression/**"
contents: "notebooks/use_cases/regression/**/*.ipynb"
- section: "Time series"
contents: "notebooks/code_samples/time_series/**"
contents: "notebooks/use_cases/time_series/**/*.ipynb"
- text: "---"
- text: "Reference"
- text: "Test descriptions"
file: developer/test-descriptions.qmd
contents: tests/**
- text: "{{< var validmind.api >}}"
file: validmind/validmind.qmd
- reference/validmind-rest-api-vm.qmd


# USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
- text: "ValidMind Public REST API"
file: reference/validmind-rest-api-vm.qmd
69 changes: 69 additions & 0 deletions site/developer/how-to/feature-overview.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
# Copyright © 2023-2026 ValidMind Inc. All rights reserved.
# Refer to the LICENSE file in the root of this repository for details.
# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial
# USING THE VARIABLE MESSES UP THE SPACING ON THE PREVIEW TILE
title: "How to use {{< var validmind.developer >}} features"
date: last-modified
listing:
- id: tests
type: grid
grid-columns: 2
image-placeholder: "jupyter-logo-rectangle.svg"
max-description-length: 350
image-height: "100%"
fields: [title, description, reading-time]
contents: "../../notebooks/how_to/tests/**/*.ipynb"
- id: data-and-datasets
type: grid
grid-columns: 2
image-placeholder: "jupyter-logo-rectangle.svg"
max-description-length: 350
image-height: "100%"
fields: [title, description, reading-time]
contents: "../../notebooks/how_to/data_and_datasets/**/*.ipynb"
- id: metrics
type: grid
grid-columns: 2
image-placeholder: "jupyter-logo-rectangle.svg"
max-description-length: 350
image-height: "100%"
fields: [title, description, reading-time]
contents: "../../notebooks/how_to/metrics/**/*.ipynb"
- id: scoring
type: grid
grid-columns: 2
image-placeholder: "jupyter-logo-rectangle.svg"
max-description-length: 350
image-height: "100%"
fields: [title, description, reading-time]
contents: "../../notebooks/how_to/scoring/**/*.ipynb"
---

Browse our range of Jupyter Notebooks demonstrating how to use the core features of the {{< var validmind.developer >}}. Use these how-to notebooks to get familiar with the {{< var vm.developer >}}'s capabilities and apply them to your own use cases.

## How-to by topic

:::{.panel-tabset}

## Testing

:::{#tests}
:::

## Data and datasets

:::{#data-and-datasets}
:::

## Metrics

:::{#metrics}
:::

## Scoring

:::{#scoring}
:::

:::
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ title: "Test sandbox <sup>[beta]{.smallcaps}</sup>"
date: last-modified
aliases:
- /guide/test-sandbox.html
- /developer/model-testing/test-sandbox.html
---

<!--- TO DO
Expand Down
Loading
Loading