Skip to content

Merge main into staging #384

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
Sep 17, 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 site/about/contributing/style-guide/voice-and-tone.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ Enable value for your audience, by empowering them.

### Make it accessible
- **Be inclusive.** Knowledge is for everyone, and asks for no qualifications other than curiosity. Use bias-free communication[^1] to break down barriers and acknowledge the diversity of our user base.
- **Not everyone uses technology the same way.** To support as wide an audience as possible, provide alternative means to learn about important concepts. This can include alt tags for images, table headers, and alternative formats such as transcripts for videos.
- **Not everyone uses technology the same way.** To support as wide an audience as possible, provide alternative means to learn about important concepts. This can include captions and alt tags for images, table headers, and alternative formats such as transcripts for videos.

| Correct | Incorrect |
|------|-----|
| The findings are then submitted to the chair of the MRMG (model risk management group), who will then review the recommendations and provide their status assessments. | The findings are then submitted to the chairman of the MRMG, who will then review the recommendations and provide his status assessments. |
| `![](link-evidence.png){fig-alt="A screenshot of the validation report section 2.1.1. that shows a compliance assessment with the option to link to evidence"}` | `![](link-evidence.png)` |
| `![Validation report section 2.1.1. that shows a compliance assessment with the option to link to evidence](link-evidence.png){fig-alt="A screenshot of the validation report section 2.1.1. that shows a compliance assessment with the option to link to evidence"}` | `![](link-evidence.png)` |
: **Bias-free communication & inclusivity** examples {.hover}

## Let's chat
Expand Down
8 changes: 4 additions & 4 deletions site/about/glossary/validation_reports/_review.qmd
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
review
: Entails a comprehensive evaluation process covering four key aspects of model documentation to ensure thoroughness, compliance, and reliability:

- **Conceptual soundness**: Examines the foundational elements of the model, including its overview, intended business use, regulatory requirements, and limitations. Ensures that the model's purpose, scope, and constraints are well-defined and understood by stakeholders.
- **Conceptual soundness** Examines the foundational elements of the model, including its overview, intended business use, regulatory requirements, and limitations. Ensures that the model's purpose, scope, and constraints are well-defined and understood by stakeholders.

- **Data preparation**: Assesses the quality and preparation of the data used for model training. Includes a detailed look at dataset summaries, data quality tests, descriptive statistics, correlations, interactions, and feature engineering. The aim is to verify that the model is built on a robust and relevant dataset.
- **Data preparation** Assesses the quality and preparation of the data used for model training. Includes a detailed look at dataset summaries, data quality tests, descriptive statistics, correlations, interactions, and feature engineering. The aim is to verify that the model is built on a robust and relevant dataset.

- **Model development**: Focuses on the model's development process, including training, evaluation, explainability, interpretability, and diagnosis. Highlights the model’s performance, identifies strengths and weaknesses, and ensures that any potential issues such as overfitting are addressed. Evaluates the assumptions made and examines the qualitative information and judgments to ensure they are conducted appropriately and systematically.
- **Model development** Focuses on the model's development process, including training, evaluation, explainability, interpretability, and diagnosis. Highlights the model’s performance, identifies strengths and weaknesses, and ensures that any potential issues such as overfitting are addressed. Evaluates the assumptions made and examines the qualitative information and judgments to ensure they are conducted appropriately and systematically.

- **Monitoring and governance**: Evaluates the ongoing strategies for monitoring the model's performance and ensuring compliance with regulatory and ethical standards. Involves checking the implementation of the monitoring plan and governance strategies to maintain the model's efficacy over time. Covers reporting outputs to ensure transparency and accuracy in the model's documented results.
- **Monitoring and governance** Evaluates the ongoing strategies for monitoring the model's performance and ensuring compliance with regulatory and ethical standards. Involves checking the implementation of the monitoring plan and governance strategies to maintain the model's efficacy over time. Covers reporting outputs to ensure transparency and accuracy in the model's documented results.

