Conversation
There was a problem hiding this comment.
Nice! I particularly love the descriptions as to what monitoring is and what is important.
Some thoughts:
Monitoring scenarios
- Shall we just make it consistent with our love of m-dashes here instead of colons? (Esp since the rest of the page has them already!)
- I would maybe break the paragraphs up a little as that much dense (both visually and information wise) text is hard to parse in a large chunk.
(Pushed a commit for these suggestions, as well as some other minor wording/formatting tweaks.)
Enable monitoring for models & review monitoring results
Since this main page is already so text-heavy / sets up the context, I think it serves better as a landing page... by the time we get to the bottom it's very long.
I propose two new articles under Ongoing monitoring (you can then also put them in "What's next"):
- Enable monitoring for models
- Review (model) monitoring results
|
@validbeck thank you for reviewing and pushing some changes! Much appreciated.
Agreed, it makes sense to split this topic now. I was originally trying to create a placeholder to iterate over in the future, but there's too much content already. Splitting will address this issue.
Related, I had some Mermaid diagrams in there at some point but removed them to save some time. I might see if I can include these to reduce the feeling of text heaviness a bit. |
Updates to address review feedback@validbeck if these updates pass muster with you, could you approve this PR, please? Updated wordingNow refers to "ongoing monitoring" in the glossary, uses "robustness" instead of "effectiveness", and includes references to sample regulations:
Separate task topicsReworked overview topic with some sample output from testing and child topics included below:
Separate task topic for enabling monitoring: Separate task topic for reviewing monitoring results: |
sc-5833/documentation-provide-guidance-on-how-to
PR SummaryThis pull request introduces significant enhancements to the documentation by adding comprehensive sections on monitoring capabilities. The key changes include:
Test Suggestions
|
|
@validbeck I updated this PR with the new style for the "Prerequisites" section, FYI.
|











Internal Notes for Reviewers
This PR adds initial user guide information for ongoing monitoring, including:
Output
New "Monitoring" section on the "Guides" landing page
New "Ongoing monitoring" core docs
New "Ongoing monitoring" tab under "Test descriptions"
Pull in new notebook for ongoing monitoring
New glossary section for monitoring
Other docs where monitoring should be mentioned
External Release Notes
Monitoring is a critical component of model risk management, as emphasized in regulations such as SR 11-7, SS1/23, and E-24. With this release of ValidMind, we officially support ongoing monitoring that you can enable for both existing and new models.
Scenarios where ongoing monitoring is warranted:
As your code runs, the monitoring template for your model automatically populates with data, providing a comprehensive view of your model’s performance over time. You access and examine these results within the ValidMind Platform UI, allowing you to identify any deviations from expected performance and take corrective actions as needed.
Learn more ...