Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
079c5ba
model-inventory directory > inventory
validbeck Apr 17, 2026
01cd9f8
Renaming files in inventory/
validbeck Apr 17, 2026
8f79cc5
Patching footer, oops
validbeck Apr 17, 2026
df55aaf
Renaming more files in inventory/
validbeck Apr 20, 2026
4a68914
inventory/_embeds edit
validbeck Apr 20, 2026
7d6d655
Model Inventory > Inventory; Model Activity > Activity; anchor link
validbeck Apr 20, 2026
ae0debf
Edit: inventory/ pt1
validbeck Apr 20, 2026
87e7663
Setup for Manage inventory record types
validbeck Apr 21, 2026
2c53b7c
Edit: inventory/pt2
validbeck Apr 21, 2026
4797e52
Rename: Manage model stakeholder types > Manage record stakeholder types
validbeck Apr 21, 2026
62b4d81
Editing: Manage record stakeholder types
validbeck Apr 22, 2026
2667cea
Save point
validbeck Apr 22, 2026
cf4ba57
Save point
validbeck Apr 22, 2026
60c4dee
Edited: Manage record stakeholder types
validbeck Apr 22, 2026
29194a2
Cleanup...
validbeck Apr 22, 2026
e606ab1
Edit: Work with filters
validbeck Apr 22, 2026
186e816
Proofreading
validbeck Apr 22, 2026
da5c6e9
Proofread: Old inventory/ guides
validbeck Apr 22, 2026
0cdad9b
Proofread: Administrator Fundamentals training
validbeck Apr 22, 2026
6b7b4e0
WIP
validbeck Apr 22, 2026
d8ddf15
WIP: Manage inventory record types > Add record types
validbeck Apr 22, 2026
80bbf39
Manage inventory record types draft
validbeck Apr 22, 2026
854e63d
Save point
validbeck Apr 22, 2026
a8ca88a
Editing Administrator Fundamentals training
validbeck Apr 22, 2026
0b8649e
Admin training WIP edit
validbeck Apr 22, 2026
edc8e94
+Record types to admin training
validbeck Apr 22, 2026
a4bd055
Copyright headers
validbeck Apr 23, 2026
c6e5195
Changing installation ref branch, remove after
validbeck Apr 23, 2026
fe5ca51
missed some anchor links
validbeck Apr 23, 2026
f2e3f2a
one more
validbeck Apr 23, 2026
5b56034
Update .github/workflows/validate-docs-site.yaml
validbeck Apr 27, 2026
c8e0323
Resolving merge conflicts
validbeck Apr 27, 2026
ae9fd3f
Fixing borked links
validbeck Apr 27, 2026
ec28ecf
oops, missed one
validbeck Apr 27, 2026
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ When constructing filepaths, including while using [Quarto's Includes](https://q

| Correct | Incorrect |
|---|---|
| `[Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)` | `[Register models in the inventory](../../register-models-in-inventory.qmd)` |
| `[Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)` | `[Register records in the inventory](../../register-records-in-inventory.qmd)` |

### Column layouts

Expand Down
12 changes: 6 additions & 6 deletions internal/templates/single-source/_guides-vs-training.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)]

1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.
1. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**.

::::


<!-- VISIBLE IN TRAINING SLIDES ONLY -->

:::: {.content-hidden unless-format="revealjs"}
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

1. Select a model by clicking on it 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 record or [find your record by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}.

1. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**.

1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.
::::

