Skip to content

Training style overhaul + style/accuracy edit #501

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 25 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
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
19 changes: 12 additions & 7 deletions internal/templates/course.qmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
---
title: "{{ course_title }}"
subtitle: For {{< var vm.product >}}
date: last-modified
filters:
- tachyons
format:
html:
css: ../assets/training.css
filters:
- tachyons
- preview
---

As a {{ role }} new to ValidMind, learn how to {{ course_overview }}.
Expand Down Expand Up @@ -31,13 +38,11 @@ As a {{ role }} new to ValidMind, learn how to {{ course_overview }}.
[register](#register){.button-green .cta}
:::

::: {.w-40-ns}
::: {.w-50-ns}
### Preview

<div style="position: relative; display: inline-block; box-shadow: 2px 2px 4px rgba(0, 0, 0, 0.2); border-radius: 5px; border: 1px solid #222425; background: #DE257E;">
<iframe src="{{ preview_url }}" width="400" height="250" style="border:none; border-radius: 5px;"></iframe>
<a href="{{ preview_url }}" target="_blank" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; z-index: 10;"></a>
</div>
::: {.preview source="course-file.qmd"}
:::

:::

Expand All @@ -47,6 +52,6 @@ As a {{ role }} new to ValidMind, learn how to {{ course_overview }}.

:::

{{< include _training-register.qmd >}}
{{< include /training/_training-register.qmd >}}

{{< include _training-support.qmd >}}
{{< include /training/_training-support.qmd >}}
83 changes: 83 additions & 0 deletions internal/templates/fundamentals.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: "Topic<br>Fundamentals"
subtitle: "docs.validmind.ai/training<br><br>_Click [{{< fa chevron-right >}}](#learning-objectives) to start_"
search: false
format:
revealjs:
controls: true
controls-tutorial: true
controls-back-arrows: visible
transition: slide
theme: [default, ../assets/custom.scss]
slide-number: true
chalkboard: false
preview-links: auto
view-distance: 2
logo: /validmind.png
footer: "ValidMind Academy | [Home {{< fa person-walking-dashed-line-arrow-right >}}](/training//training/training.qmd)"
title-slide-attributes:
data-background-color: "#083E44"
data-background-image: "../assets/home-hero.svg"
filters:
- tachyons
---

# Learning objectives

_"Enter objectives here, one, two, and etc."_

## In this course

1. [Link to section]()
2. [Link to section]()
3. [Link to section]()
4. [Link to section]()
5. [Link to section]()

First, let's make sure you can log in and show you around.

{{< include /training/assets/_revealjs-navigation.qmd >}}

## Can you log in?

To try out this course, you need to have been [onboarded](/training/training.qmd#onboarding) onto ValidMind Academy.

<br>Log in to check your access:

::: {.tc}
[Log in to ValidMind](https://app.prod.validmind.ai/){.button target="_blank"}
:::

<div style="text-align: center;">
Be sure to return to this page afterwards.
</div>

## 1

...

## .

...

## 3

...

## 4

...

## 5

...

# Topic summary slide

...

::: {.tc}
[Learn more ...](/about/overview-model-risk-management.qmd){.button target="_blank"}
:::

Or, find your next learning resource on [ValidMind Academy](/training/training.qmd).
25 changes: 13 additions & 12 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -314,18 +314,19 @@ website:
- text: "---"
- support/troubleshooting.qmd

- title: "Training"
contents:
- text: "Training"
file: training/training.qmd
- text: "---"
- text: "FUNDAMENTALS"
- text: "For Administrators"
file: training/administrator-fundamentals-register.qmd
- text: "For Developers"
file: training/developer-fundamentals-register.qmd
- text: "For Validators"
file: training/validator-fundamentals-register.qmd
# TRAINING SIDEBAR
# - title: "[<img src='/validmind.png' style='height:30px;'>](/index.qmd)"
# contents:
# - text: "Training"
# file: training/training.qmd
# - text: "---"
# - text: "FUNDAMENTALS"
# - text: "For Administrators"
# file: training/administrator/administrator-fundamentals-register.qmd
# - text: "For Developers"
# file: training/developer/developer-fundamentals-register.qmd
# - text: "For Validators"
# file: training/validator/validator-fundamentals-register.qmd
# - text: "For model risk governance"
# file: training/training-for-model-risk-governance.qmd

Expand Down
2 changes: 1 addition & 1 deletion site/developer/model-documentation/document-models.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Generate model documentation starting with your model or model predictions, load

- [x] {{< var link.login >}}
- [x] You are the model owner.
- [x] You are a `Developer` or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ValidMind generates a unique _code snippet_ for each registered model to connect

- [x] {{< var link.login >}}
- [x] You are the model owner.
- [x] You are a `Developer` or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]

In order to integrate the {{< var vm.developer >}} and to be able to upload to the {{< var vm.platform >}}, you must provide the following information through a code snippet that you copy from the {{< var validmind.platform >}}:

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

- [x] {{< var link.login >}}
- [x] The model is already registered in the model inventory.[^1]
- [x] You are a `Developer` or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]

:::

Expand Down
6 changes: 3 additions & 3 deletions site/developer/model-documentation/work-with-test-results.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Once generated via the {{< var validmind.developer >}}, view and add the test re

- [x] {{< var link.login >}}
- [x] Test results have already been documented via the {{< var validmind.developer >}} for your model.[^1]
- [x] You are a `Developer` or `Validator`, or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]

