You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/about/contributing/style-guide/voice-and-tone.qmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -79,7 +79,7 @@ Address the reader directly by using the second person.
79
79
80
80
| Correct | Incorrect |
81
81
|------|-----|
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 >}}. |
: 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.
3
3
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.
Copy file name to clipboardExpand all lines: site/developer/samples-jupyter-notebooks.qmd
+4-10Lines changed: 4 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -40,31 +40,25 @@ Our Jupyter Notebook code samples showcase the capabilities and features of the
40
40
41
41
::::
42
42
43
-
## QuickStart for Customer Churn Model Documentation — Full Suite
43
+
## Quickstarts
44
44
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:
46
46
47
47
:::: {.flex .flex-wrap .justify-around}
48
48
49
49
::: {.w-50-ns}
50
50
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
-
54
51
::: {.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"}
56
53
57
54
:::
58
55
59
56
:::
60
57
61
58
::: {.w-40-ns}
62
59
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
-
66
60
::: {.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"}
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.
8
8
9
9
<!-- BECK'S OUTLINE / NOTES -->
10
10
11
-
<!-- {{< include /get-started/common-assets/_before-you-begin.qmd >}}
11
+
<!-- {{< include /get-started/common-steps/_before-you-begin.qmd >}}
-[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)]
Copy file name to clipboardExpand all lines: site/get-started/common-steps/_get-your-code-snippet.qmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
#### Get your code snippet
2
2
3
-
Before we move on, let's also retrieve the unique *code snippet* for your model that will enable you to connect your testing environment with the correct model in the {{< var validmind.platform >}}:
3
+
Before we move on, let's also retrieve the unique *code snippet* for your model that enables you to connect your testing environment with the correct model in the {{< var validmind.platform >}}:
4
4
5
5
1. In the left sidebar that appears for your model, click **{{< fa rocket >}} Getting Started**.
Copy file name to clipboardExpand all lines: site/get-started/common-steps/_run-quickstart-notebook.qmd
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,11 @@
5
5
To initialize the {{< var validmind.developer >}} which connects your environment to the correct model in the {{< var validmind.platform >}}, you'll need your unique code snippet!^[[Get your code snippet](#get-your-code-snippet)]
6
6
:::
7
7
8
-
1. Follow the instructions to run the first two code cells in the notebook,[^longnote] which will set the stage by installing and initializing {{< var vm.product >}}.^[[Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd)]
8
+
1. Follow the instructions to run the first two code cells in the notebook,[^longnote] which sets the stage by installing and initializing {{< var vm.product >}}.^[[Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd)]
9
9
10
10
1. Under the cell at bottom of the **Get your code snippet** section, confirm that you see a success message verifying that you've connected to the right model.
11
11
12
-
This message verifies that the {{< var vm.developer >}} works as expected as is connected to the correct model within the {{< var vm.platform >}}.
12
+
This message verifies that the {{< var vm.developer >}} works as expected as is connected to the correct model and document type within the {{< var vm.platform >}}.
Register your first model, use the {{< var validmind.developer >}} to run tests and document a model, then review your generated model documentation within the {{< var validmind.platform >}}.
25
25
26
-
{{< include /get-started/common-assets/_before-you-begin.qmd >}}
26
+
{{< include /get-started/common-steps/_before-you-begin.qmd >}}
27
27
28
28
## Register your first model
29
29
30
30
The first step to using {{< var vm.product >}} to develop models is to register them in your model inventory:
31
31
32
-
{{< include /get-started/common-assets/_register-your-first-model.qmd >}}
32
+
{{< include /get-started/common-steps/_register-your-first-model.qmd >}}
33
33
34
34
::: {.column-margin}
35
35
{width=90% fig-alt="A screenshot showing the registration modal with the options filled out for the model development quickstart" .screenshot}
36
36
:::
37
37
38
-
{{< include /get-started/common-assets/_get-your-code-snippet.qmd >}}
38
+
{{< include /get-started/common-steps/_get-your-code-snippet.qmd >}}
39
39
40
40
::: {.column-margin}
41
41
{width=90% fig-alt="A screenshot showing the Getting Started page with a sample code snippet" .screenshot}
42
42
:::
43
43
44
44
## Using the {{< var validmind.developer >}}
45
45
46
-
Next, let's set up the {{< var validmind.developer >}} in your developer environment of choice so we can use it to run and log tests, which will help automate the documentation of your models.
46
+
Next, let's set up the {{< var validmind.developer >}} in your development environment of choice so we can use it to run and log tests, which helps automate the documentation of your models.
47
47
48
-
Our companion notebook, **Quickstart for model documentation,**[^3] will walk you through the steps of installing the {{< var vm.developer >}} in your environment, initializing the {{< var vm.developer >}} for use, and running a full suite of documentation tests that will log the results to the {{< var validmind.platform >}}.
48
+
Our companion notebook, **Quickstart for model documentation,**[^1] walks you through the steps of installing the {{< var vm.developer >}} in your environment, initializing the {{< var vm.developer >}} for use, and running a full suite of documentation tests that logs results to the {{< var validmind.platform >}}.
49
49
50
-
{{< include /get-started/common-assets/_access-quickstart-notebook.qmd >}}
50
+
{{< include /get-started/common-steps/_access-quickstart-notebook.qmd >}}
51
51
52
-
<!-- NOT LIVE ON JUPYTERHUB YET, HASN'T BEEN UPDATED -->
53
52
1. Open [Quickstart for model documentation]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart/quickstart_model_documentation.ipynb) and [run the quickstart notebook](#run-the-quickstart-notebook).
54
53
55
-
{{< include /get-started/common-assets/_download-notebooks.qmd >}}
54
+
#### Download the notebooks
56
55
57
-
1. After the cloning process is complete, open `notebooks/quickstart/quickstart_model_documentation.ipynb` in your developer environment and [run the quickstart notebook](#run-the-quickstart-notebook).
56
+
::: {.panel-tabset}
58
57
59
-
{{< include /get-started/common-assets/_download-code-samples.qmd >}}
58
+
{{< include /get-started/common-steps/_download-notebooks.qmd >}}
60
59
61
-
1.Open `notebooks/quickstart/quickstart_model_documentation.ipynb` in your developer environment and [run the quickstart notebook](#run-the-quickstart-notebook).
60
+
1.After the cloning process is complete, open `notebooks/quickstart/quickstart_model_documentation.ipynb` in your development environment and [run the quickstart notebook](#run-the-quickstart-notebook).
62
61
63
-
{{< include /get-started/common-assets/_run-quickstart-notebook.qmd >}}
62
+
{{< include /get-started/common-steps/_download-code-samples.qmd >}}
63
+
64
+
1. Open `notebooks/quickstart/quickstart_model_documentation.ipynb` in your development environment and [run the quickstart notebook](#run-the-quickstart-notebook).
65
+
66
+
:::
67
+
68
+
{{< include /get-started/common-steps/_run-quickstart-notebook.qmd >}}
64
69
65
70
::: {.column-margin}
66
71
**Example success message:**
67
72
68
73
```bash
69
-
2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to {{< var vm.product >}}!
70
-
📊 Model: [ValidMind] Model development quickstart (ID: cmalgf3qi02ce199qm3rdkl46)
74
+
2025-06-10 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to {{< var vm.product >}}!
75
+
📊 Model: [ValidMind] Model development quickstart (ID: cmbpnxrv6012o0g9w5049nsct)
71
76
📁 Document Type: model_documentation
72
77
```
73
78
:::
@@ -80,34 +85,38 @@ After you successfully run the notebook, return to the {{< var validmind.platfor
80
85
81
86
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
82
87
83
-
2. Locate or search for the model you registered for this quickstart and click on it to select it.[^4]
88
+
2. Locate or search for the model you registered for this quickstart and click on it to select it.[^2]
84
89
85
-
3. In the left sidebar that appears for the model, click **{{< fa book-open >}} Documentation**.
90
+
3. In the left sidebar that appears for the model, click **{{< fa book-open >}} Documentation**:
86
91
87
-
- Your model's documentation is broken down into sections, defined by your documentation templates.[^5]
88
-
- Each section can be assigned a completion status,[^6] allowing you to track the progress of your documentation.
92
+
- Your model's documentation is broken down into sections, defined by your documentation templates.[^3]
93
+
- Each section can be assigned a completion status,[^4] allowing you to track the progress of your documentation.
89
94
90
95
4. Click on any section of the documentation to review the test results and drafts of test result summaries generated by the {{< var validmind.developer >}}.
91
96
92
-
In any subsection, expand the **{{< var vm.product >}} Insights™** panel to view the Documentation Guidelines[^7] that tell you more about what these sections mean and help you with the task of documenting the model as a developer.
97
+
In any subsection, expand the **{{< var vm.product >}} Insights™** panel to view the Documentation Guidelines[^5] that tell you more about what these sections mean and help you with the task of documenting the model as a developer.
98
+
99
+
5. Refine your model documentation by:
100
+
101
+
- Adding or editing content blocks[^6]
102
+
- Adding additional test results after you've logged them[^7]
93
103
94
104
:::: {.flex .flex-wrap .justify-around}
95
105
96
106
::: {.w-40-ns .tc}
97
107
98
-
{width=90% fig-alt="A screenshot showing an example model details page with documentation outline" .screenshot group="documentation"}
108
+
{fig-alt="A screenshot showing an example model details page with documentation outline" .screenshot group="documentation"}
99
109
100
110
:::
101
111
102
112
::: {.w-40-ns .tc}
103
113
104
-
{width=90% fig-alt="A screenshot showing populated model documentation section with the ValidMind Insights™ panel open" .screenshot group="documentation"}
114
+
{fig-alt="A screenshot showing populated model documentation section with the ValidMind Insights™ panel open" .screenshot group="documentation"}
105
115
106
116
:::
107
117
108
118
::::
109
119
110
-
111
120
## What's next
112
121
113
122
Now that you've grasped the basics of using {{< var vm.product >}} for model development, continue on your journey with our end-to-end training course for developers and browse through our resource hub for the {{< var validmind.developer >}}:
@@ -118,16 +127,16 @@ Now that you've grasped the basics of using {{< var vm.product >}} for model dev
118
127
119
128
<!-- FOOTNOTES -->
120
129
121
-
[^1]: [Register with {{< var vm.product >}}](/guide/configuration/register-with-validmind.qmd)
130
+
[^1]: [Quickstart for model documentation](/notebooks/quickstart/quickstart_model_documentation.ipynb)
122
131
123
-
[^2]: [Log in to {{< var vm.product >}}](/guide/configuration/log-in-to-validmind.qmd)
132
+
[^2]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
124
133
125
-
[^3]: [Quickstart for model documentation](/notebooks/quickstart/quickstart_model_documentation.ipynb)
134
+
[^3]: [Working with documentation templates](/guide/templates/working-with-documentation-templates.qmd)
126
135
127
-
[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
0 commit comments