Skip to content

Commit 763b3a1

Browse files
Merge pull request #584 from validmind/update-staging-12281856121
Merge main into staging
2 parents 3fd64bc + b11521a commit 763b3a1

File tree

50 files changed

+251
-120
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+251
-120
lines changed

internal/templates/_single-source.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<!-- VISIBLE IN USER GUIDES ONlY -->
55

66
:::: {.content-visible unless-format="revealjs"}
7-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
7+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
88

99
1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
1010

@@ -16,7 +16,7 @@
1616
<!-- VISIBLE IN TRAINING SLIDES ONLY -->
1717

1818
:::: {.content-hidden unless-format="revealjs"}
19-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
19+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
2020

2121
1. Select a model by clicking on it or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models).
2222

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ In general, follow sentence-style capitalization[^3] to minimize the confusion o
4646
| Correct | Incorrect |
4747
|------|-----|
4848
| Get started with {{< var vm.product >}} | Get Started with {{< var vm.product >}} |
49-
| In the left sidebar, click **{{< fa cubes >}} Model Inventory**. | In the left sidebar, click **{{< fa cubes >}} model inventory**. |
49+
| In the left sidebar, click **{{< fa cubes >}} Inventory**. | In the left sidebar, click **{{< fa cubes >}} inventory**. |
5050
| [Honor the Human with {{< var vm.product >}}](https://validmind.com/honor-the-human-with-validmind/) | [Honor the human with {{< var vm.product >}}](https://validmind.com/honor-the-human-with-validmind/) |
5151
| `On the landing page of your model, locate the [model status]{.smallcaps} section:` | `On the landing page of your model, locate the MODEL STATUS section:` |
5252
: **Sentence case** examples {.hover}
@@ -199,7 +199,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o
199199
200200
<!-- EMBEDDED FOOTNOTES FOR STANDARD USER GUIDES -->
201201
:::: {.content-visible unless-format="revealjs"}
202-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
202+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
203203
204204
1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
205205
@@ -209,7 +209,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o
209209
210210
<!-- INLINE LINKS FOR REVEALJS TRAINING -->
211211
:::: {.content-hidden unless-format="revealjs"}
212-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
212+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
213213
214214
1. Select a model by clicking on it or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models).
215215
@@ -238,7 +238,7 @@ Use emphatic styling sparingly, in order not to overwhelm the reader with visual
238238
| Correct | Incorrect |
239239
|------|-----|
240240
| At {{< var vm.product >}}, we value **transparency and accessibility** — we aim to speak simply and effectively. (e.g. Highlighting the important concept within a sentence.) | **At {{< var vm.product >}}, we value transparency and accessibility — we aim to speak simply and effectively.** (e.g. Highlighting the entire sentence.) |
241-
| In the {{< var validmind.platform >}}, click **{{< fa cubes >}} Model Inventory** on the left sidebar. | In the {{< var validmind.platform >}}, click "{{< fa cubes >}} Model Inventory" on the left sidebar. |
241+
| In the {{< var validmind.platform >}}, click **{{< fa cubes >}} Inventory** on the left sidebar. | In the {{< var validmind.platform >}}, click "{{< fa cubes >}} Inventory" on the left sidebar. |
242242
| *Uncertainty* can be summed up as the difference between reality and the outputs from the model selected to approximate reality. | “Uncertainty” can be summed up as the difference between reality and the outputs from the model selected to approximate reality. |
243243
| “{{< var vm.product >}} is the only platform today that is purpose-built for model risk management professionals in the banking industry,” Jacobi says. | At {{< var vm.product >}}, we value "transparency and accessibility" — we aim to speak simply and effectively. |
244244
: **Emphasis** examples {.hover}

site/about/overview-model-risk-management.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Third line of defense — auditors
183183
: Enabling internal and external audits provides an independent and objective assurance to the organization by assessing the robustness of controls within the model risk management framework. It evaluates how well the first and second lines of defense are functioning, ensuring adherence to regulatory and organizational standards, thereby promoting a robust model risk management environment.
184184

