\n",
diff --git a/notebooks/how_to/run_tests/2_run_comparison_tests.ipynb b/notebooks/how_to/run_tests/2_run_comparison_tests.ipynb
index 2564d8ef4..9370fc98b 100644
--- a/notebooks/how_to/run_tests/2_run_comparison_tests.ipynb
+++ b/notebooks/how_to/run_tests/2_run_comparison_tests.ipynb
@@ -79,7 +79,7 @@
"
\n",
"\n",
"### New to ValidMind?\n",
- "If you haven't already seen our [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html), we recommend you begin by exploring the available resources in this section. There, you can learn more about documenting models, find code samples, or read our developer reference.\n",
+ "If you haven't already seen our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html), we recommend you begin by exploring the available resources in this section. There, you can learn more about documenting models, find code samples, or read our developer reference.\n",
"\n",
"
For access to all features available in this notebook, create a free ValidMind account.\n",
"
\n",
From 04aae1874273b13b8da964fbc710d5a22e25ee88 Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Thu, 6 Mar 2025 16:42:03 -0800
Subject: [PATCH 05/11] Changing out old links in prep pt3
---
.../custom_tests/integrate_external_test_providers.ipynb | 2 +-
.../nlp_and_llm/foundation_models_integration_demo.ipynb | 4 ++--
.../nlp_and_llm/foundation_models_summarization_demo.ipynb | 4 ++--
.../nlp_and_llm/hugging_face_integration_demo.ipynb | 4 ++--
.../nlp_and_llm/hugging_face_summarization_demo.ipynb | 4 ++--
.../code_samples/nlp_and_llm/llm_summarization_demo.ipynb | 2 +-
.../regression/quickstart_regression_full_suite.ipynb | 4 ++--
.../code_sharing/clustering/quickstart_cluster_demo.ipynb | 2 +-
.../code_sharing/embeddings/quickstart_embeddings_demo.ipynb | 2 +-
.../code_sharing/regression/regression_unit_metrics.ipynb | 2 +-
10 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb b/notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb
index 414d4cfe2..d977817e7 100644
--- a/notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb
+++ b/notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb
@@ -114,7 +114,7 @@
"If this is your first time trying out ValidMind, we recommend going through the following resources first:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference\n",
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference\n",
"\n",
"
\n",
"\n",
diff --git a/notebooks/code_samples/nlp_and_llm/foundation_models_integration_demo.ipynb b/notebooks/code_samples/nlp_and_llm/foundation_models_integration_demo.ipynb
index e76caab88..5fb7b6221 100644
--- a/notebooks/code_samples/nlp_and_llm/foundation_models_integration_demo.ipynb
+++ b/notebooks/code_samples/nlp_and_llm/foundation_models_integration_demo.ipynb
@@ -22,7 +22,7 @@
"If this is your first time trying out ValidMind, we recommend going through the following resources first:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
]
},
{
@@ -322,7 +322,7 @@
"\n",
"What you can see now is a more easily consumable version of the prompt validation testing you just performed, along with other parts of your model documentation that still need to be completed.\n",
"\n",
- "If you want to learn more about where you are in the model documentation process, take a look at [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html).\n"
+ "If you want to learn more about where you are in the model documentation process, take a look our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html).\n"
]
},
{
diff --git a/notebooks/code_samples/nlp_and_llm/foundation_models_summarization_demo.ipynb b/notebooks/code_samples/nlp_and_llm/foundation_models_summarization_demo.ipynb
index ef70b9ddd..9ae50dbb9 100644
--- a/notebooks/code_samples/nlp_and_llm/foundation_models_summarization_demo.ipynb
+++ b/notebooks/code_samples/nlp_and_llm/foundation_models_summarization_demo.ipynb
@@ -37,7 +37,7 @@
"If this is your first time trying out ValidMind, we recommend going through the following resources first:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
]
},
{
@@ -367,7 +367,7 @@
"\n",
"What you can see now is a more easily consumable version of the prompt validation testing you just performed, along with other parts of your model documentation that still need to be completed.\n",
"\n",
- "If you want to learn more about where you are in the model documentation process, take a look at [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html).\n"
+ "If you want to learn more about where you are in the model documentation process, take a look our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html).\n"
]
},
{
diff --git a/notebooks/code_samples/nlp_and_llm/hugging_face_integration_demo.ipynb b/notebooks/code_samples/nlp_and_llm/hugging_face_integration_demo.ipynb
index 0c5d996ad..ee51ab20b 100644
--- a/notebooks/code_samples/nlp_and_llm/hugging_face_integration_demo.ipynb
+++ b/notebooks/code_samples/nlp_and_llm/hugging_face_integration_demo.ipynb
@@ -22,7 +22,7 @@
"If this is your first time trying out ValidMind, we recommend going through the following resources first:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
]
},
{
@@ -294,7 +294,7 @@
"\n",
"What you can see now is a more easily consumable version of the prompt validation testing you just performed, along with other parts of your model documentation that still need to be completed.\n",
"\n",
- "If you want to learn more about where you are in the model documentation process, take a look at [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html).\n"
+ "If you want to learn more about where you are in the model documentation process, take a look our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html).\n"
]
},
{
diff --git a/notebooks/code_samples/nlp_and_llm/hugging_face_summarization_demo.ipynb b/notebooks/code_samples/nlp_and_llm/hugging_face_summarization_demo.ipynb
index f4042e960..c68e562d7 100644
--- a/notebooks/code_samples/nlp_and_llm/hugging_face_summarization_demo.ipynb
+++ b/notebooks/code_samples/nlp_and_llm/hugging_face_summarization_demo.ipynb
@@ -23,7 +23,7 @@
"If this is your first time trying out ValidMind, we recommend going through the following resources first:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
]
},
{
@@ -326,7 +326,7 @@
"\n",
"What you can see now is a more easily consumable version of the prompt validation testing you just performed, along with other parts of your model documentation that still need to be completed.\n",
"\n",
- "If you want to learn more about where you are in the model documentation process, take a look at [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html).\n"
+ "If you want to learn more about where you are in the model documentation process, take a look our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html).\n"
]
},
{
diff --git a/notebooks/code_samples/nlp_and_llm/llm_summarization_demo.ipynb b/notebooks/code_samples/nlp_and_llm/llm_summarization_demo.ipynb
index 8fef07bd3..1e6ee84f2 100644
--- a/notebooks/code_samples/nlp_and_llm/llm_summarization_demo.ipynb
+++ b/notebooks/code_samples/nlp_and_llm/llm_summarization_demo.ipynb
@@ -45,7 +45,7 @@
"If this is your first time trying out ValidMind, you can make use of the following resources alongside this notebook:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
]
},
{
diff --git a/notebooks/code_samples/regression/quickstart_regression_full_suite.ipynb b/notebooks/code_samples/regression/quickstart_regression_full_suite.ipynb
index e1e329e13..461d8c289 100644
--- a/notebooks/code_samples/regression/quickstart_regression_full_suite.ipynb
+++ b/notebooks/code_samples/regression/quickstart_regression_full_suite.ipynb
@@ -29,7 +29,7 @@
"If this is your first time trying out ValidMind, you can make use of the following resources alongside this notebook:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
]
},
{
@@ -447,7 +447,7 @@
"\n",
"What you can see now is a much more easily consumable version of the documentation, including the results of the tests you just performed, along with other parts of your model documentation that still need to be completed. There is a wealth of information that gets uploaded when you run the full test suite, so take a closer look around, especially at test results that might need attention (hint: some of the tests in **2.1 Data description** look like they need some attention).\n",
"\n",
- "If you want to learn more about where you are in the model documentation process, take a look at [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html).\n"
+ "If you want to learn more about where you are in the model documentation process, take a look our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html).\n"
]
},
{
diff --git a/notebooks/code_sharing/clustering/quickstart_cluster_demo.ipynb b/notebooks/code_sharing/clustering/quickstart_cluster_demo.ipynb
index 43142c928..3aa34cc6f 100644
--- a/notebooks/code_sharing/clustering/quickstart_cluster_demo.ipynb
+++ b/notebooks/code_sharing/clustering/quickstart_cluster_demo.ipynb
@@ -30,7 +30,7 @@
"If this is your first time trying out ValidMind, you can make use of the following resources alongside this notebook:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference"
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference"
]
},
{
diff --git a/notebooks/code_sharing/embeddings/quickstart_embeddings_demo.ipynb b/notebooks/code_sharing/embeddings/quickstart_embeddings_demo.ipynb
index ce49c7307..f8583992e 100644
--- a/notebooks/code_sharing/embeddings/quickstart_embeddings_demo.ipynb
+++ b/notebooks/code_sharing/embeddings/quickstart_embeddings_demo.ipynb
@@ -22,7 +22,7 @@
"If this is your first time trying out ValidMind, you can make use of the following resources alongside this notebook:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference"
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference"
]
},
{
diff --git a/notebooks/code_sharing/regression/regression_unit_metrics.ipynb b/notebooks/code_sharing/regression/regression_unit_metrics.ipynb
index b66bed7bd..66568527a 100644
--- a/notebooks/code_sharing/regression/regression_unit_metrics.ipynb
+++ b/notebooks/code_sharing/regression/regression_unit_metrics.ipynb
@@ -29,7 +29,7 @@
"If this is your first time trying out ValidMind, you can make use of the following resources alongside this notebook:\n",
"\n",
"- [Get started](https://docs.validmind.ai/get-started/get-started.html) — The basics, including key concepts, and how our products work\n",
- "- [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
+ "- [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html) — The path for developers, more code samples, and our developer reference\n"
]
},
{
From aa0f6bdc936b713f37f6a68b71488dd8e7b47db8 Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Thu, 6 Mar 2025 16:44:10 -0800
Subject: [PATCH 06/11] Changing out old links in prep pt4
---
.../code_samples/nlp_and_llm/llm_summarization_demo.ipynb | 2 +-
.../code_sharing/clustering/quickstart_cluster_demo.ipynb | 3 +--
notebooks/code_sharing/r/r_custom_tests.Rmd | 2 +-
3 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/notebooks/code_samples/nlp_and_llm/llm_summarization_demo.ipynb b/notebooks/code_samples/nlp_and_llm/llm_summarization_demo.ipynb
index 1e6ee84f2..e7ac59684 100644
--- a/notebooks/code_samples/nlp_and_llm/llm_summarization_demo.ipynb
+++ b/notebooks/code_samples/nlp_and_llm/llm_summarization_demo.ipynb
@@ -814,7 +814,7 @@
"\n",
"What you can see now is a more easily consumable version of the prompt validation testing you just performed, along with other parts of your model documentation that still need to be completed.\n",
"\n",
- "If you want to learn more about where you are in the model documentation process, take a look at [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html)."
+ "If you want to learn more about where you are in the model documentation process, take a look at our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html)."
]
},
{
diff --git a/notebooks/code_sharing/clustering/quickstart_cluster_demo.ipynb b/notebooks/code_sharing/clustering/quickstart_cluster_demo.ipynb
index 3aa34cc6f..44d997de0 100644
--- a/notebooks/code_sharing/clustering/quickstart_cluster_demo.ipynb
+++ b/notebooks/code_sharing/clustering/quickstart_cluster_demo.ipynb
@@ -406,8 +406,7 @@
"\n",
"What you can see now is a much more easily consumable version of the documentation, including the results of the tests you just performed, along with other parts of your model documentation that still need to be completed. There is a wealth of information that gets uploaded when you run the full test suite, so take a closer look around, especially at test results that might need attention (hint: some of the tests in 2.1 Data description look like they need some attention).\n",
"\n",
- "If you want to learn more about where you are in the model documentation process, take a look at [Get started with the ValidMind Library\n",
- "](https://docs.validmind.ai/developer/get-started-validmind-library.html).\n"
+ "If you want to learn more about where you are in the model documentation process, take a look at our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html).\n"
]
},
{
diff --git a/notebooks/code_sharing/r/r_custom_tests.Rmd b/notebooks/code_sharing/r/r_custom_tests.Rmd
index fa835989d..2a89f051b 100644
--- a/notebooks/code_sharing/r/r_custom_tests.Rmd
+++ b/notebooks/code_sharing/r/r_custom_tests.Rmd
@@ -31,7 +31,7 @@ If you encounter errors due to missing modules in your Python environment, insta
### New to ValidMind?
-If you haven't already seen our [Get started with the ValidMind Library](https://docs.validmind.ai/developer/get-started-validmind-library.html), we recommend you explore the available resources for developers at some point. There, you can learn more about documenting models, find code samples, or read our developer reference.
+If you haven't already seen our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html), we recommend you begin by exploring the available resources in this section. There, you can learn more about documenting models, find code samples, or read our developer reference.
For access to all features available in this notebook, create a free ValidMind account.
From bff20ce25ed9197d73916b5230e51afec5501aa1 Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Thu, 6 Mar 2025 16:48:39 -0800
Subject: [PATCH 07/11] Adding ToC extension to template README
---
notebooks/templates/README.md | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/notebooks/templates/README.md b/notebooks/templates/README.md
index 70a46d4d7..15f94047d 100644
--- a/notebooks/templates/README.md
+++ b/notebooks/templates/README.md
@@ -15,4 +15,8 @@ The template generation script/notebook draws from the following mini-templates,
- [`about-validmind.ipynb`](about-validmind.ipynb): Conceptual overview of ValidMind & prerequisites.
- [`install-initialize-validmind.ipynb`](install-initialize-validmind.ipynb): ValidMind Library installation & initialization instructions.
- [`next-steps.ipynb`](next-steps.ipynb): Directions to review the generated documentation within the ValidMind Platform & additional learning resources.
-- [`upgrade-validmind.ipynb`](upgrade-validmind.ipynb): Instructions for comparing & upgrading versions of the ValidMind Library.
\ No newline at end of file
+- [`upgrade-validmind.ipynb`](upgrade-validmind.ipynb): Instructions for comparing & upgrading versions of the ValidMind Library.
+
+## Adding table of contents
+
+For lengthy notebooks, we recommend that you add a table of contents with the [**Simplified table of contents for Jupyter Notebooks extension**](https://github.com/validbeck/jupyter-notebook-toc/tree/main/installation).
From 48c82b174317f3acece992c84268fc7c6480f52e Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Fri, 7 Mar 2025 14:39:37 -0800
Subject: [PATCH 08/11] Style guide tweak
---
notebooks/templates/README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/notebooks/templates/README.md b/notebooks/templates/README.md
index 15f94047d..8ad589ab7 100644
--- a/notebooks/templates/README.md
+++ b/notebooks/templates/README.md
@@ -17,6 +17,6 @@ The template generation script/notebook draws from the following mini-templates,
- [`next-steps.ipynb`](next-steps.ipynb): Directions to review the generated documentation within the ValidMind Platform & additional learning resources.
- [`upgrade-validmind.ipynb`](upgrade-validmind.ipynb): Instructions for comparing & upgrading versions of the ValidMind Library.
-## Adding table of contents
+## Add table of contents
For lengthy notebooks, we recommend that you add a table of contents with the [**Simplified table of contents for Jupyter Notebooks extension**](https://github.com/validbeck/jupyter-notebook-toc/tree/main/installation).
From 70a685dcd4024d3a7bd1c09af41ba33c8350fd0b Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Tue, 11 Mar 2025 13:44:56 -0700
Subject: [PATCH 09/11] 101 +intro
---
.../101-set_up_validmind.ipynb | 116 ++++++++++--------
1 file changed, 65 insertions(+), 51 deletions(-)
diff --git a/notebooks/tutorials/model_development/101-set_up_validmind.ipynb b/notebooks/tutorials/model_development/101-set_up_validmind.ipynb
index 6d75204a7..b9b15af03 100644
--- a/notebooks/tutorials/model_development/101-set_up_validmind.ipynb
+++ b/notebooks/tutorials/model_development/101-set_up_validmind.ipynb
@@ -2,7 +2,7 @@
"cells": [
{
"cell_type": "markdown",
- "id": "4a4933a6",
+ "id": "97710f2a",
"metadata": {},
"source": [
"# ValidMind for model development — 101 Set up the ValidMind Library\n",
@@ -14,26 +14,27 @@
},
{
"cell_type": "markdown",
- "id": "eb8f781f",
+ "id": "d3bb0ff8",
"metadata": {},
"source": [
"::: {.content-hidden when-format=\"html\"}\n",
"## Contents \n",
- "- [About ValidMind](#toc1_) \n",
- " - [Before you begin](#toc1_1_) \n",
- " - [New to ValidMind?](#toc1_2_) \n",
- " - [Key concepts](#toc1_3_) \n",
- "- [Initializing the ValidMind Library](#toc2_) \n",
- " - [Install the ValidMind Library](#toc2_1_) \n",
- " - [Initialize the ValidMind Library](#toc2_2_) \n",
- " - [Get your code snippet](#toc2_2_1_) \n",
- "- [Getting to know ValidMind](#toc3_) \n",
- " - [Preview the documentation template](#toc3_1_) \n",
- " - [Explore available tests](#toc3_2_) \n",
- "- [Upgrade ValidMind](#toc4_) \n",
- "- [In summary](#toc5_) \n",
- "- [Next steps](#toc6_) \n",
- " - [Start the model development process](#toc6_1_) \n",
+ "- [Introduction](#toc1_) \n",
+ "- [About ValidMind](#toc2_) \n",
+ " - [Before you begin](#toc2_1_) \n",
+ " - [New to ValidMind?](#toc2_2_) \n",
+ " - [Key concepts](#toc2_3_) \n",
+ "- [Initializing the ValidMind Library](#toc3_) \n",
+ " - [Install the ValidMind Library](#toc3_1_) \n",
+ " - [Initialize the ValidMind Library](#toc3_2_) \n",
+ " - [Get your code snippet](#toc3_2_1_) \n",
+ "- [Getting to know ValidMind](#toc4_) \n",
+ " - [Preview the documentation template](#toc4_1_) \n",
+ " - [Explore available tests](#toc4_2_) \n",
+ "- [Upgrade ValidMind](#toc5_) \n",
+ "- [In summary](#toc6_) \n",
+ "- [Next steps](#toc7_) \n",
+ " - [Start the model development process](#toc7_1_) \n",
"\n",
":::\n",
"