These elements collectively ensure that the model documentation is thorough, transparent, and meets all necessary standards and regulatory requirements.
8 changes: 3 additions & 5 deletions site/guide/configuration/_manage-groups-add.qmd
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
1. Under User Permissions in the sidebar, select **{{< fa users >}} Groups**.

1. Click **{{< fa plus >}} Create New Group** to initiate the group creation process.
1. Next to All Groups, click **{{< fa plus >}} Create New Group** to open the Create New Group menu.

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

To return to the previous screen, click **Back**.
1. Enter a **[group name]{.smallcaps}** and **[group description]{.smallcaps}** for the new group and click **Continue**.

1. Select users from the list to add them to the group.

1. Click **{{< fa check >}} Create Group** to save.

1. Confirm that the new group is created and appears in the list of available groups, ensuring it is correctly configured for its intended use.
Confirm that the new group is created and appears in the list of available groups, ensuring it is correctly configured for its intended use.
2 changes: 1 addition & 1 deletion site/guide/configuration/_manage-roles.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

1. Enter the **Name** and **Description** for the role.
1. Enter the **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.

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

Expand Down
12 changes: 6 additions & 6 deletions site/guide/configuration/_manage-users-invite.qmd
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
1. Under User Permissions, click **{{< fa envelope >}} Invite New Users**.

1. In Invite by Email, enter the user's email address.
1. In Invite by Email:

1. Assign the user to a group from the **Group** dropdown menu.
- Enter the user's **[email]{.smallcaps}** address.
- Assign the user to a group from the **[group]{.smallcaps}** dropdown menu.
- Click **+** under [role]{.smallcap} to open the Assign Roles menu for that user:

1. Click **+** under Roles to open the Assign Roles menu for that user:

- Click **+** next to the role for each role to be assigned.
- Click **{{< fa puzzle-piece >}} Assign Roles to invitee**.
a. Click **+** next to the role for each role to be assigned.
b. Click **Assign Roles to Invitee**.

1. Click **{{< fa envelope >}} Send Invite**.

Expand Down
3 changes: 1 addition & 2 deletions site/guide/configuration/_manage-users-monitor.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
- Monitor the status of invitations in the Pending Invites section.
Monitor the status of invitations in the Pending Invites section.

- Confirm that the new user is successfully added and that their group and roles are correctly configured to meet your access control requirements.

- Review the history of previously accepted invitations in the Invite History section.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
#### Edit business units
Hover over the business unit to rename or delete the unit:

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

::: {.callout-important}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@

1. Click **{{< fa plus >}} Add Risk Area**.

1. Provide a **Name** and **Description** for your risk area.
1. Provide a **[name]{.smallcaps}** and **[description]{.smallcaps}** for your risk area.

1. Click **Add Risk Area** to save your changes, or click **{{< fa x >}}** to cancel.
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)
Expand All @@ -23,9 +23,9 @@ Once a risk area is added, you can then manage guidelines associated with that r

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

1. Make your desired changes to the risk area's **Name** and **Description**.
1. Make your desired changes to the risk area's **[name]{.smallcaps}** and **[description]{.smallcaps}**.

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

#### Delete risk areas

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

1. Click **{{< fa plus >}} 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]{.smallcaps}** and **[category]{.smallcaps}** and click **{{< fa plus >}} Add Use Case** to confirm.

After you confirm, the use case will be added as a new entry in alphabetical order.

Expand Down
15 changes: 6 additions & 9 deletions site/guide/configuration/configure-aws-privatelink.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: "Configure AWS PrivateLink"
date: last-modified
---

To keep your network traffic private and minimizes its attack surface, configure AWS PrivateLink to establish a private connection between ValidMind and your company network.
To keep your network traffic private and minimizes its attack surface, configure AWS PrivateLink[^1] to establish a private connection between ValidMind and your company network.


![AWS PrivateLink](aws-privatelink.png){fig-alt="A graphic showing AWS PrivateLink establishing a private connection to ValidMind"}
![AWS PrivateLink establishing a private connection to ValidMind](aws-privatelink.png){fig-alt="A graphic showing AWS PrivateLink establishing a private connection to ValidMind"}

