Skip to content

Updated docs for validation guideline settings #274

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
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
2 changes: 1 addition & 1 deletion site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -228,9 +228,9 @@ website:
- text: "---"
- text: "MODEL VALIDATION"
# - guide/customize-validation-report-templates.qmd
- guide/model-validation/manage-validation-guidelines.qmd
- file: guide/model-validation/preparing-validation-reports.qmd
contents:
- guide/model-validation/view-validation-guidelines.qmd
- guide/model-validation/review-model-documentation.qmd
- guide/model-validation/assess-compliance.qmd
- guide/model-documentation/work-with-content-blocks.qmd
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 @@ -20,7 +20,7 @@ Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.

## Steps

1. In the left sidebar, navigate to **Model Inventory** and click **+ Register New Model**.[^1]
1. In the left sidebar, navigate to **Model Inventory** and click **{{< fa plus >}} Register New Model**.[^1]

To register a model for use with the QuickStart notebook, select:

Expand Down
2 changes: 2 additions & 0 deletions site/guide/configuration/_business-units.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
A business unit is a distinct segment within your organization that focuses on a specific function, product, or market, operating semi-independently while aligning with the overall organizational goals.

2 changes: 1 addition & 1 deletion site/guide/configuration/_manage-groups-add.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
1. Under User Permissions in the sidebar, select **{{< fa users >}} Groups**.

1. Click **+ Create New Group** to initiate the group creation process.
1. Click **{{< fa plus >}} Create New Group** to initiate the group creation process.

1. Enter a **Group Name** and **Group Description** for the new group and click **Continue**.

Expand Down
2 changes: 1 addition & 1 deletion site/guide/configuration/_manage-permissions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

1. Add or delete roles from a specific permission:
- 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 **x** next to the specified role.
- 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:

Expand Down
6 changes: 3 additions & 3 deletions site/guide/configuration/_manage-roles.qmd
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
1. Under User Permissions, select **{{< fa user-group >}} Roles**.

1. Click **+ Add New Role**.
1. Click **{{< fa plus >}} Add New Role**.

1. Enter the **Name** and **Description** for the role.

1. Once you click **+ Add Role**, you can proceed with managing the permissions and users associated with that role.
1. Once you click **{{< fa plus >}} Add Role**, you can proceed with managing the permissions and users associated with that role.

#### Manage role permissions

Expand Down Expand Up @@ -36,6 +36,6 @@ On the **Users** tab, you can:

##### Delete role from user

1. Click **x** to delete a role from a user.
1. Click **{{< fa x >}}** to delete a role from a user.

1. Once you confirm, that role will be removed from the user.
1 change: 1 addition & 0 deletions site/guide/configuration/_risk-areas.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A risk area is a specific domain within an organization that requires monitoring and management to ensure factors like data quality, model performance, and regulatory compliance are addressed effectively.
Original file line number Diff line number Diff line change
@@ -1,28 +1,26 @@
### Add business units
#### Add business units

:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **{{< fa gear >}} Settings**.
:::: {.content-hidden unless-format="revealjs"}
{{< include /guide/configuration/_business-units.qmd >}}

1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.

1. Type the new business unit name in the dialog box under **Business Units**, then click **+ Add** to confirm.
::::

:::: {.content-hidden unless-format="revealjs"}
A business unit is a distinct segment within your organization that focuses on a specific function, product, or market, operating semi-independently while aligning with the overall organizational goals.
1. Type the new business unit name in the dialog box under **Business Units**.

1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.
1. Click **{{< fa plus >}} Add** to confirm.

1. Type the new business unit name in the dialog box under **Business Units**, then click **+ Add** to confirm.
::::
After you confirm, the business unit will be added as a new entry in alphabetical order.

:::: {.content-visible unless-format="revealjs"}
### Edit business units
1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.
#### Edit business units
Hover over the business unit to rename or delete the unit:

1. Hover over the business unit to:
- Click {{< fa pencil >}} to rename the business unit. Click {{< fa check >}} to save your changes, or {{< fa xmark >}} to discard them.
- Click {{< fa trash-can >}} to remove the business unit.

::: {.callout-important}
In order to delete a business unit, there must be no models attached to that unit.
:::

::::
45 changes: 28 additions & 17 deletions site/guide/configuration/_set-up-your-organization-risk-areas.qmd
Original file line number Diff line number Diff line change
@@ -1,30 +1,41 @@
### Add risk areas
#### Add risk areas

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

1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.

1. Click **+ Add** under Risk Areas.
:::: {.content-hidden unless-format="revealjs"}
{{< include /guide/configuration/_risk-areas.qmd >}}

1. Fill in the risk **Title** and **Description** and click **+ Add Risk Area** to confirm.
1. Under Workplace Settings, select **Risk Areas & Validation Guidelines**.
::::

:::: {.content-hidden unless-format="revealjs"}
A risk area is a specific domain within an organization that requires monitoring and management to ensure factors like data quality, model performance, and regulatory compliance are addressed effectively.
1. Click **{{< fa plus >}} Add Risk Area**.

1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.
1. Provide a **Name** and **Description** for your risk area.

1. Click **+ Add** under Risk Areas.
1. Click **Add Risk Area** to save your changes, or click **{{< fa x >}}** to cancel.

1. Fill in the risk **Title** and **Description** and click **+ Add Risk Area** to confirm.
:::: {.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)
::::

:::: {.content-visible unless-format="revealjs"}
### Remove risk areas
1. In the left sidebar, click **{{< fa gear >}} Settings**.
#### Edit risk areas

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

1. Select **{{< fa pencil>}} Edit Risk Area**.

1. Make your desired changes to the risk area's **Name** and **Description**.

1. Click **Save Risk Area** to save your changes, or click **{{< fa x >}}** to cancel.

#### Delete risk areas

::: {.callout-important}
Any guidelines associated with a risk area will need to be deleted before the risk area can be removed.
:::

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

1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.
1. Select **{{< fa trash-can>}} Delete Risk Area**.

1. Hover over the risk area until the **{{< fa trash-can >}}** appears, then click it delete the risk area.
Once you confirm, that risk area will be removed.
::::
33 changes: 14 additions & 19 deletions site/guide/configuration/_set-up-your-organization-use-cases.qmd
Original file line number Diff line number Diff line change
@@ -1,31 +1,26 @@
### Add use cases
#### Add use cases

:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **{{< fa gear >}} Settings**.
:::: {.content-hidden unless-format="revealjs"}
{{< include /guide/configuration/_use-cases.qmd >}}

1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.

1. Click **+ Add** under Use Cases.

1. Fill in the use case **Title** and **Category** and click **+ Add Use Case** to confirm.

::::

:::: {.content-hidden unless-format="revealjs"}
A use case is a specific application of analytics and management techniques within an organization, such as attrition management, call routing, and regulatory compliance processes like BSA/AML, CCAR, and CECL.

1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.
1. Click **{{< fa plus >}} Add** under Use Cases.

1. Click **+ Add** under Use Cases.
1. Fill in the use case **Title** and **Category** and click **{{< fa plus >}} Add Use Case** to confirm.

1. Fill in the use case **Title** and **Category** and click **+ Add Use Case** to confirm.
::::
After you confirm, the use case will be added as a new entry in alphabetical order.

:::: {.content-visible unless-format="revealjs"}
### Remove use cases
1. In the left sidebar, click **{{< fa gear >}} Settings**.
#### Remove use cases

1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.
::: {.callout-important}
In order to delete a use case, there must be no models associated with it.
:::

1. Hover over the use case until the **{{< fa trash-can >}}** appears.

1. If you are sure you want to remove the use case, click **{{< fa trash-can >}}** to delete it.

1. Hover over the use case until the **{{< fa trash-can >}}** appears, then click it delete the use case.
::::
1 change: 1 addition & 0 deletions site/guide/configuration/_use-cases.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A use case is a specific application of analytics and management techniques within an organization, such as attrition management, call routing, and regulatory compliance processes like BSA/AML, CCAR, and CECL.
15 changes: 4 additions & 11 deletions site/guide/configuration/log-in-to-validmind.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,13 @@ date: last-modified
listing:
- id: private-networks
type: grid
grid-columns: 2
max-description-length: 250
sort: false
fields: [title, description]
contents:
- configure-aws-privatelink.qmd
- configure-google-private-service-connect.qmd
- id: configuration
type: grid
max-description-length: 250
sort: false
fields: [title, description]
contents:
- managing-your-organization.qmd
- managing-users.qmd
- personalize-validmind.qmd
---

Log in to our cloud-hosted {{< var validmind.platform >}} to work with your model documentation, prepare validation reports, or to configure ValidMind for your organization.
Expand Down Expand Up @@ -70,8 +62,9 @@ To configure and log in through a private endpoint for your company VPC using a

## What's next

