From 2c9f1f4ad8ea26cec1ba1357e0f5d93187cd8c0f Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Wed, 9 Apr 2025 14:02:07 -0700 Subject: [PATCH 1/6] Adjustments for validation notebooks docs side --- docs/_sidebar.yml | 2 +- docs/validmind.qmd | 2 +- .../model_validation/validate_application_scorecard.ipynb | 8 +++++++- notebooks/tutorials/intro_for_model_developers.ipynb | 8 ++++---- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/_sidebar.yml b/docs/_sidebar.yml index 03d9ba764..6ddffede1 100644 --- a/docs/_sidebar.yml +++ b/docs/_sidebar.yml @@ -2,7 +2,7 @@ website: sidebar: - id: validmind-reference - title: "ValidMind Library" + title: "ValidMind Library API" collapsed: false collapse-level: 2 contents: diff --git a/docs/validmind.qmd b/docs/validmind.qmd index a38a9018f..52431c123 100644 --- a/docs/validmind.qmd +++ b/docs/validmind.qmd @@ -1,5 +1,5 @@ --- -title: "ValidMind Library" +title: "ValidMind Library API" aliases: - index.html sidebar: validmind-reference diff --git a/notebooks/code_samples/model_validation/validate_application_scorecard.ipynb b/notebooks/code_samples/model_validation/validate_application_scorecard.ipynb index 5946c78a7..2ac83e369 100644 --- a/notebooks/code_samples/model_validation/validate_application_scorecard.ipynb +++ b/notebooks/code_samples/model_validation/validate_application_scorecard.ipynb @@ -1816,8 +1816,14 @@ } ], "metadata": { + "kernelspec": { + "display_name": "ValidMind Library", + "language": "python", + "name": "validmind" + }, "language_info": { - "name": "python" + "name": "python", + "version": "3.10.13" } }, "nbformat": 4, diff --git a/notebooks/tutorials/intro_for_model_developers.ipynb b/notebooks/tutorials/intro_for_model_developers.ipynb index b3d62dae2..cd103546b 100644 --- a/notebooks/tutorials/intro_for_model_developers.ipynb +++ b/notebooks/tutorials/intro_for_model_developers.ipynb @@ -8,10 +8,10 @@ "\n", "Learn how to use ValidMind for your end-to-end model documentation process based on common model development scenarios with our *ValidMind for model development* series of four introductory notebooks:\n", "\n", - "1. [101 Set up the ValidMind Library](/notebooks/tutorials/model_development/101-set_up_validmind.ipynb)\n", - "2. [102 Start the model development process](/notebooks/tutorials/model_development/102-start_development_process.ipynb)\n", - "3. [103 Integrate custom tests](/notebooks/tutorials/model_development/103-integrate_custom_tests.ipynb)\n", - "4. [104 Finalize testing and documentation](/notebooks/tutorials/model_development/104-finalize_testing_documentation.ipynb)\n", + "1. [1 — Set up the ValidMind Library](/notebooks/tutorials/model_development/1-set_up_validmind.ipynb)\n", + "2. [2 — Start the model development process](/notebooks/tutorials/model_development/2-start_development_process.ipynb)\n", + "3. [3 — Integrate custom tests](/notebooks/tutorials/model_development/3-integrate_custom_tests.ipynb)\n", + "4. [4 — Finalize testing and documentation](/notebooks/tutorials/model_development/4-finalize_testing_documentation.ipynb)\n", "\n", "
Or, take our Developer Fundamentals course which walks you through the basics of ValidMind paired with this notebook series.\n", "