:::

Expand All @@ -22,8 +22,8 @@ Once generated via the {{< var validmind.developer >}}, view and add the test re

5. Click {{< fa square-plus >}} and then select **Test-Driven**.[^3]

- By default, the `Developer` role can add test-driven blocks within model documentation or ongoing-monitoring plans.
- By default, the `Validator` role can add test-driven blocks within validation reports.
- By default, the [{{< fa code >}} Developer]{.bubble} role can add test-driven blocks within model documentation or ongoing-monitoring plans.
- By default, the [{{< fa circle-check >}} Validator]{.bubble} role can add test-driven blocks within validation reports.

6. Select test results:

Expand Down
4 changes: 2 additions & 2 deletions site/guide/configuration/_manage-permissions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- To assign a role to a permission, click **+**, then select the permission from the drop-down menu.
- To remove a role from a permission, click **{{< fa x >}}** next to the specified role.

For example, to grant the `Developer` role the permission to update an existing template:
For example, to grant the [{{< fa code >}} Developer]{.bubble} role the permission to update an existing template:

1. Locate **Update Template** under {{< fa clipboard >}} Template.
1. Click **+** and select **Developer** from the drop-down menu.
1. Click **+** and select [**{{< fa code >}} Developer**]{.bubble} from the drop-down menu.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
1. Click **Add Risk Area** to save your changes.

:::: {.content-hidden unless-format="revealjs"}
Once a risk area is added, you can then manage guidelines associated with that risk area and add those guidelines to validation templates: [Manage validation guidelines {{< fa hand-point-right >}}](/guide/model-validation/manage-validation-guidelines.qmd)
Once a risk area is added, you can then manage guidelines associated with that risk area and add those guidelines to validation templates: [Manage validation guidelines {{< fa hand-point-right >}}](/guide/model-validation/manage-validation-guidelines.qmd){target="_blank"}
::::

:::: {.content-visible unless-format="revealjs"}
Expand Down
2 changes: 1 addition & 1 deletion site/guide/configuration/manage-groups.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Users must belong to a default group of `All`, and can belong to mulitple groups
## Prerequisites

- [x] {{< var link.login >}}
- [x] You are a `Customer Admin` or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]

:::

Expand Down
4 changes: 2 additions & 2 deletions site/guide/configuration/manage-permissions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Permissions dictate user access controls within the {{< var validmind.platform >
## Prerequisites

- [x] {{< var link.login >}}
- [x] You are a `Customer Admin` or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]

:::

## Steps

::: {.callout-important title="When assigning permissions to roles, ensure they align with the role's intended responsibilities and access requirements."}
Please note that the `Customer Admin` role has the highest level of access and as such its permissions cannot be modified.
Please note that the [{{< fa hand >}} Customer Admin]{.bubble} role has the highest level of access and as such its permissions cannot be modified.
:::

1. In the left sidebar, click **{{< fa gear >}} Settings**.
Expand Down
4 changes: 2 additions & 2 deletions site/guide/configuration/manage-roles.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Roles are a named set of permissions that determine your users' access to featur
## Prerequisites

- [x] {{< var link.login >}}
- [x] You are a `Customer Admin` or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]

:::

## Add or update roles

::: {.callout-important title="Role permissions and role assignments determines a user's level of access."}
Please note that the `Customer Admin` role has the highest level of access and as such, it cannot be cannot be modified.
Please note that the [{{< fa hand >}} Customer Admin]{.bubble} role has the highest level of access and as such, it cannot be cannot be modified.
:::

1. In the left sidebar, click **{{< fa gear >}} Settings**.
Expand Down
2 changes: 1 addition & 1 deletion site/guide/configuration/manage-users.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Invite new users and review your current users from within the user directory. U
## Prerequisites

- [x] {{< var link.login >}}
- [x] You are a `Customer Admin` or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]

:::

Expand Down
2 changes: 1 addition & 1 deletion site/guide/configuration/managing-your-organization.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You will see the option to switch between organizations only if you belong to mo
## Change organization name

::: {.callout title="To change your organization's name, you must have sufficient organization permissions."}
By default, the `Customer Admin` role has these permissions.[^1]
By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permissions.[^1]
:::

