You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Edits up until Releases
* Edits for 2024-aug-13 releases
* Adjusted figcaption to center text
* Edits for 2024-jul-22 releases
* Edits for 2024-jun-10 releases
* Edits to overview guides
* Releases tweaks up to June 10 2024
* Edits to march 27 2024 wip
* Final tweaks to march 27 2024
* Edited feb 14 2024
* Edited jan 26 2024
* Edited jan 18 2024
* May 22 2024 releases WIP
* Edited may 22 2024
* Added _how-to-upgrade.qmd single-source
* Added _how-to-upgrade.qmd to newer releases missing it
* Edited nov 09 2023
* Edited oct 25 2023
* WIP Sep 27 2023
* Edited Sep 27 2023
* Tweaks to variable in buttons & links
* Edited aug 15 2023
* Edited jul 24 2023
* Edited jun 22 2023
* Edited may 30 2023
* Visual tweaks
* More cleanup
* Some more tweaks
* Final? edits
* Feedback from Nik
* Maybe the python docs need to be updated on remote?
* Nope, just a docs-demo preview issue
* Release notes to sprint 60 (#483)
* Generate initial release notes
* Fix LUA error
* WIP edits
* Initial edit pass & add images
* Add new button to styles.css
* Clean up styles.css
* WIP more edits
* WIP more edits
* WIP more edits
* Update button style
* WIP edits
* Second edit pass complete
* Add button info to style guide
* Minor edits
* Fix broken link
* Run make get-source
* Final tweaks
* Remove release notes notebook
* Improved hover state for buttons
* Adjusted style guide & README
* Tweak to the convention example
* Oops, I can't spell
* Remove _blank guidance
* Round screenshot corners more
* Add fig-alt text
* Address review comments from Beck
* Add upgrade info and crop screencap
* Ambiguous antecedents are a bad habit
* Visual tweaks
* Summary & final touches
---------
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
---------
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy file name to clipboardExpand all lines: README.md
-8Lines changed: 0 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -101,14 +101,6 @@ When constructing links, refer to the `.qmd` file as Quarto will properly render
101
101
|---|---|
102
102
|`[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.qmd)`|`[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.html)`|
103
103
104
-
The only exceptions are within HTML, such as CSS-styled buttons which necessitate usage of `.html` href links:
> You'll need to pay special attention to these links and manually test them to ensure that they are not broken whenever any changes to file destinations are made.
111
-
112
104
When constructing filepaths, including while using [Quarto's Includes](https://quarto.org/docs/authoring/includes.html) (single-sourcing feature), you'll also want start with the root directory whenever possible as this minimizes usage of unclear relative paths:
Copy file name to clipboardExpand all lines: site/about/contributing/style-guide/conventions.qmd
+46Lines changed: 46 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -119,6 +119,52 @@ Column 2, 50% wide
119
119
- Keep hyperlinks in instructional text minimal — too many links can misdirect the user from the task at hand.
120
120
- When possible — such as any time instructions are not single-sourced — instead of multiple inline links, make use of margin footnotes.[^5]
121
121
- Whenever possible, make the link the title of the destination article. This also solves the issue of links with nebulous descriptions that do not match article titles, or links whose destinations are not clear to the user such as "Read more."
122
+
- When constructing links, refer to the `.qmd` file as Quarto will properly render these into `.html` links on your behalf and check to see if the destinations are able to be resolved.
123
+
- When constructing filepaths, you'll also want start with the root directory whenever possible as this minimizes usage of unclear relative paths.
124
+
125
+
| Correct | Incorrect |
126
+
|------|-----|
127
+
| `[Set up model workflows](/guide/model-workflows/set-up-model-workflows.qmd)` | `[Learn more ...](/../../set-up-model-workflows.html)` |
128
+
: **Inline links** examples {.hover}
129
+
130
+
#### Buttons
131
+
132
+
Sometimes, it's helpful to highlight a call to action with a button that takes you to a topic or to a notebook on JupyterHub.
133
+
134
+
Change any Markdown link into a our theme-styled button by appending `{.button}`:
135
+
136
+
:::: {.flex .flex-wrap .justify-around}
137
+
138
+
::: {.w-30-ns}
139
+
**Correct:**
140
+
141
+
[Set up model workflows](/guide/model-workflows/set-up-model-workflows.qmd){.button}
142
+
143
+
```markdown
144
+
[Set up model workflows](/guide/model-workflows/set-up-model-workflows.qmd){.button}
145
+
```
146
+
147
+
::: {.callout}
148
+
Using a markdown button also enables you to link to to the `.qmd` path instead of the rendered `.html` file.
Copy file name to clipboardExpand all lines: site/about/overview-model-documentation.qmd
+19-5Lines changed: 19 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,16 @@ filters:
5
5
- tachyons
6
6
aliases:
7
7
- ../guide/overview-model-documentation.html
8
+
listing:
9
+
id: quickstart
10
+
type: grid
11
+
grid-columns: 2
12
+
# image-height: 100%
13
+
contents:
14
+
- path: ../get-started/quickstart.qmd
15
+
title: "QuickStart"
16
+
description: "Our QuickStart is the quickest and easiest way to try out our product features."
17
+
fields: [title, description, reading-time]
8
18
---
9
19
10
20
<!---
@@ -15,17 +25,19 @@ Overview & updated graphic
15
25
### Closed beta: LLM testing & documentation
16
26
--->
17
27
18
-
The ValidMind Developer Framework streamlines the process of documenting various types of models. The {{< var vm.developer >}} automates the documentation process, ensuring that your model documentation and testing aligns with regulatory and compliance standards.
28
+
The {{< var validmind.developer >}} streamlines the process of documenting various types of models. The {{< var vm.developer >}} automates the documentation process, ensuring that your model documentation and testing aligns with regulatory and compliance standards.
19
29
20
30
::: {.prereq}
21
31
22
32
## {{< fa code >}} The {{< var validmind.developer >}}
23
33
24
-
The {{< var validmind.developer >}} is a {{< var vm.developer >}} and documentation engine designed to streamline the process of documenting various types of models, including traditional statistical models, legacy systems, artificial intelligence/machine learning models, and large language models (LLMs). It offers model developers a systematic approach to documenting and testing risk models with repeatability and consistency, ensuring alignment with regulatory and compliance standards.
34
+
The {{< var validmind.developer >}} is a {{< var vm.developer >}} and documentation engine designed to streamline the process of documenting various types of models, including traditional statistical models, legacy systems, artificial intelligence/machine learning models, and large language models (LLMs).
35
+
36
+
It offers model developers a systematic approach to documenting and testing risk models with repeatability and consistency, ensuring alignment with regulatory and compliance standards.
25
37
26
38
<!-- Using the variable in alt text messes up the image display -->
27
39
28
-
{width=80% fig-align="center" fig-alt="An image showing the two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind AI risk platform."}
40
+
{width=80% fig-align="center" fig-alt="An image showing the two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind AI risk platform."}
29
41
30
42
The {{< var validmind.developer >}} consists of a client-side library, API integration for models and testing, and validation tests that streamline the model development process. Implemented as a series of independent libraries in Python and R, our {{< var vm.developer >}} ensures compatibility and flexibility with diverse sets of developer environments and requirements.
31
43
@@ -117,7 +129,7 @@ ValidMind imports the following artifacts into the documentation via our API end
117
129
- Output from test and test suites that have been run.
118
130
- Images, plots, visuals that were generated as part of extracting metrics and running tests.
119
131
120
-
{fig-alt="A representation of artifacts imported into the documentation via our API"}
132
+
{width=90% fig-alt="A representation of artifacts imported into the documentation via our SaaS API"}
121
133
122
134
::: {.callout-important title="ValidMind does NOT:"}
123
135
- Send any personal identifiable information (PII) when generating documentation reports.
@@ -126,7 +138,9 @@ ValidMind imports the following artifacts into the documentation via our API end
126
138
127
139
## Ready to try out ValidMind?
128
140
129
-
Our [QuickStart](/get-started/quickstart.qmd) is the quickest and easiest way to try out our product features.
Copy file name to clipboardExpand all lines: site/about/overview-model-risk-management.qmd
+46-20Lines changed: 46 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,16 @@ filters:
5
5
- tachyons
6
6
aliases:
7
7
- ../guide/overview-model-risk-management.html
8
+
listing:
9
+
id: quickstart
10
+
type: grid
11
+
grid-columns: 2
12
+
# image-height: 100%
13
+
contents:
14
+
- path: ../get-started/quickstart.qmd
15
+
title: "QuickStart"
16
+
description: "Our QuickStart is the quickest and easiest way to try out our product features."
17
+
fields: [title, description, reading-time]
8
18
---
9
19
10
20
<!---
@@ -26,17 +36,17 @@ The {{< var validmind.platform >}} provides a comprehensive suite of tools, guid
26
36
27
37
<!-- Using the variable in alt text messes up the image display -->
28
38
29
-
{width=80% fig-align="center" fig-alt="An image showing the two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind AI risk platform."}
39
+
{width=80% fig-align="center" fig-alt="An image showing the two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind AI risk platform."}
30
40
31
41
The {{< var vm.platform >}} employs a multi-tenant architecture, hosting the cloud-based user interface, APIs, databases, and internal services. The design ensures efficient resource utilization and offers a highly scalable solution for organizations of varying sizes.
32
42
33
43
With the {{< var vm.platform >}}, you can:
34
44
35
-
-**Track your model inventory** — Manage the model lifecycle, track the workflow status for models, plan for upcoming validation dates, and more.
36
-
-**Work on validation initiatives** — Collaborate with developers and validators to review documentation, add findings, keep track of review statuses, and generate validation reports.
37
-
-**Configure workflows** — Set up ValidMind to follow your existing model risk management processes, manage statuses for different parts of the workflow, and get an end-to-end view of workflows and who is involved.
38
-
-**Use, create, or edit tests, test suites, and templates** — Create and/or configure required validation tests, test suites, and documentation templates for specific model use cases, tailoring it to your own specific needs.
39
-
-**Integrate with your stack** — Import and export model documentation and validation reports.
45
+
-**Track your model inventory**[^1] — Manage the model lifecycle, track the workflow status for models, plan for upcoming validation dates, and more.
46
+
-**Work on validation initiatives**[^2] — Collaborate with developers and validators to review documentation, add findings, keep track of review statuses, and generate validation reports.
47
+
-**Configure workflows**[^3] — Set up ValidMind to follow your existing model risk management processes, manage statuses for different parts of the workflow, and get an end-to-end view of workflows and who is involved.
48
+
-**Use, create, or edit tests, test suites, and templates**[^4] — Create and/or configure required validation tests, test suites, and documentation templates for specific model use cases, tailoring it to your own specific needs.
49
+
-**Integrate with your stack**[^5] — Import and export model documentation and validation reports.
40
50
41
51
:::
42
52
@@ -51,18 +61,21 @@ Examples of regulations or policies include:
51
61
::: {.w-75-ns}
52
62
53
63
### SR 11-7: Guidance on Model Risk Management
54
-
The Supervisory Guidance on model risk management issued by the Board of Governors of the Federal Reserve System and the Office of the Comptroller of the Currency in the United States in 2011. It provides comprehensive guidance to financial institutions on developing and maintaining a robust model risk management framework, covering aspects like model development, implementation, use, and validation. SR 11-7 is widely recognized and has become a benchmark in the industry for model risk management practices.
64
+
65
+
The Supervisory Guidance on model risk management issued by the Board of Governors of the Federal Reserve System and the Office of the Comptroller of the Currency in the United States in 2011. It provides comprehensive guidance to financial institutions on developing and maintaining a robust model risk management framework, covering aspects like model development, implementation, use, and validation.
55
66
56
67
:::
57
68
58
69
::: {.w-20-ns .content-center}
59
70
60
-
{width=70% fig-alt="Board of Governers Federal Reserve logo"}
71
+
{width=70% fig-alt="Board of Governors Federal Reserve logo"}
61
72
62
73
:::
63
74
64
75
::::
65
76
77
+
SR 11-7 is widely recognized and has become a benchmark in the industry for model risk management practices.
78
+
66
79
SR 11-7 outlines these core requirements:
67
80
68
81
Model Risk Management
@@ -89,18 +102,22 @@ The regulation also mandates ongoing monitoring and periodic reviews to ensure m
89
102
90
103
::: {.w-20-ns .content-center}
91
104
92
-
{fig-alt="Bank of England logo"}
105
+
{fig-alt="Bank of England logo"}
93
106
94
107
:::
95
108
96
109
::: {.w-75-ns}
97
110
98
111
### SS1/23 – Model Risk Management Principles for Banks
99
-
A policy issued by the Prudential Regulation Authority (PRA) in the UK. It encapsulates the final model risk management principles following feedback on the earlier consultation paper CP6/22. The statement provides guidelines for banks in the UK on managing model risk effectively, with particular emphasis on strategic planning and technical capabilities. It outlines principles and amendments, like clarifications on model complexity factors, senior management function responsibilities, and inclusion of dynamic adjustments in model change management, aiming to standardize MRM practices across UK banks and foster the safe adoption of emerging technologies, such as machine learning, artificial intelligence, and large language models (LLMs).
112
+
113
+
A policy issued by the Prudential Regulation Authority (PRA) in the UK. It encapsulates the final model risk management principles following feedback on the earlier consultation paper CP6/22. The statement provides guidelines for banks in the UK on managing model risk effectively, with particular emphasis on strategic planning and technical capabilities.
114
+
100
115
:::
101
116
102
117
::::
103
118
119
+
It outlines principles and amendments, like clarifications on model complexity factors, senior management function responsibilities, and inclusion of dynamic adjustments in model change management, aiming to standardize MRM practices across UK banks and foster the safe adoption of emerging technologies, such as machine learning, artificial intelligence, and large language models (LLMs).
120
+
104
121
SS1/23 outlines these core principles:
105
122
106
123
Model Identification and Model Risk Classification
@@ -163,7 +180,7 @@ ValidMind, as a robust tool for implementing Model Risk Management (MRM) best pr
163
180
164
181
:::: {.flex .flex-wrap .justify-around}
165
182
166
-
::: {.w-50-ns}
183
+
::: {.w-40-ns}
167
184
168
185
First line of defense — model developers
169
186
: ValidMind offers a suite of tools for model developers, facilitating thorough documentation and rigorous testing of models, aligning with the regulatory expectations of both SR 11-7 and SS1/23, particularly for models under regulatory purview.
@@ -177,14 +194,11 @@ Third line of defense — auditors
177
194
Model inventory
178
195
: 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.
179
196
180
-
Lifecycle management and custom workflows
181
-
: ValidMind’s capabilities extend to effective model lifecycle management through configurable workflows. This structured approach to managing model risks across various lifecycle stages significantly aids in meeting the rigorous management and oversight expectations set by SR 11-7 and SS1/23.
182
-
183
197
:::
184
198
185
-
::: {.w-40-ns}
186
-
187
-
{width=90% fig-alt="An image showing the main ValidMind UI main dashboard"}
199
+
::: {.w-50-ns}
200
+
Lifecycle management and custom workflows
201
+
: ValidMind’s capabilities extend to effective model lifecycle management through configurable workflows. This structured approach to managing model risks across various lifecycle stages significantly aids in meeting the rigorous management and oversight expectations set by SR 11-7 and SS1/23.
188
202
189
203
Model documentation automation
190
204
: By automating model documentation through configurable templates and test plans, ValidMind ensures consistent and accurate documentation capture, directly aligning with the documentation standards stipulated in these regulatory guidelines.
@@ -198,10 +212,22 @@ Communication and tracking
198
212
199
213
::::
200
214
201
-
202
-
203
215
By integrating these features, ValidMind provides a comprehensive platform 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.
204
216
205
217
## Ready to try out ValidMind?
206
218
207
-
Our [QuickStart](/get-started/quickstart.qmd) is the quickest and easiest way to try out our product features.
219
+
:::{#quickstart}
220
+
:::
221
+
222
+
223
+
<!-- FOOTNOTES -->
224
+
225
+
[^1]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments