Skip to content

Merge main into staging #584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions internal/templates/_single-source.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<!-- VISIBLE IN USER GUIDES ONlY -->

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

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)]

Expand All @@ -16,7 +16,7 @@
<!-- VISIBLE IN TRAINING SLIDES ONLY -->

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

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).

Expand Down
8 changes: 4 additions & 4 deletions site/about/contributing/style-guide/conventions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ In general, follow sentence-style capitalization[^3] to minimize the confusion o
| Correct | Incorrect |
|------|-----|
| Get started with {{< var vm.product >}} | Get Started with {{< var vm.product >}} |
| In the left sidebar, click **{{< fa cubes >}} Model Inventory**. | In the left sidebar, click **{{< fa cubes >}} model inventory**. |
| In the left sidebar, click **{{< fa cubes >}} Inventory**. | In the left sidebar, click **{{< fa cubes >}} inventory**. |
| [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/) |
| `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:` |
: **Sentence case** examples {.hover}
Expand Down Expand Up @@ -199,7 +199,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o

<!-- EMBEDDED FOOTNOTES FOR STANDARD USER GUIDES -->
:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

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)]

Expand All @@ -209,7 +209,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o

<!-- INLINE LINKS FOR REVEALJS TRAINING -->
:::: {.content-hidden unless-format="revealjs"}
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

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).

Expand Down Expand Up @@ -238,7 +238,7 @@ Use emphatic styling sparingly, in order not to overwhelm the reader with visual
| Correct | Incorrect |
|------|-----|
| 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.) |
| 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. |
| 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. |
| *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. |
| “{{< 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. |
: **Emphasis** examples {.hover}
Expand Down
2 changes: 1 addition & 1 deletion site/about/overview-model-risk-management.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Third line of defense — auditors
: 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.

Model inventory
: 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.
: 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.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The {{< var vm.developer >}} also requires access to the data sources where data

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

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Keeing model credentials in a separate file also allows for precise access contr

2. Locate the code snippet for your model:

a. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
a. In the left sidebar, click **{{< fa cubes >}} Inventory**.
b. Select a model by clicking on it or find your model by applying a filter or searching for it.[^3]
c. In the left sidebar that appears for your model, click **{{< fa rocket >}} Getting Started**.
d. Locate the code snippet and click **{{< fa regular copy >}} Copy snippet to clipboard**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ After you have added a test result to your document, you can view the following
- What users wrote those results
- Relevant inputs associated with the result

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

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

Expand Down
2 changes: 1 addition & 1 deletion site/faq/faq.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ listing:
title: "Ongoing monitoring and reporting"
categories: ["exports", "analytics", "reports", "ongoing monitoring", "validmind platform"]
- path: faq-testing.qmd
title: "Testing and thresholds"
title: "Testing"
categories: ["testing", "model documentation", "customization", "custom data", "explainability", "ongoing monitoring", "validmind library"]
- path: faq-integrations.qmd
title: "Integrations and support"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Signing up is FREE — {{< var link.register >}}

## Steps

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

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

Expand Down
2 changes: 1 addition & 1 deletion site/get-started/platform/register-your-first-model.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Signing up is FREE — {{< var link.register >}}

## Steps

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

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

Expand Down
2 changes: 1 addition & 1 deletion site/guide/model-documentation/_add-content-block.qmd
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

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)]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
To locate your document overview for a model:

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

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)]

Expand All @@ -10,7 +10,7 @@ To locate your document overview for a model:
::::

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

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"}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Assign a completion status to individual sections of your model documentation th

## Steps

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

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