\n", From a713d120922e5c71e5f962488ef03b74a8cc74f6 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Wed, 9 Apr 2025 14:16:02 -0700 Subject: [PATCH 2/6] Updating the template --- docs/templates/sidebar.qmd.jinja2 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/templates/sidebar.qmd.jinja2 b/docs/templates/sidebar.qmd.jinja2 index f5529706f..13371d3e9 100644 --- a/docs/templates/sidebar.qmd.jinja2 +++ b/docs/templates/sidebar.qmd.jinja2 @@ -2,7 +2,7 @@ website: sidebar: - id: validmind-reference - title: "ValidMind Library" + title: "ValidMind Library API" collapsed: false collapse-level: 2 contents: From f14a900fbebe96b6e9de728b5b22cfa8b5f30657 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Wed, 9 Apr 2025 14:17:53 -0700 Subject: [PATCH 3/6] Test? --- docs/templates/module.qmd.jinja2 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/templates/module.qmd.jinja2 b/docs/templates/module.qmd.jinja2 index 457772b15..a2b2c0b18 100644 --- a/docs/templates/module.qmd.jinja2 +++ b/docs/templates/module.qmd.jinja2 @@ -3,7 +3,7 @@ {% import "macros/navigation.jinja2" as nav %} {% import "macros/signatures.jinja2" as signatures %} --- -title: "{% if module.name == "validmind" %}ValidMind Library{% else %}[validmind](/validmind/validmind.qmd).{{ module.name }}{% endif +%}" +title: "{% if module.name == "validmind" %}ValidMind Library API{% else %}[validmind](/validmind/validmind.qmd).{{ module.name }}{% endif +%}" {% if module.name == "validmind" %} aliases: - index.html From 45b290a2de9b7a0bfff943ae820481806c330d67 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Wed, 9 Apr 2025 16:02:28 -0700 Subject: [PATCH 4/6] Update docs/templates/module.qmd.jinja2 Co-authored-by: Nik Richers --- docs/templates/module.qmd.jinja2 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/templates/module.qmd.jinja2 b/docs/templates/module.qmd.jinja2 index a2b2c0b18..2c42b8d1a 100644 --- a/docs/templates/module.qmd.jinja2 +++ b/docs/templates/module.qmd.jinja2 @@ -3,7 +3,7 @@ {% import "macros/navigation.jinja2" as nav %} {% import "macros/signatures.jinja2" as signatures %} --- -title: "{% if module.name == "validmind" %}ValidMind Library API{% else %}[validmind](/validmind/validmind.qmd).{{ module.name }}{% endif +%}" +title: "{% if module.name == "validmind" %}ValidMind Library Python API{% else %}[validmind](/validmind/validmind.qmd).{{ module.name }}{% endif +%}" {% if module.name == "validmind" %} aliases: - index.html From 4dfbc96ab77cb8cc04036fdf3a5ff5a535b9d618 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Wed, 9 Apr 2025 16:28:48 -0700 Subject: [PATCH 5/6] Editing terminology --- docs/_sidebar.yml | 2 +- docs/templates/sidebar.qmd.jinja2 | 2 +- docs/validmind.qmd | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/_sidebar.yml b/docs/_sidebar.yml index 6ddffede1..3ff543f9a 100644 --- a/docs/_sidebar.yml +++ b/docs/_sidebar.yml @@ -2,7 +2,7 @@ website: sidebar: - id: validmind-reference - title: "ValidMind Library API" + title: "ValidMind Library Python API" collapsed: false collapse-level: 2 contents: diff --git a/docs/templates/sidebar.qmd.jinja2 b/docs/templates/sidebar.qmd.jinja2 index 13371d3e9..3936b8d41 100644 --- a/docs/templates/sidebar.qmd.jinja2 +++ b/docs/templates/sidebar.qmd.jinja2 @@ -2,7 +2,7 @@ website: sidebar: - id: validmind-reference - title: "ValidMind Library API" + title: "ValidMind Library Python API" collapsed: false collapse-level: 2 contents: diff --git a/docs/validmind.qmd b/docs/validmind.qmd index 52431c123..b39229538 100644 --- a/docs/validmind.qmd +++ b/docs/validmind.qmd @@ -1,5 +1,5 @@ --- -title: "ValidMind Library API" +title: "ValidMind Library Python API" aliases: - index.html sidebar: validmind-reference From 35a75dae82105351c5d56a77d9c296bf7893eebf Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Wed, 9 Apr 2025 16:37:09 -0700 Subject: [PATCH 6/6] 2.8.19 --- pyproject.toml | 2 +- validmind/__version__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 5599b5690..de8472b1c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,7 +10,7 @@ description = "ValidMind Library" license = "Commercial License" name = "validmind" readme = "README.pypi.md" -version = "2.8.18" +version = "2.8.19" [tool.poetry.dependencies] aiohttp = {extras = ["speedups"], version = "*"} diff --git a/validmind/__version__.py b/validmind/__version__.py index c2cb868ca..9d4959085 100644 --- a/validmind/__version__.py +++ b/validmind/__version__.py @@ -1 +1 @@ -__version__ = "2.8.18" +__version__ = "2.8.19"