1. In the left sidebar, click **{{< fa gear >}} Settings**.
Expand Down
2 changes: 1 addition & 1 deletion site/guide/configuration/set-up-your-organization.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This task involves managing organizations within ValidMind, allowing for effecti
## Prerequisites

- [x] {{< var link.login >}}
- [x] You are a `Customer Admin` or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ All users associated with a model, such as model developers and model validators
:::: {.content-hidden unless-format="revealjs"}
While working with content blocks in documentation, you can comment directly on specific portions of the text.

All users associated with a model, such as model developers and model validators, will see a notification that a comment has been posted in their **Recent Activity** feed, accessible via the [**{{< fa house >}} Dashboard**](/guide/configuration/customize-your-dashboard.qmd).
All users associated with a model, such as model developers and model validators, will see a notification that a comment has been posted in their **Recent Activity** feed, accessible via the [**{{< fa house >}} Dashboard**](/guide/configuration/customize-your-dashboard.qmd){target="_blank"}.

::::
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@

a. **Add content to sections:**
- For validation report templates, you're able to add additional content.
- Click **{{< fa plus >}}** to add content to that section of the template, such as a **Summary Block** or a [**Guideline Block**](/guide/model-validation/manage-validation-guidelines.qmd#add-guidelines-to-templates).
- Click **{{< fa plus >}}** to add content to that section of the template, such as a **Summary Block** or a [**Guideline Block**](/guide/model-validation/manage-validation-guidelines.qmd#add-guidelines-to-templates){target="_blank"}.

a. **Rename sections:**
- Hover over a section until the **{{< fa pencil >}}** appears, then click on it to change the name.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To locate your document overview for a model:
:::: {.content-hidden unless-format="revealjs"}
1. In the left sidebar, click **Model 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).
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"}.

1. In the left sidebar that appears for your model, click **Documentation**.

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

- [x] {{< var link.login >}}
- [x] The model is already registered in the model inventory.[^1]
- [x] You are a `Developer` or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]

:::

Expand Down
2 changes: 1 addition & 1 deletion site/guide/model-documentation/collaborate-with-others.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the real-time collaboration features to track changes, add comments, and acc
- [x] {{< var link.login >}}
- [x] The model you are documenting is registered in the model inventory.[^1]
- [x] Model documentation has submitted for review or validation by the model validation team.[^2]
- [x] You are a `Developer` or `Validator`, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3]

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The {{< var validmind.product >}} offers robust and fully customizable templates

- [x] {{< var link.login >}}
- [x] The template you want to edit must exist in the {{< var validmind.platform >}}.[^1]
- [x] You are a `Customer Admin` or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]

::: {.callout}
If you are not sure which template or which version of a template your model documentation is using, check the **Documentation** page of your model.[^3] The **Document Template** section in the right sidebar lists the information.
Expand Down
2 changes: 1 addition & 1 deletion site/guide/model-documentation/export-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Export your model documentation or validation reports as Microsoft Word files (`
- [x] {{< var link.login >}}
- [x] The model is already registered in the model inventory.[^1]
- [x] Model documentation is completed or in progress.[^2]
- [x] You are a `Developer` or `Validator`, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3]

::: {.callout}
ValidMind supports Word 365, Word 2019, Word 2016, and Word 2013.
Expand Down
11 changes: 2 additions & 9 deletions site/guide/model-documentation/submit-for-approval.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ When you're ready, verify your model's status, and then submit your model docume
- [x] {{< var link.login >}}
- [x] The model you are documenting is registered in the model inventory.[^1]
- [x] The approval workflow has been configured by an administrator.[^2]
- [x] You are a `Developer` or `Validator`, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3]

::: {.callout title="To configure workflow states and transitions, you must have sufficient workflow permissions."}
By default, the `Customer Admin` role has these permissions.
By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permissions.
:::

:::
Expand All @@ -26,13 +26,6 @@ By default, the `Customer Admin` role has these permissions.

{{< include /guide/model-workflows/_model-workflows-see.qmd >}}

![Summary view of example workflow steps for a model](workflow.png){width=85% fig-alt="A summary view of example workflow steps for a model" class="screenshot"}

While your lifecycle statuses and workflows are custom to your organization, some examples are:

- `In Documentation` — The model is currently being documented and can be submitted for validation next.
- `In Validation` — The model is currently being validated and can be submitted for review and then approval.

## Advance model status

::: {.callout-important title="For you to be able to transition a model through the approval workflow, you must have completed all the previous required workflow steps. "}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Swap between different versions of your model documentation or validation report
## Prerequisites

- [x] {{< var link.login >}}
- [x] You are a `Developer` or `Validator`, or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^1]

:::

Expand Down
Loading
Loading