185185
Model inventory
186-
: The {{< var vm.product >}} **{{< fa cubes >}} Model Inventory** encapsulates a centralized repository for all models, aiding in streamlined tracking, management, and monitoring, simplifying compliance with the inventory mandates specified in SR 11-7 and SS1/23.
186+
: The {{< var vm.product >}} **{{< fa cubes >}} Inventory** encapsulates a centralized repository for all models, aiding in streamlined tracking, management, and monitoring, simplifying compliance with the inventory mandates specified in SR 11-7 and SS1/23.
187187

188188
:::
189189

site/developer/model-documentation/install-and-initialize-validmind-library.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The {{< var vm.developer >}} also requires access to the data sources where data
4242

4343
For existing models, this information can be found in the {{< var validmind.platform >}}:
4444

45-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
45+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
4646

4747
2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^3]
4848

site/developer/model-documentation/store-credentials-in-env-file.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Keeing model credentials in a separate file also allows for precise access contr
3333

3434
2. Locate the code snippet for your model:
3535

36-
a. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
36+
a. In the left sidebar, click **{{< fa cubes >}} Inventory**.
3737
b. Select a model by clicking on it or find your model by applying a filter or searching for it.[^3]
3838
c. In the left sidebar that appears for your model, click **{{< fa rocket >}} Getting Started**.
3939
d. Locate the code snippet and click **{{< fa regular copy >}} Copy snippet to clipboard**.

site/developer/model-documentation/work-with-test-results.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ After you have added a test result to your document, you can view the following
4848
- What users wrote those results
4949
- Relevant inputs associated with the result
5050

51-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
51+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
5252

5353
2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^5]
5454

site/faq/faq.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ listing:
3232
title: "Ongoing monitoring and reporting"
3333
categories: ["exports", "analytics", "reports", "ongoing monitoring", "validmind platform"]
3434
- path: faq-testing.qmd
35-
title: "Testing and thresholds"
35+
title: "Testing"
3636
categories: ["testing", "model documentation", "customization", "custom data", "explainability", "ongoing monitoring", "validmind library"]
3737
- path: faq-integrations.qmd
3838
title: "Integrations and support"

site/get-started/platform/explore-sample-model-documentation.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Signing up is FREE — {{< var link.register >}}
3434

3535
## Steps
3636

37-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
37+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
3838

3939
2. Locate or search for the `[QuickStart] Customer Churn Model` and click on it to select it.[^1]
4040

site/get-started/platform/register-your-first-model.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Signing up is FREE — {{< var link.register >}}
2424

2525
## Steps
2626

27-
1. In the left sidebar, navigate to **{{< fa cubes >}} Model Inventory**.
27+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
2828

2929
2. Click **{{< fa plus >}} Register New Model**.[^1]
3030

site/guide/model-documentation/_add-content-block.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
1+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
22

33
1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
44

site/guide/model-documentation/_review-model-documentation.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
To locate your document overview for a model:
22

33
:::: {.content-visible unless-format="revealjs"}
4-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
4+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
55

66
1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
77

@@ -10,7 +10,7 @@ To locate your document overview for a model:
1010
::::
1111

1212
:::: {.content-hidden unless-format="revealjs"}
13-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
13+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
1414

1515
1. Select a model or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="blank"}.
1616

site/guide/model-documentation/assign-documentation-section-statuses.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Assign a completion status to individual sections of your model documentation th
1919

2020
## Steps
2121

22-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
22+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
2323

2424
2. Select a model or find your model by applying a filter or searching for it.[^3]
2525