::::
34 changes: 20 additions & 14 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -199,29 +199,35 @@ website:
<li><a href="/guide/guides.qmd#configuration">Configuration</a></li>
<li><a href="/guide/guides.qmd#integrations">Integrations</a></li>
<li><a href="/guide/guides.qmd#workflows">Workflows</a></li>
<li><a href="/guide/guides.qmd#inventory">Inventory</a></li>
</ul>
<ul class="footer-user-guides-column-2">
<li><a href="/guide/guides.qmd#model-inventory">Model inventory</a></li>
<li><a href="/guide/guides.qmd#documents-templates">Documents & templates</a></li>
<li><a href="/guide/guides.qmd#model-documentation">Model documentation</a></li>
</ul>
<ul class="footer-user-guides-column-3">
<li><a href="/guide/guides.qmd#model-documentation">Documentation</a></li>
<li><a href="/guide/guides.qmd#model-validation">Validation</a></li>
<li><a href="/guide/guides.qmd#reporting">Reporting</a></li>
<li><a href="/guide/guides.qmd#monitoring">Monitoring</a></li>
<li><a href="/guide/guides.qmd#attestation">Attestation</a></li>
</ul>
</div>
</div>
- text: |
<div class="footer-section">
<div class="footer-heading">Library</div>
<ul>
<li><a href="/developer/validmind-library.qmd#for-model-development">For developers</a></li>
<li><a href="/developer/validmind-library.qmd#for-model-validation">For validators</a></li>
<li><a href="/developer/validmind-library.qmd#try-the-code-samples">Code samples</a></li>
<li><a href="/validmind/validmind.qmd">Python API</a></li>
<li><a href="/reference/validmind-rest-api-vm.qmd">Public REST API</a></li>
</ul>
<div class="footer-section footer-library">
<div class="footer-heading">ValidMind Library</div>
<div class="footer-user-guides-columns">
<ul class="footer-user-guides-column-1">
<li><a href="/developer/validmind-library.qmd#quickstart">Quickstarts</a></li>
<li><a href="/developer/validmind-library.qmd#development">Development tutorial</a></li>
<li><a href="/developer/validmind-library.qmd#validation">Validation tutorial</a></li>
</ul>
<ul class="footer-user-guides-column-2">
<li><a href="/developer/how-to/testing-overview.qmd">Run tests & test suites</a></li>
<li><a href="/developer/how-to/feature-overview.qmd">Use library features</a></li>
<li><a href="/developer/samples-jupyter-notebooks.qmd">Code samples</a></li>
<li><a href="/validmind/validmind.qmd">Python API</a></li>
<li><a href="/reference/validmind-rest-api-vm.qmd">Public REST API</a></li>
</ul>
</div>
</div>
- text: |
<div class="footer-section">
Expand All @@ -241,6 +247,7 @@ website:
<li><a href="/support/support.qmd">Get help</a></li>
</ul>
</div>
right:
- text: |
<div class="footer-section">
<div class="footer-heading">Community</div>
Expand All @@ -251,7 +258,6 @@ website:
<li><a href="https://validmind.com/blog/"><i class="fa-solid fa-blog"></i> Blog</a></li>
</ul>
</div>
right: |

format:
html:
Expand Down
20 changes: 11 additions & 9 deletions site/about/contributing/style-guide/conventions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ While the {{< var vm.product >}} community spans far and wide, its heart finds i

| Correct | Incorrect |
|------|-----|
| Register models in the inventory | Inventory model registration |
| Working with the model inventory | Use the model inventory |
| Register records in the inventory | Inventory record registration |
| Working with the inventory | Use the inventory |
| Developer reference | Articles for developers |
: **Titles** examples {.hover}

Expand Down Expand Up @@ -173,7 +173,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o

<!-- AT THE END OF YOUR .QMD PAGE -->
<!-- FOOTNOTES -->
[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)
[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)

[^2]: [Manage model stages](manage-model-stages.qmd)

Expand All @@ -187,28 +187,30 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o
You can use Quarto's ability to display conditional content[^7] to do both in the same file:

```markdown
To view model activity:
To view record activity:

<!-- EMBEDDED FOOTNOTES FOR STANDARD USER GUIDES -->
:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)]

1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.
1. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**.

::::

<!-- INLINE LINKS FOR REVEALJS TRAINING -->
:::: {.content-hidden unless-format="revealjs"}
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

1. Select a model by clicking on it 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 record or [find your record by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}.

1. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**.

1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.
::::

```
| Inline links in training | Footnotes in user guides |
| Inline links in training | Footnotes in user guides |
|------|-----|
| ![Example of inline links in training materials](training_inline-links.png){fig-alt="A screenshot showing an example of inline links in training materials" .screenshot group="links"} | ![Example of margin footnotes in a user guide](user-guide_footenotes.png){fig-alt="A screenshot showing an example of margin footnotes in a user guide" .screenshot group="links"} |
: **Inline vs footnotes links** examples {.hover}
Expand Down
2 changes: 1 addition & 1 deletion site/about/glossary/_attestation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ attestation
: A formal process where attestation participants certify key model information at a specific time. Attestation is part of your audit trail and confirms that governance, documentation, and control requirements are met.

attestation instance
: The invocation of the attestation process on the {{< var validmind.platform >}}. Created when the attestation is triggered by the schedule you set up, it includes a snapshot with model activity and artifacts, questionnaire responses and review status, forming a full record of the review and approval process.
: The invocation of the attestation process on the {{< var validmind.platform >}}. Created when the attestation is triggered by the schedule you set up, it includes a snapshot with record activity and artifacts, questionnaire responses and review status, forming a full record of the review and approval process.

attestation participant
: A user who participates in the attestation workflow as a submitter, reviewer, or approver. Submitters are assigned from model stakeholders; reviewers and approvers are assigned from organizational roles.
Expand Down
8 changes: 4 additions & 4 deletions site/about/glossary/_models.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ For example, consequences of unmitigated model risk can include adverse outcomes
model risk management (MRM)
: A structured approach to identifying, assessing, mitigating, and monitoring risks arising from the use of quantitative and qualitative models within an organization. Ensures that models are developed, validated, and used appropriately, with robust controls in place. Encompasses practices such as maintaining a model inventory, conducting periodic validations, and ensuring proper documentation.

model vendor
: A company that develops, documents, and sells models to financial institutions.
model vendor, record vendor
: A company that develops, documents, and sells models or records to financial institutions.

<span id="vendor-model">vendor model<span>
: A model created by an external source, such as a model vendor.
<span id="vendor-model">vendor model, vendor record<span>
: A model or record created by an external source, such as a vendor.


2 changes: 1 addition & 1 deletion site/about/overview-model-risk-management.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ By integrating these features, {{< var vm.product >}} provides a comprehensive s

<!-- FOOTNOTES -->

[^1]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)
[^1]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)

[^2]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)

Expand Down
4 changes: 2 additions & 2 deletions site/about/use-cases/eu-ai-act.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Integrate all components into a complete compliance workflow addressing Articles
**EUR-Lex:**<br>
[EU AI Act (Regulation (EU) 2024/1689)](https://eur-lex.europa.eu/eli/reg/2024/1689)

[^2]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)
[^2]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)

[^3]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd)

Expand Down Expand Up @@ -255,7 +255,7 @@ Integrate all components into a complete compliance workflow addressing Articles

[^15]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)

[^16]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)
[^16]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)

[^17]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)

4 changes: 2 additions & 2 deletions site/about/use-cases/sr-11-7.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,9 @@ Establish governance framework aligned to SR 11-7.
**Board of Governors of the Federal Reserve System:**<br>
[SR 11-7: Guidance on Model Risk Management](https://www.federalreserve.gov/supervisionreg/srletters/sr1107.htm)

[^2]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)
[^2]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)

[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)
[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)

[^4]: [Working with document templates](/guide/templates/working-with-document-templates.qmd)

Expand Down
4 changes: 2 additions & 2 deletions site/about/use-cases/ss1-23.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,9 @@ Document your proportionality assessment and how it influences your MRM framewor
**Bank of England:**<br>
[SS1/23 – Model risk management principles for banks](https://www.bankofengland.co.uk/prudential-regulation/publication/2023/may/model-risk-management-principles-for-banks-ss)

[^2]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)
[^2]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)

[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)
[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)