AWS PrivateLink is a networking service that allows secure and private communication between Amazon Virtual Private Cloud (VPC) resources and services hosted in other VPCs or in AWS partner services, such as ValidMind. With AWS PrivateLink, you can connect to services over the Amazon network, without needing to expose your network traffic to the public internet.

Expand Down Expand Up @@ -90,13 +89,11 @@ Recording: 46:00 FR InfoSec log in and set up endpoint > request pending, need t
c. From your developer environment, confirm that you can connect to ValidMind with the {{< var vm.developer >}}.


<!---
## Troubleshooting
## What's next

[Include any common issues or errors that may arise during the task and how to resolve them.]
After completing these steps, users on your company network can connect to ValidMind via AWS PrivateLink using the private DNS name from the [VPC service information](#vpc-service-information).

--->

## What's next
<!-- FOOTNOTES -->

After completing these steps, users on your company network can connect to ValidMind via AWS PrivateLink using the private DNS name from the [VPC service information](#vpc-service-information).
[^1]: [AWS PrivateLink](https://aws.amazon.com/privatelink/)
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date: last-modified

To keep your network traffic private and minimize its attack surface, configure Private Service Connect to establish a private connection between ValidMind and your company network.

![Private Service Connect](google-cloud-private-service-connect.png)
![Google Private Service Connect establishing a private connection to ValidMind](google-cloud-private-service-connect.png){fig-alt="A graphic showing Google Private Service Connect establishing a private connection to ValidMind"}

Private Service Connect is a networking service that allows secure and private communication between Google Virtual Private Cloud (VPC) resources and services hosted in other VPCs or Google partner services, such as ValidMind. By creating private endpoints within your VPC, Private Service Connect allows you to connect to services over the Google network without needing to expose your network traffic to the public internet.

Expand Down Expand Up @@ -86,7 +86,7 @@ Create a private subnet in a supported GCP region that can be used to expose Val

Create a Private Service Connect endpoint for accessing ValidMind services securely and privately, with service discovery managed via Google Cloud’s Service Directory.

![Creating an endpoint in the Google Cloud Console](gcp-add-validmind-endpoint-panel.png){fig-alt="Screenshot of an endpoint being created with the options specified in the steps."}
![Creating an endpoint in the Google Cloud Console](gcp-add-validmind-endpoint-panel.png){fig-alt="Screenshot of an endpoint being created with the options specified in the steps"}

### Steps

Expand Down Expand Up @@ -123,9 +123,9 @@ After the endpoint is active, test that the service is reachable through the pri

## Create an endpoint to connect to the ValidMind authentication service

Repeat the steps [to create an endpoint to connect to ValidMind](#create-an-endpoint-to-connect-to-validmind) to add another endpoint for the ValidMind authentication service.
Repeat the steps to create an endpoint to connect to ValidMind[^3] to add another endpoint for the ValidMind authentication service.

![Creating an endpoint in the Google Cloud Console](gcp-add-auth-endpoint-panel.png){fig-alt="Screenshot of an endpoint being created with the options specified in the steps."}
![Creating an endpoint in the Google Cloud Console](gcp-add-auth-endpoint-panel.png){fig-alt="Screenshot of an endpoint being created with the options specified in the steps"}

### Steps

Expand All @@ -149,11 +149,13 @@ As a final step, test that everything everything is set up correctly and that yo
1. Under Network Services > Cloud DNS, verify that DNS and service discovery are functioning as expected.

2. Test your connection to the following hosts:
- {{< var validmind.platform >}}: [{{< var gcp.connect >}}]({{< var gcp.connect >}})
- ValidMind authentication service: [{{< var gcp.authentication >}}]({{< var gcp.authentication >}})
- **{{< var validmind.platform >}}** — [{{< var gcp.connect >}}]({{< var gcp.connect >}})
- **ValidMind authentication service** — [{{< var gcp.authentication >}}]({{< var gcp.authentication >}})

<!-- FOOTNOTES -->

[^1]: Google: [Private Service Connect](https://cloud.google.com/vpc/docs/private-service-connect)
[^1]: **Google:** [Private Service Connect](https://cloud.google.com/vpc/docs/private-service-connect)

[^2]: Google: [Private Google Access](https://cloud.google.com/vpc/docs/private-google-access)
[^2]: **Google:** [Private Google Access](https://cloud.google.com/vpc/docs/private-google-access)

[^3]: [Create an endpoint to connect to ValidMind](#create-an-endpoint-to-connect-to-validmind)
8 changes: 5 additions & 3 deletions site/guide/configuration/customize-your-dashboard.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ Changes are automatically saved to your account and do not affect other users.

## Add report widgets

Along with the default Model Findings and Recent Activity widgets, widgets from [Reports](/guide/model-validation/view-reports.qmd) can be added to your dashboard:
Along with the default Model Findings and Recent Activity widgets, widgets from Reports[^1] can be added to your dashboard:

1. In the left sidebar, click **Reports**.

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.

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

You can then rearrange the position of the widget to your liking.[^1]
You can then rearrange the position of the widget to your liking.[^2]

## Remove report widgets

Expand All @@ -50,7 +50,9 @@ To remove a report widget you added:

<!-- FOOTNOTES -->

[^1]: [Rerrange widgets](#rearrange-widgets)
[^1]: [View reports](/guide/model-validation/view-reports.qmd)

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



8 changes: 5 additions & 3 deletions site/guide/configuration/log-in-to-validmind.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,14 @@ Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.

| Name | Provider | Region | URL |
|--|--|--|----------|
| US1 | AWS | us-east-1 | [{{< var url.us1 >}}]({{< var url.us1 >}}) |
| CA1 | AWS | ca-west-1 | [{{< var url.ca1 >}}]({{< var url.ca1 >}}) |
| US1 | AWS | `us-east-1` | [{{< var url.us1 >}}]({{< var url.us1 >}}) |
| CA1 | AWS | `ca-west-1` | [{{< var url.ca1 >}}]({{< var url.ca1 >}}) |

If unsure which URL to use, we recommend US1 or consult your organization for data stewardship requirements.[^1]

2. Click **I already have an account** and choose one of the login options:
2. Click **Sign in to ValidMind**.

3. Choose one of the login options:

- Enter your email address and password, and click **Continue**.
- Select one of the single sign-on (SSO) login options, such as Google, GitHub, or Microsoft, and complete the login steps.
Expand Down
23 changes: 14 additions & 9 deletions site/guide/configuration/manage-groups.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ Users must belong to a default group of `All`, and can belong to mulitple groups

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

3. Expand **See Details {{< fa chevron-right >}}** to:
- View the group's name and description.
- View the complete list of members in any group.
- View models visible to the group.
3. Groups are listed with their names and any provided descriptions.

Expand **See Details {{< fa chevron-right >}}** to:
- View the complete list of members in any group.
- View models visible to the group.

## Add new groups

Expand All @@ -47,6 +48,8 @@ You can only remove non-default groups.

4. Click **{{< fa trash-can >}} Delete Group** to remove it.

After you confirm, the group will be permanently removed.

## Add or remove group members

1. In the left sidebar, click **{{< fa gear >}} Settings**.
Expand All @@ -57,19 +60,21 @@ You can only remove non-default groups.

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

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

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

1. Select members by checking the boxes next to their names in the pop-up.
4. Click **{{< fa plus >}} Add to Group**.

1. Click **{{< fa plus >}} Add to Group**.
Confirm that the new member is added to the correct group.

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

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

1. Select members by checking the boxes next to their names.
2. Select members to be removed from the group by checking the boxes next to their names.

1. Click **{{< fa user-minus >}} Remove Member**.
3. Click **{{< fa user-minus >}} Remove Member**.

After you confirm, the user will be removed from that group.

Expand Down
2 changes: 2 additions & 0 deletions site/guide/configuration/manage-users.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Invite new users and review your current users from within the user directory. U

3. Click the {{< fa xmark >}} next to the role for the user that you want to remove.

After you confirm, that role will be removed from the user.




Expand Down
Loading