-
Notifications
You must be signed in to change notification settings - Fork 4
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
validbeck
merged 12 commits into
main
from
beck/sc-5874/documentation-manage-validation-guidelines
Aug 22, 2024
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
45d9951
Edits to Preparing validation reports
validbeck 00acdb4
Simplified Preparing validation reports
validbeck f8685f1
Draft for validation guideline management
validbeck 0ed9757
Edits to validation guideline management & FA icon tweaks
validbeck b52ec10
Tweaks to listings & summaries
validbeck b1ecefe
Edited listings & what's next sections
validbeck 43abed9
Edits to Set up your organization
validbeck fedcaf0
Single-sourced new risk area instructions
validbeck 60b419d
Edits 2 Set up your org, accomodate new validation guidelines
validbeck 5cb6b5b
Tweaks to the x icon
validbeck efaf7c1
Committed changes manually
validbeck 2bc7d9f
Merged 'main' into beck/sc-5874/documentation-manage-validation-guide…
validbeck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
28 changes: 13 additions & 15 deletions
28
site/guide/configuration/_set-up-your-organization-business-units.qmd
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
45
site/guide/configuration/_set-up-your-organization-risk-areas.qmd
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
33
site/guide/configuration/_set-up-your-organization-use-cases.qmd
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
:::: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.