[^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Use the ValidMind R package to document and validate models built in R. The pack
- [x] {{< var link.login >}}
- [x] The model you want to connect to is registered in the model inventory.[^1]
- [x] The model document has a template applied.[^2]
- [x] You are the model owner, model validator, or another model stakeholder with write access to the model's documents.[^3]
- [x] You are the record owner, model validator, or another model stakeholder with write access to the model's documents.[^3]

:::

Expand Down Expand Up @@ -220,8 +220,8 @@ pip install -U numba

<!-- FOOTNOTES -->

[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)
[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)

[^2]: [Working with templates](/guide/templates/working-with-document-templates.qmd)

[^3]: [Manage model stakeholders](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-model-stakeholders)
[^3]: [Manage inventory record stakeholders](/guide/inventory/edit-inventory-fields.qmd#manage-inventory-record-stakeholders)
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ listing:
- [x] {{< var link.login >}}
- [x] The model you want to connect to is registered in the model inventory.[^1]
- [x] The model document has a template applied.[^2]
- [x] You are the model owner, model validator, or another model stakeholder with write access to the model's documents.[^3]
- [x] You are the record owner, model validator, or another model stakeholder with write access to the model's documents.[^3]

::: {.callout}
The {{< var validmind.developer >}} requires access to the data sources where relevant datasets and model files are stored in order to help you run tests.
Expand Down Expand Up @@ -74,6 +74,8 @@ A template must already be applied to your selected document to populate test re

:::

<span id="install-validmind"></span>

### Install the {{< var vm.developer >}}

To install the {{< var vm.developer >}}:
Expand Down Expand Up @@ -109,6 +111,8 @@ After you run the code snippet in your environment, the {{< var validmind.develo

:::

<span id="upgrade-validmind"></span>

## Upgrade the {{< var validmind.developer >}}

After installing the {{< var validmind.developer >}},[^8] you'll want to periodically make sure you are on the latest version to access any new features and other enhancements:
Expand Down Expand Up @@ -142,17 +146,17 @@ Version: 2.11.0

<!-- FOOTNOTES -->

[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)
[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)

[^2]: [Working with templates](/guide/templates/working-with-document-templates.qmd)

[^3]: [Manage model stakeholders](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-model-stakeholders)
[^3]: [Manage inventory record stakeholders](/guide/inventory/edit-inventory-fields.qmd#manage-inventory-record-stakeholders)

[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)

[^5]: [Working with model documents](/guide/templates/working-with-model-documents.qmd)

[^6]: [Upgrade the {{< var validmind.developer >}}](#upgrade-the)
[^6]: [Upgrade the {{< var validmind.developer >}}](#upgrade-validmind)

[^7]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)

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

- [x] {{< var link.login >}}
- [x] The model is registered in the model inventory.[^1]
- [x] You are the model owner, model validator, or another model stakeholder with sufficient permissions to perform the tasks in this guide.[^2]
- [x] You are the record owner, model validator, or another model stakeholder with sufficient permissions to perform the tasks in this guide.[^2]

::: {.callout}
Before you follow the steps on this page, we recommend that you first complete our introductory guide on how to [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd).
Expand Down Expand Up @@ -153,11 +153,11 @@ c. Run the cell.

<!-- FOOTNOTES -->

[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)
[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)

[^2]: [Manage model stakeholders](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-model-stakeholders)
[^2]: [Manage inventory record stakeholders](/guide/inventory/edit-inventory-fields.qmd#manage-inventory-record-stakeholders)

[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)

[^4]: [Working with model documents](/guide/templates/working-with-model-documents.qmd)

Expand Down Expand Up @@ -188,8 +188,8 @@ c. Run the cell.

[^6]: [Use credentials in your Jupyter Notebook](#use-credentials-in-your-jupyter-notebook)

[^7]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd#install-the)
[^7]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd#install-validmind)

[^8]: [Enable monitoring](/guide/monitoring/enable-monitoring.qmd)

[^9]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd#install-the)
[^9]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd#upgrade-validmind)
Loading
Loading