Skip to content
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@
" - [External test provider](#toc9_4__) \n",
" - [Simple custom test](#toc9_5__) \n",
"- [Where to go from here](#toc10__) \n",
" - [Use cases](#toc10_1__) \n",
" - [More how-to guides and code samples](#toc10_2__) \n",
" - [Discover more learning resources](#toc10_3__) \n",
" - [Discover more learning resources](#toc10_1__) \n",
"- [Upgrade ValidMind](#toc11__) \n",
"\n",
":::\n",
Expand Down Expand Up @@ -1079,43 +1077,19 @@
"- Extending the capabilities of the ValidMind Library by implementing custom tests\n",
"- Ensuring that the documentation is complete by running all tests in the documentation template\n",
"\n",
"As a next step, you can explore the following notebooks to get a deeper understanding on how the ValidMind Library allows you generate model documentation for any use case:\n",
"\n",
"<a id='toc10_1__'></a>\n",
"\n",
"### Use cases\n",
"\n",
"- [Application scorecard demo](../use_cases/credit_risk/application_scorecard_demo.ipynb)\n",
"- [Linear regression documentation demo](../use_cases/regression/quickstart_regression_full_suite.ipynb)\n",
"- [LLM model documentation demo](../use_cases/nlp_and_llm/foundation_models_integration_demo.ipynb)\n",
"\n",
"<a id='toc10_2__'></a>\n",
"\n",
"### More how-to guides and code samples\n",
"\n",
"- [Explore available tests in detail](../how_to/tests/explore_tests/explore_tests.ipynb)\n",
"- [In-depth guide for implementing custom tests](../../how_to/tests/custom_tests/implement_custom_tests.ipynb)\n",
"- [In-depth guide to external test providers](../../how_to/tests/custom_tests/integrate_external_test_providers.ipynb)\n",
"- [Configuring dataset features](../how_to/data_and_datasets/dataset_inputs/configure_dataset_features.ipynb)\n",
"- [Introduction to unit and composite metrics](../how_to/metrics/run_unit_metrics.ipynb)\n",
"\n",
"<a id='toc10_3__'></a>\n",
"\n",
"### Discover more learning resources\n",
"\n",
"All notebook samples can be found in the following directories of the ValidMind Library GitHub repository:\n",
"We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
"\n",
"- [Use cases](https://github.com/validmind/validmind-library/tree/main/notebooks/use_cases)\n",
"- [How-to guides](https://github.com/validmind/validmind-library/tree/main/notebooks/how_to)"
"- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
"- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
"- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
"\n",
"Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -1158,7 +1132,6 @@
},
{
"cell_type": "markdown",
"id": "copyright-150aeb3474a94fa282029aed47eb2834",
"metadata": {},
"source": [
"<!-- VALIDMIND COPYRIGHT -->\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -766,10 +766,11 @@
"\n",
"### Discover more learning resources\n",
"\n",
"We offer many interactive notebooks to help you document models:\n",
"We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
"\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/model-testing/testing-overview.html)\n",
"- [Code samples](https://docs.validmind.ai/developer/samples-jupyter-notebooks.html)\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
"- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
"- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
"\n",
"Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -380,10 +380,11 @@
"\n",
"### Discover more learning resources\n",
"\n",
"We offer many interactive notebooks to help you document models:\n",
"We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
"\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/model-testing/testing-overview.html)\n",
"- [Code samples](https://docs.validmind.ai/developer/samples-jupyter-notebooks.html)\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
"- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
"- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
"\n",
"Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -965,10 +965,11 @@
"\n",
"### Discover more learning resources\n",
"\n",
"We offer many interactive notebooks to help you document models:\n",
"We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
"\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/model-testing/testing-overview.html)\n",
"- [Code samples](https://docs.validmind.ai/developer/samples-jupyter-notebooks.html)\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
"- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
"- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
"\n",
"Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
]
Expand Down
34 changes: 7 additions & 27 deletions notebooks/how_to/data_and_datasets/use_dataset_model_objects.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@
" - [Using VM Model and Dataset objects as arguments in Custom tests](#toc5_7__) \n",
" - [Log the test results](#toc5_8__) \n",
"- [Where to go from here](#toc6__) \n",
" - [Use cases](#toc6_1__) \n",
" - [More how-to guides and code samples](#toc6_2__) \n",
" - [Discover more learning resources](#toc6_3__) \n",
" - [Discover more learning resources](#toc6_1__) \n",
"- [Upgrade ValidMind](#toc7__) \n",
"\n",
":::\n",
Expand Down Expand Up @@ -892,34 +890,17 @@
"- Extending the capabilities of the ValidMind Library by implementing custom tests\n",
"- Ensuring that the documentation is complete by running all tests in the documentation template\n",
"\n",
"As a next step, you can explore the following notebooks to get a deeper understanding on how the ValidMind Library allows you generate model documentation for any use case:\n",
"\n",
"<a id='toc6_1__'></a>\n",
"\n",
"### Use cases\n",
"\n",
"- [Document an application scorecard model](../../use_cases/credit_risk/application_scorecard_full_suite.ipynb)\n",
"- [Linear regression documentation demo](../../use_cases/regression/quickstart_regression_full_suite.ipynb)\n",
"- [LLM model documentation demo](../../use_cases/nlp_and_llm/foundation_models_integration_demo.ipynb)\n",
"\n",
"<a id='toc6_2__'></a>\n",
"\n",
"### More how-to guides and code samples\n",
"\n",
"- [Explore available tests in detail](../tests/explore_tests/explore_tests.ipynb)\n",
"- [In-depth guide for implementing custom tests](../tests/custom_tests/implement_custom_tests.ipynb)\n",
"- [In-depth guide to external test providers](../tests/custom_tests/integrate_external_test_providers.ipynb)\n",
"- [Configuring dataset features](./dataset_inputs/configure_dataset_features.ipynb)\n",
"- [Introduction to unit and composite tests](../metrics/run_unit_metrics.ipynb)\n",
"\n",
"<a id='toc6_3__'></a>\n",
"\n",
"### Discover more learning resources\n",
"\n",
"All notebook samples can be found in the following directories of the ValidMind Library GitHub repository:\n",
"We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
"\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
"- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
"- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
"\n",
"- [Use cases](https://github.com/validmind/validmind-library/tree/main/notebooks/use_cases)\n",
"- [How-to guides](https://github.com/validmind/validmind-library/tree/main/notebooks/how_to)"
"Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
]
},
{
Expand Down Expand Up @@ -964,7 +945,6 @@
},
{
"cell_type": "markdown",
"id": "copyright-340a990e20194848af0efb0c965e219a",
"metadata": {},
"source": [
"<!-- VALIDMIND COPYRIGHT -->\n",
Expand Down
7 changes: 4 additions & 3 deletions notebooks/how_to/metrics/log_metrics_over_time.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -867,10 +867,11 @@
"\n",
"### Discover more learning resources\n",
"\n",
"We offer many interactive notebooks to help you document models:\n",
"We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
"\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/model-testing/testing-overview.html)\n",
"- [Code samples](https://docs.validmind.ai/developer/samples-jupyter-notebooks.html)\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
"- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
"- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
"\n",
"Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
]
Expand Down
7 changes: 4 additions & 3 deletions notebooks/how_to/metrics/run_unit_metrics.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -704,10 +704,11 @@
"\n",
"### Discover more learning resources\n",
"\n",
"We offer many interactive notebooks to help you document models:\n",
"We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
"\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/model-testing/testing-overview.html)\n",
"- [Code samples](https://docs.validmind.ai/developer/samples-jupyter-notebooks.html)\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
"- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
"- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
"\n",
"Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1004,10 +1004,11 @@
"\n",
"### Discover more learning resources\n",
"\n",
"We offer many interactive notebooks to help you document models:\n",
"We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
"\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/model-testing/testing-overview.html)\n",
"- [Code samples](https://docs.validmind.ai/developer/samples-jupyter-notebooks.html)\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
"- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
"- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
"\n",
"Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -904,10 +904,11 @@
"\n",
"### Discover more learning resources\n",
"\n",
"We offer many interactive notebooks to help you document models:\n",
"We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
"\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/model-testing/testing-overview.html)\n",
"- [Code samples](https://docs.validmind.ai/developer/samples-jupyter-notebooks.html)\n",
"- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
"- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
"- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
"\n",
"Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
]
Expand Down
Loading