:::{#configuration}
:::
- [Managing your organization](managing-your-organization.qmd)
- [Managing users](managing-users.qmd)
- [Personalize ValidMind](personalize-validmind.qmd)

<!-- FOOTNOTES -->

Expand Down
4 changes: 2 additions & 2 deletions site/guide/configuration/manage-groups.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ You can only remove non-default groups.

1. Click **{{< fa chevron-right >}} See Details**.

1. Click **+ Add New Member**.
1. Click **{{< fa plus >}} Add New Member**.

1. Select members by checking the boxes next to their names in the pop-up.

1. Click **+ Add to Group**.
1. Click **{{< fa plus >}} Add to Group**.

#### To remove a member from a group:

Expand Down
1 change: 1 addition & 0 deletions site/guide/configuration/managing-users.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ date: last-modified
listing:
- id: whats-next-listing
type: grid
grid-columns: 2
max-description-length: 250
sort: false
fields: [title, description]
Expand Down
1 change: 1 addition & 0 deletions site/guide/configuration/personalize-validmind.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ date: last-modified
listing:
- id: personalize-validmind
type: grid
grid-columns: 2
max-description-length: 250
sort: false
fields: [title, description]
Expand Down
38 changes: 27 additions & 11 deletions site/guide/configuration/set-up-your-organization.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,44 @@ This task involves managing organizations within ValidMind, allowing for effecti

:::

## Business units
## Manage business units

A business unit is a distinct segment within an organization that focuses on a specific function, product, or market, operating semi-independently while aligning with the overall organizational goals.
{{< include _business-units.qmd >}}

{{< include _set-up-your-organization-business-units.qmd >}}
1. In the left sidebar, click **{{< fa gear >}} Settings**.

::: {.callout-important}
In order to delete a business unit, there must be no models attached to that unit.
:::
1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.

1. Add, edit and delete business units as required.

## Risk areas
{{< include _set-up-your-organization-business-units.qmd >}}

## Manage use cases

A risk area is a specific domain within an organization that requires monitoring and management to ensure factors like data quality, model performance, and regulatory compliance are addressed effectively.
{{< include _use-cases.qmd >}}

{{< include _set-up-your-organization-risk-areas.qmd >}}
1. In the left sidebar, click **{{< fa gear >}} Settings**.

## Use cases
1. Under Workplace Settings, select **{{< fa building-columns >}} Organization**.

A use case is a specific application of analytics and management techniques within an organization, such as attrition management, call routing, and regulatory compliance processes like BSA/AML, CCAR, and CECL.
1. Add or and delete use cases as required.

{{< include _set-up-your-organization-use-cases.qmd >}}

## Manage risk areas

{{< include _risk-areas.qmd >}}

::: {.callout title="Risk areas are set up together with your validation guidelines attached to validation reports."}
[Set up validation guidelines {{< fa hand-point-right >}}](/guide/model-validation/manage-validation-guidelines.qmd#set-up-validation-guidelines)
:::

## What's next

- [Managing users](managing-users.qmd)
- [Personalize ValidMind](personalize-validmind.qmd)
- [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd)


<!-- FOOTNOTES -->

Expand Down
11 changes: 2 additions & 9 deletions site/guide/guides.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,13 @@ listing:
contents:
- configuration/managing-your-organization.qmd
- configuration/managing-users.qmd
# - configure-aws-privatelink.qmd
- id: guides-customize
type: grid
max-description-length: 250
sort: false
fields: [title, description]
contents:
- configuration/manage-your-profile.qmd
- configuration/customize-your-dashboard.qmd
- configuration/personalize-validmind.qmd
- id: guides-model-workflows
type: grid
max-description-length: 250
Expand All @@ -40,10 +38,6 @@ listing:
fields: [title, description]
contents:
- model-inventory/working-with-model-inventory.qmd
# - register-models-in-inventory.qmd
# - customize-model-inventory-fields.qmd
# - edit-model-inventory-fields.qmd
# - customize-model-registration-form.qmd
- model-inventory/manage-inventory-custom-fields.qmd
- id: guides-model-documentation
type: grid
Expand All @@ -64,8 +58,7 @@ listing:
- ../developer/samples-jupyter-notebooks.qmd
- id: guides-model-validation
contents:
# - set-up-approval-workflows.qmd
# - customize-validation-report-templates.qmd
- model-validation/manage-validation-guidelines.qmd
- model-validation/preparing-validation-reports.qmd
- model-validation/work-with-model-findings.qmd
- model-validation/view-reports.qmd
Expand Down
Loading
Loading