Skip to content

Merge main into staging #541

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
Nov 22, 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
8 changes: 4 additions & 4 deletions internal/templates/_single-source.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@
<!-- VISIBLE IN USER GUIDES ONlY -->

:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **Model Inventory**.
1. In the left sidebar, click **{{< fa cubes >}} Model 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)]

1. In the expanded sidebar that appears for your model, click **Model Activity**.
1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.

::::


<!-- VISIBLE IN TRAINING SLIDES ONLY -->

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

1. In the expanded sidebar that appears for your model, click **Model Activity**.
1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.

::::
Original file line number Diff line number Diff line change
Expand Up @@ -4490,7 +4490,7 @@ readers do not read off random characters that represent icons */
.fa-skull::before {
content: "\f54c"; }

.fa-tower-broadcast::before {
.fa-wifi::before {
content: "\f519"; }

.fa-broadcast-tower::before {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4490,7 +4490,7 @@ readers do not read off random characters that represent icons */
.fa-skull::before {
content: "\f54c"; }

.fa-tower-broadcast::before {
.fa-wifi::before {
content: "\f519"; }

.fa-broadcast-tower::before {
Expand Down
2 changes: 1 addition & 1 deletion site/_extensions/quarto-ext/fontawesome/assets/css/all.css
Original file line number Diff line number Diff line change
Expand Up @@ -5680,7 +5680,7 @@ readers do not read off random characters that represent icons */
.fa-tornado::before {
content: "\f76f"; }

.fa-tower-broadcast::before {
.fa-wifi::before {
content: "\f519"; }

.fa-broadcast-tower::before {
Expand Down
8 changes: 7 additions & 1 deletion site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,13 @@ website:
file: guide/model-validation/view-filter-model-findings.qmd
- text: "Add and manage findings"
file: guide/model-validation/add-manage-model-findings.qmd
- guide/model-validation/view-reports.qmd
- guide/model-documentation/export-documentation.qmd
- text: "---"
- text: "Reporting"
- file: guide/reporting/working-with-analytics.qmd
contents:
- guide/reporting/view-report-data.qmd
- guide/reporting/manage-custom-reports.qmd
- guide/model-documentation/export-documentation.qmd
- text: "---"
- text: "Monitoring"
Expand Down
12 changes: 6 additions & 6 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 **Model Inventory**. | In the left sidebar, click **model inventory**. |
| In the left sidebar, click **{{< fa cubes >}} Model Inventory**. | In the left sidebar, click **{{< fa cubes >}} model 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,21 +199,21 @@ 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 **Model Inventory**.
1. In the left sidebar, click **{{< fa cubes >}} Model 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)]

1. In the expanded sidebar that appears for your model, click **Model Activity**.
1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.

::::

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

1. In the expanded sidebar that appears for your model, click **Model Activity**.
1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.
::::
```
| Inline links in training | Footnotes in user guides |
Expand All @@ -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 **Model Inventory** on the left sidebar. | In the {{< var validmind.platform >}}, click "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 >}} Model 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
7 changes: 5 additions & 2 deletions 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 Model Inventory feature 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 >}} 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.

:::

Expand All @@ -199,11 +199,14 @@ Model validation and approval

Communication and tracking
: The built-in communication and tracking functionality of {{< var vm.product >}} facilitates seamless collaboration and understanding among stakeholders regarding model usage, limitations, and risks, fostering a collaborative environment as encouraged by these regulations.

By integrating these features, {{< var vm.product >}} provides a comprehensive suite of tools that not only simplifies the path to compliance with SR 11-7 and SS1/23 but also embeds a culture of rigorous and transparent model risk management within the organization.

:::

::::

By integrating these features, {{< var vm.product >}} provides a comprehensive suite of tools that not only simplifies the path to compliance with SR 11-7 and SS1/23 but also embeds a culture of rigorous and transparent model risk management within the organization.


## Ready to try out {{< var vm.product >}}?

Expand Down
2 changes: 1 addition & 1 deletion site/developer/get-started-validmind-library.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The {{< var validmind.developer >}} provides a rich collection of documentation

The {{< var validmind.developer >}} is designed to be model agnostic. If your model is built in Python, the {{< var vm.developer >}} provides all the standard functionality you may need without requiring you to rewrite any functions.

::: {.callout-important collapse="true" appearance="minimal"}
::: {.callout-important collapse="false" appearance="minimal"}
## {{< fa building-columns >}} Key {{< var vm.product >}} concepts

<!--- These concepts were already introduced in the "Get started" section. They are repeated here in a collapsed format in case a reader missed them earlier. --->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ 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 **Model Inventory**.
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.

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

3. In the left sidebar that appears for your model, click **Getting Started**.
3. In the left sidebar that appears for your model, click **{{< fa rocket >}} Getting Started**.

4. 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 @@ -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.

- These credentials can be found on the **Getting Started** page for models registered in the model inventory.
- These credentials can be found on the **{{< fa rocket >}} Getting Started** page for models registered in the model inventory.
- Copy the values from this page and paste them into your `.env` file in the following format:

```yaml
Expand Down
4 changes: 2 additions & 2 deletions site/developer/model-documentation/work-with-test-results.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ 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 **Model Inventory**.
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.

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

3. In the left sidebar that appears for your model, click **Documentation**, **Validation Report**, or **Ongoing Monitoring**.
3. In the left sidebar that appears for your model, click **{{< fa book-open >}} Documentation**, **{{< fa shield >}} Validation Report**, or **{{< fa desktop >}} Ongoing Monitoring**.

4. Locate the test result whose metadata you want to view.

Expand Down
16 changes: 8 additions & 8 deletions site/get-started/platform/explore-sample-model-documentation.qmd
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 **Model Inventory**.
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.

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

Expand All @@ -53,14 +53,14 @@ This is the status that a model starts in as part of the default workflow, as de

4. In the left sidebar that appears for the model, you can find links to:

- The model's **Documentation**[^3]
- The model's **Validation Report**[^4]
- **Ongoing Monitoring** plans[^5] for that model
- Any **Model Findings**[^6]
- All **Model Activity**[^7]
- And **Getting Started** information for integrating with the {{< var validmind.developer >}}[^8]
- The model's **{{< fa book-open >}} Documentation**[^3]
- The model's **{{< fa shield >}} Validation Report**[^4]
- **{{< fa desktop >}} Ongoing Monitoring** plans[^5] for that model
- Any **{{< fa triangle-exclamation >}} Model Findings**[^6]
- All **{{< fa wifi >}} Model Activity**[^7]
- And **{{< fa rocket >}} Getting Started** information for integrating with the {{< var validmind.developer >}}[^8]

5. In the left sidebar, click **Documentation**.
5. In the left sidebar, click **{{< fa book-open >}} Documentation**.

- Your model's documentation is broken down into sections, defined by your documentation templates.[^9]
- Each section can be assigned a completion status,[^10] allowing you to track the progress of your documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Signing up is FREE — {{< var link.register >}}

## Steps

1. In the left sidebar, go to the **Getting Started** section of your previously registered model:[^1]
1. In the left sidebar, go to the **{{< fa rocket >}} Getting Started** section of your previously registered model:[^1]

![Landing page for a model with the Getting Started section highlighted in the left sidebar](platform-getting-started.png){width=90% fig-align="left" fig-alt="A screenshot of the landing page for a model with the Getting Started section highlighted in the left sidebar" .screenshot}
![Landing page for a model with the {{< fa rocket >}} Getting Started section highlighted in the left sidebar](platform-getting-started.png){width=90% fig-align="left" fig-alt="A screenshot of the landing page for a model with the Getting Started section highlighted in the left sidebar" .screenshot}

The page that opens provides you with a _code snippet_ to use with the {{< var validmind.developer >}}, including:

Expand Down
8 changes: 4 additions & 4 deletions 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 **Model Inventory**.
1. In the left sidebar, navigate to **{{< fa cubes >}} Model Inventory**.

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

Expand All @@ -44,10 +44,10 @@ Signing up is FREE — {{< var link.register >}}

In the left sidebar that appears for your model, click on:

a. **Documentation**[^3]
b. **Validation Report**[^4]
a. **{{< fa book-open >}} Documentation**[^3]
b. **{{< fa shield >}} Validation Report**[^4]

![Landing page for a model with the Documentation and Validation Report options highlighted in the left sidebar](platform-first-model.png){width=90% fig-alt="A screenshot showing the landing page for a model with the Documentation and Validation Report options highlighted in the left sidebar" .screenshot}
![Landing page for a model with the {{< fa book-open >}} Documentation and {{< fa shield >}} Validation Report options highlighted in the left sidebar](platform-first-model.png){width=90% fig-alt="A screenshot showing the landing page for a model with the Documentation and Validation Report options highlighted in the left sidebar" .screenshot}

## What's next

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
:::: {.content-hidden unless-format="revealjs"}
{{< include /guide/configuration/_risk-areas.qmd >}}

1. Under Workplace Settings, select **Risk Areas & Validation Guidelines**.
1. Under Workplace Settings, select **{{< fa align-left >}} Risk Areas & Validation Guidelines**.
::::

1. Click **{{< fa plus >}} Add Risk Area**.
Expand Down Expand Up @@ -35,7 +35,7 @@ Any guidelines associated with a risk area will need to be deleted before the ri

1. Hover over the title of a risk area until the **{{< fa ellipsis-vertical >}}** menu appears, then click on it.

1. Select **{{< fa trash-can>}} Delete Risk Area**.
1. Select [**{{< fa trash-can>}} Delete Risk Area**]{.red}.

Once you confirm, that risk area will be removed.
::::
18 changes: 10 additions & 8 deletions site/guide/configuration/customize-your-dashboard.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: "Customize your dashboard"
date: last-modified
---

Customize what you see on your {{< var vm.product >}} dashboard when you first log in. Rearrange the position of widgets, and add your own widgets from reporting for quick access.
Customize what you see on your {{< var vm.product >}} dashboard when you first log in. <!-- Rearrange the position of widgets, and add your own widgets from reporting for quick access. -->

<!-- Ability to add report widgets has been temporarily removed as of the launch of the new analytics page -->

:::{.callout}
Changes are automatically saved to your account and do not affect other users.
Expand All @@ -25,13 +27,13 @@ Changes are automatically saved to your account and do not affect other users.

To resize a widget, hover over the bottom-right corner of a widget until the **{{< fa hand>}}** appears, then adjust the dimensions to your liking.

## Add report widgets
<!-- ## Add report widgets

Along with the default Model Findings and Recent Activity widgets, widgets from Reports[^1] can be added to your dashboard:
Along with the default {{< fa triangle-exclamation >}} Model Findings and Recent Activity widgets, report widgets from Analytics[^1] can be added to your dashboard:

1. In the left sidebar, click **Reports**.
1. In the left sidebar, click **{{< fa square-poll-vertical >}} Analytics**.

2. Hover over the title of the widget you'd like to place on the Dashboard until the **{{< fa ellipsis-vertical>}}** appears, then click on it.
2. Hover over the title of the widget you'd like to place on the {{< fa home >}} Dashboard until the **{{< fa ellipsis-vertical>}}** appears, then click on it.

3. After you select **{{< fa plus>}} Add to Dashboard**, the widget will appear on your personal view of the dashboard.

Expand All @@ -45,14 +47,14 @@ To remove a report widget you added:

2. Hover over the title of a widget you'd like to remove until the **{{< fa ellipsis-vertical>}}** appears, then click on it.

3. After you select **{{< fa trash-can>}} Remove from Dashboard**, the widget will be removed from your personal view of the dashboard.
3. After you select **{{< fa trash-can>}} Remove from Dashboard**, the widget will be removed from your personal view of the dashboard. -->


<!-- FOOTNOTES -->

[^1]: [View reports](/guide/model-validation/view-reports.qmd)
<!-- [^1]: [Working with analytics](/guide/reporting/working-with-analytics.qmd)

[^2]: [Rerrange widgets](#rearrange-widgets)
[^2]: [Rerrange widgets](#rearrange-widgets) -->



2 changes: 1 addition & 1 deletion site/guide/configuration/manage-groups.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ You can only remove non-default groups.

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under User Permissions in the sidebar, select **Groups**.
2. Under User Permissions in the sidebar, select **{{< fa users >}} Groups**.

#### To add a member to a group:

Expand Down
4 changes: 2 additions & 2 deletions site/guide/model-documentation/_add-content-block.qmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
1. In the left sidebar, click **Model Inventory**.
1. In the left sidebar, click **{{< fa cubes >}} Model 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)]

1. In the left sidebar that appears for your model, click **Documentation**, **Validation Report**, or **Ongoing Monitoring**.
1. In the left sidebar that appears for your model, click **{{< fa book-open >}} Documentation**, **{{< fa shield >}} Validation Report**, or **{{< fa desktop >}} Ongoing Monitoring**.

You can now jump to any section of the model documentation, validation report, or ongoing monitoring plan by expanding the table of contents on the left and selecting the relevant section you would like to add content to, such as **1.1 Model Overview**.

Expand Down
Loading