site/guide/model-documentation/export-documentation.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Export your model documentation or validation reports as Microsoft Word files (`
2424

2525
## Export model documentation
2626

27-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
27+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
2828

2929
2. Select a model or find your model by applying a filter or searching for it.[^4]
3030

@@ -42,7 +42,7 @@ Export your model documentation or validation reports as Microsoft Word files (`
4242

4343
## Export validation report
4444

45-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
45+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
4646

4747
2. Select a model or find your model by applying a filter or searching for it.[^5]
4848

site/guide/model-documentation/swap-documentation-templates.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Swap between different versions of your model documentation or validation report
2222

2323
## View current templates
2424

25-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
25+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
2626

2727
2. Select a model or find your model by applying a filter or searching for it.[^2]
2828

@@ -36,7 +36,7 @@ Swap between different versions of your model documentation or validation report
3636

3737
## Swap templates
3838

39-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
39+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
4040

4141
2. Select a model or find your model by applying a filter or searching for it.[^6]
4242

site/guide/model-documentation/view-documentation-guidelines.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss
2626

2727
## Steps
2828

29-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
29+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
3030

3131
2. Select a model or find your model by applying a filter or searching for it.[^5]
3232

site/guide/model-documentation/work-with-content-blocks.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ When generating content drafts with AI, accepted versions and edits are retained
101101

102102
## Remove content blocks
103103

104-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
104+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
105105

106106
2. Select a model or find your model by applying a filter or searching for it.[^10]
107107

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
1. Click **{{< fa bookmark >}} Select View**.
2+
3+
1. For the view you want to modify, click on **{{< fa ellipsis-vertical >}}** to edit the name or description or to delete the view:
4+
5+
- To edit a view, select **{{< fa pencil >}} Edit View**. Make your edits then click **Save Changes** to apply your adjustments.
6+
- To remove a view, select [**{{< fa trash-can >}} Remove View**]{.red}. Once you confirm, your view will be deleted.
7+
8+
1. Once you confirm, the view will be deleted.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
1. Click **{{< fa bookmark >}} Save View** to save your first view.
2+
3+
To add subsequent saved views, click **{{< fa bookmark >}} Select View**.
4+
5+
1. Select **{{< fa bookmark >}} Save New View**.
6+
7+
1. On the Add New View modal that appears, enter the:
8+
9+
- **[view name]{.smallcaps}**
10+
- **[description]{.smallcaps}** (optional)
11+
12+
1. Click **Add New View** to create your saved view.

site/guide/model-inventory/_view-model-activity-steps.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
To view model activity:
22

33
:::: {.content-visible unless-format="revealjs"}
4-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
4+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
55

66
1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
77

@@ -10,7 +10,7 @@ To view model activity:
1010
::::
1111

1212
:::: {.content-hidden unless-format="revealjs"}
13-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
13+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
1414

1515
1. Select a model or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models).
1616

site/guide/model-inventory/archive-delete-models.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The model inventory within the {{< var validmind.platform >}} should reflect the
3131

3232
To change a model's stage:
3333

34-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
34+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
3535

3636
2. Select a model or find your model by applying a filter or searching for it.[^4]
3737

@@ -66,7 +66,7 @@ If a model was created in error, or you otherwise no longer require a model to b
6666
Model deletion is also permanent and cannot be undone.
6767
:::
6868

69-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
69+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
7070

7171
2. Select a model or find your model by applying a filter or searching for it.[^7]
7272

site/guide/model-inventory/configure-model-interdependencies.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ affected by or affects other models in your inventory.
2121

2222
## View interdependencies
2323

24-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
24+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
2525

2626
2. Select a model or find your model by applying a filter or searching for it.[^3]
2727

@@ -36,7 +36,7 @@ affected by or affects other models in your inventory.
3636

3737
## Edit interdependencies
3838

39-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
39+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
4040

4141
2. Select a model or find your model by applying a filter or searching for it.[^4]
4242

site/guide/model-inventory/customize-model-inventory-layout.qmd

Lines changed: 67 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@ aliases:
66
- ../customize-model-inventory-layout.html
77
---
88

9-
Configure the information that displays on the model inventory, and swap between inventory views.
10-
11-
:::{.callout}
12-
Changes are automatically saved to your account and do not affect other users.
13-
:::
9+
Swap between inventory views or configure the information that displays by default on the model inventory.
1410