Expand Down
4 changes: 2 additions & 2 deletions site/guide/model-documentation/export-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Export your model documentation or validation reports as Microsoft Word files (`

## Export model documentation

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

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

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

## Export validation report

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Swap between different versions of your model documentation or validation report

## View current templates

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

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

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

## Swap templates

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss

## Steps

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ When generating content drafts with AI, accepted versions and edits are retained

## Remove content blocks

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

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

Expand Down
8 changes: 8 additions & 0 deletions site/guide/model-inventory/_remove-layout-view.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
1. Click **{{< fa bookmark >}} Select View**.

1. For the view you want to modify, click on **{{< fa ellipsis-vertical >}}** to edit the name or description or to delete the view:

- To edit a view, select **{{< fa pencil >}} Edit View**. Make your edits then click **Save Changes** to apply your adjustments.
- To remove a view, select [**{{< fa trash-can >}} Remove View**]{.red}. Once you confirm, your view will be deleted.

1. Once you confirm, the view will be deleted.
12 changes: 12 additions & 0 deletions site/guide/model-inventory/_save-layout-view.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
1. Click **{{< fa bookmark >}} Save View** to save your first view.

To add subsequent saved views, click **{{< fa bookmark >}} Select View**.

1. Select **{{< fa bookmark >}} Save New View**.

1. On the Add New View modal that appears, enter the:

- **[view name]{.smallcaps}**
- **[description]{.smallcaps}** (optional)

1. Click **Add New View** to create your saved view.
4 changes: 2 additions & 2 deletions site/guide/model-inventory/_view-model-activity-steps.qmd
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
To view model activity:

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

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)]

Expand All @@ -10,7 +10,7 @@ To view model activity:
::::

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

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).

Expand Down
4 changes: 2 additions & 2 deletions site/guide/model-inventory/archive-delete-models.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The model inventory within the {{< var validmind.platform >}} should reflect the

To change a model's stage:

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

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

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

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ affected by or affects other models in your inventory.

## View interdependencies

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

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

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

## Edit interdependencies

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

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

Expand Down
83 changes: 67 additions & 16 deletions site/guide/model-inventory/customize-model-inventory-layout.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,7 @@ aliases:
- ../customize-model-inventory-layout.html
---

Configure the information that displays on the model inventory, and swap between inventory views.

:::{.callout}
Changes are automatically saved to your account and do not affect other users.
:::
Swap between inventory views or configure the information that displays by default on the model inventory.

::: {.attn}

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

:::

## Steps
## Swap between views

:::{.callout}
Changes are automatically saved to your account and do not affect other users.
:::

In the left sidebar, click **{{< fa cubes >}} Inventory**:

Card view
: - To display the inventory in card view, click **Display Cards**.
- By default, the model name, purpose, tier, owner, and status are displayed on each card.

Table view
: - To display the inventory in table view, click **{{< fa table >}} Display Table**.
- Columns on the table view can be customized.[^2]

## Customize table view

:::{.callout}
Changes are automatically saved to your account and do not affect other users.
:::

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]

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

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

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

![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}

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

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

- To display the inventory in table view, click **{{< fa table >}} Display Table**.
- To display the inventory in card view, click **Display Cards**.
### Manage custom inventory views

:::{.callout}
Saved views are unique to you and do not display for other users in your organization.
:::

#### Save an inventory view

You can save custom table configurations as a view to reapply at any time:

1. Customize a table view.[^8]

You can also apply filters or sorting before saving your view to include them in the view.[^9]

{{< include _save-layout-view.qmd >}}

#### Edit or remove saved inventory view

::: {.callout-important}
Deletion of saved views is permanent.
:::

1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

{{< include _remove-layout-view.qmd >}}

## What's next

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

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

[^2]: [Inventory display views](#inventory-display-views)
[^2]: [Customize table view](#customize-table-view)

[^3]: [Working with the model inventory](working-with-model-inventory.qmd)

[^4]: [Inventory display views](#inventory-display-views)

[^5]: [Manage model inventory fields](manage-model-inventory-fields.qmd)

[^6]: [Archive and delete models](archive-delete-models.qmd)

[^7]: [Save new inventory view](#save-new-view)

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

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