Skip to content

Commit 7a14c9f

Browse files
validbecknrichers
andauthored
quickstart: Model Validation (#750)
* WIP validation quickstart * Validation quickstart draft * Proofreading * Quick edit to key concepts * Edit * More proofreading * QuickStart casing fix * removing future tenses * common-assets > common-steps * tabsets * Update site/get-started/validator/quickstart-validator.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/get-started/validator/quickstart-validator.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Tweak * Fixing numbering --------- Co-authored-by: Nik Richers <nik@validmind.ai>
1 parent ac990db commit 7a14c9f

30 files changed

+243
-86
lines changed

site/about/contributing/style-guide/conventions.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ aliases:
311311
##### Hotlinked
312312

313313
```md
314-
{{{< video https://www.youtube.com/embed/rIR8Mql7eGs?si=vnZA_zP4tAjFjI4r title='ValidMind QuickStart' >}}}
314+
{{{< video https://www.youtube.com/embed/rIR8Mql7eGs?si=vnZA_zP4tAjFjI4r title='ValidMind Quickstart' >}}}
315315
```
316316

317317
##### Embedded

site/about/contributing/style-guide/voice-and-tone.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Address the reader directly by using the second person.
7979

8080
| Correct | Incorrect |
8181
|------|-----|
82-
| After completing this QuickStart, you will be able to view your test results as part of your model documentation right in the {{< var validmind.platform >}}. | After completing this QuickStart, the model developer will be able to view the test results as part of the model documentation right in the {{< var validmind.platform >}}. |
82+
| After completing this quickstart, you will be able to view your test results as part of your model documentation right in the {{< var validmind.platform >}}. | After completing this quickstart, the model developer will be able to view the test results as part of the model documentation right in the {{< var validmind.platform >}}. |
8383
: **2nd person** examples {.hover}
8484

8585
### Avoid stiff formality
Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
template, documentation template
1+
documentation template
22
: Functions as a test suite and lays out the structure of model documentation, segmented into various sections and sub-sections. Documentation templates define the structure of your model documentation, specifying the tests that should be run, and how the results should be displayed.
33

4-
{{< var vm.product >}} templates come with pre-defined sections, similar to test placeholders, including boilerplates and spaces designated for documentation and test results. When rendered, produces a document that model developers can use for model validation.
4+
validation report template
5+
: Serves as a standardized framework for conducting and documenting model validation activities. It outlines the required sections, recommended analyses, and expected validation tests, ensuring consistency and completeness across validation reports. The template helps guide validators through a systematic review process while promoting comparability and traceability of validation outcomes.
6+
7+
{{< var vm.product >}} templates come with pre-defined sections, similar to test placeholders, including boilerplates and spaces designated for test results, evidence, or findings.

site/developer/samples-jupyter-notebooks.qmd

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,31 +40,25 @@ Our Jupyter Notebook code samples showcase the capabilities and features of the
4040

4141
::::
4242

43-
## QuickStart for Customer Churn Model Documentation — Full Suite
43+
## Quickstarts
4444

45-
Learn how to use dataset and model documentation function on a simple customer churn model. The easiest way to try the QuickStart is on JupyterHub or Google Colaboratory:
45+
Learn how to develop or validate a simple customer churn model with {{< var vm.product >}}. The easiest way to try the quickstarts are on JupyterHub:
4646

4747
:::: {.flex .flex-wrap .justify-around}
4848

4949
::: {.w-50-ns}
5050

51-
JupyterHub
52-
: A a web-based platform when you can interact with Jupyter Notebook instances on a shared server. It is commonly used as a collaborative and interactive computing environment for data analysis, scientific research, and programming.
53-
5451
::: {.tc}
55-
[{{< fa code >}} Quickstart on JupyterHub]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart/quickstart_model_documentation.ipynb){.button target="_blank"}
52+
[{{< fa code >}} Quickstart for model documentation]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart/quickstart_model_documentation.ipynb){.button target="_blank"}
5653

5754
:::
5855

5956
:::
6057

6158
::: {.w-40-ns}
6259

63-
Google Colaboratory (Colab)
64-
: A free Jupyter Notebook environment that runs in the cloud. There, you can work with our Jupyter Notebooks by saving your own copy, write and execute code, share your work to collaborate with others in real-time.
65-
6660
::: {.tc}
67-
[{{< fa brands google >}} Quickstart on Colab](https://colab.research.google.com/drive/1NLtjCFUZV2I_ttGUkiAL9uwGZK_SGUlw?usp=share_link){.button target="_blank"}
61+
[{{< fa code >}} Quickstart for model validation]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart/quickstart_model_validation.ipynb){.button target="_blank"}
6862

6963
:::
7064

site/developer/validmind-library.qmd

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ listing:
1818
contents:
1919
- ../notebooks/quickstart/quickstart_model_documentation.ipynb
2020
- ../notebooks/quickstart/quickstart_model_validation.ipynb
21-
# - path: https://youtu.be/rIR8Mql7eGs
22-
# title: "{{< fa brands youtube >}} {{< var vm.product >}} QuickStart"
23-
# description: "Watch the walkthrough on YouTube: `https://youtu.be/rIR8Mql7eGs`"
2421
- id: model-development
2522
type: grid
2623
grid-columns: 2

site/get-started/_sidebar.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ website:
33
- id: get-started
44
title: "Get Started"
55
contents:
6-
- text: "Quickstart For"
6+
- text: "Quickstarts"
77
- text: "Model Development"
88
file: get-started/developer/quickstart-developer.qmd
99
- text: "Model Validation"

site/get-started/administrator/quickstart-administrator.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: "Quickstart — Setup & Administration [coming soon]{.smallercaps .pink}"
3+
subtitle: "10 minutes"
34
date: last-modified
4-
page-layout: full
55
---
66

77
Set up the foundational units for your organization within the {{< var validmind.platform >}}, prepare your organization for users, then grant access to your first user.
88

99
<!-- BECK'S OUTLINE / NOTES -->
1010

11-
<!-- {{< include /get-started/common-assets/_before-you-begin.qmd >}}
11+
<!-- {{< include /get-started/common-steps/_before-you-begin.qmd >}}
1212
1313
## Setting up your organization
1414

site/get-started/common-assets/_before-you-begin.qmd

Lines changed: 0 additions & 8 deletions
This file was deleted.

site/get-started/common-assets/_access-quickstart-notebook.qmd renamed to site/get-started/common-steps/_access-quickstart-notebook.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
You can either load the hosted version of our notebook, or download the notebook to run in your own local environment:
44

5-
#### Load the hosted notebook (recommended)
5+
#### Open the hosted notebook (recommended)
66

77
1. Sign in to [JupyterHub]({{< var url.jupyterhub >}}) with your {{< var vm.product >}} login.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
::: {.attn}
2+
3+
## {{< fa star-of-life >}} Before you begin
4+
5+
- [x] To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}.^[[Register with {{< var vm.product >}}](/guide/configuration/register-with-validmind.qmd)]
6+
- [x] You'll also want to make sure that you're logged into the {{< var validmind.platform >}}.^[ [Log in to {{< var vm.product >}}](/guide/configuration/log-in-to-validmind.qmd)]
7+
8+
:::

0 commit comments

Comments
 (0)