1511
::: {.attn}
1612

@@ -21,23 +17,68 @@ Changes are automatically saved to your account and do not affect other users.
2117

2218
:::
2319

24-
## Steps
20+
## Swap between views
21+
22+
:::{.callout}
23+
Changes are automatically saved to your account and do not affect other users.
24+
:::
25+
26+
In the left sidebar, click **{{< fa cubes >}} Inventory**:
27+
28+
Card view
29+
: - To display the inventory in card view, click **Display Cards**.
30+
- By default, the model name, purpose, tier, owner, and status are displayed on each card.
31+
32+
Table view
33+
: - To display the inventory in table view, click **{{< fa table >}} Display Table**.
34+
- Columns on the table view can be customized.[^2]
35+
36+
## Customize table view
37+
38+
:::{.callout}
39+
Changes are automatically saved to your account and do not affect other users.
40+
:::
41+
42+
In addition to sorting and filtering the inventory,[^3] you can add or remove columns and customize the order the columns appear on your table view:[^4]
2543

26-
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
44+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
2745

28-
2. Click **{{< fa table >}} Manage Columns** to manage column visibility and order. To use this feature, make sure you're in table view.[^2]
46+
2. Click **{{< fa table >}} Manage Columns**. To use this feature, make sure you're in table view.
2947

3048
You can toggle visibility for each item and drag each option to change the order:
3149

3250
![Manage Columns in the model inventory](manage-columns-demo.gif){width=90% fig-alt="An animation that shows how to manage columns in the model inventory" .screenshot}
3351

34-
- Available columns are determined by your model inventory fields.[^3]
35-
- For example, to add model stage to your table view, toggle [stage]{.smallcaps}.[^4]
52+
- Available columns are determined by your model inventory fields.[^5]
53+
- For example, to add model stage to your table view, toggle [stage]{.smallcaps}.[^6]
3654

37-
#### Inventory display views
55+
Once customized, you can save a view for later application.[^7]
3856

39-
- To display the inventory in table view, click **{{< fa table >}} Display Table**.
40-
- To display the inventory in card view, click **Display Cards**.
57+
### Manage custom inventory views
58+
59+
:::{.callout}
60+
Saved views are unique to you and do not display for other users in your organization.
61+
:::
62+
63+
#### Save an inventory view
64+
65+
You can save custom table configurations as a view to reapply at any time:
66+
67+
1. Customize a table view.[^8]
68+
69+
You can also apply filters or sorting before saving your view to include them in the view.[^9]
70+
71+
{{< include _save-layout-view.qmd >}}
72+
73+
#### Edit or remove saved inventory view
74+
75+
::: {.callout-important}
76+
Deletion of saved views is permanent.
77+
:::
78+
79+
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
80+
81+
{{< include _remove-layout-view.qmd >}}
4182

4283
## What's next
4384

@@ -49,8 +90,18 @@ Changes are automatically saved to your account and do not affect other users.
4990

5091
[^1]: [Register models in the inventory](register-models-in-inventory.qmd)
5192

52-
[^2]: [Inventory display views](#inventory-display-views)
93+
[^2]: [Customize table view](#customize-table-view)
94+
95+
[^3]: [Working with the model inventory](working-with-model-inventory.qmd)
96+
97+
[^4]: [Inventory display views](#inventory-display-views)
98+
99+
[^5]: [Manage model inventory fields](manage-model-inventory-fields.qmd)
100+
101+
[^6]: [Archive and delete models](archive-delete-models.qmd)
102+
103+
[^7]: [Save new inventory view](#save-new-view)
53104

54-
[^3]: [Manage model inventory fields](manage-model-inventory-fields.qmd)
105+
[^8]: [Customize table view](#customize-table-view)
55106

56-
[^4]: [Archive and delete models](archive-delete-models.qmd)
107+
[^9]: [Working with the model inventory](working-with-model-inventory.qmd)

0 commit comments

Comments
 (0)