Skip to content

Clarify what review means#220

Merged
nrichers merged 5 commits intomainfrom
nrichers/sc-4973/better-guidance-around-what-review-entails
Jun 19, 2024
Merged

Clarify what review means#220
nrichers merged 5 commits intomainfrom
nrichers/sc-4973/better-guidance-around-what-review-entails

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented Jun 18, 2024

Internal Notes for Reviewers

This PR makes an incremental improvement to our validator training and related documentation by being more explicit about what the concept of 'review' entails:

  • Add a glossary entry for 'review' to the main glossary
  • Embed said term into the "Review model documentation" topic that our training links to
  • Update the intro slide for reviewing model documentation in the validator training module

Information here is derived from a combination of how our template structures model documentation by default, chapter 4 of Joshi's "Managing Risk of Financial Models", and a convo with ChatGPT to investigate our current user guide content.

Output

Main glossary

New glossary entry:

image

"Review model documentation" topic

image

Validator training

Before After
image image

External Release Notes

We clarified what the concept of review entails by adding a glossary entry, including that in a new key concepts section in our topic for reviewing model documentation, and updating our validator training to be more explicit. [../../training/training-for-model-validators.html]

@nrichers nrichers added the documentation Improvements or additions to documentation label Jun 18, 2024
Copy link
Copy Markdown
Contributor

@juanmleng juanmleng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Just a suggestion to perhaps expand the review coverage to assumptions, expert judgment, and reporting:

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.

@nrichers
Copy link
Copy Markdown
Collaborator Author

Just a suggestion to perhaps expand the review coverage to assumptions, expert judgment, and reporting

Thank you, @juanmleng! I've made these updates verbatim as suggested.

@nrichers nrichers merged commit 1149b2e into main Jun 19, 2024
@nrichers nrichers deleted the nrichers/sc-4973/better-guidance-around-what-review-entails branch June 19, 2024 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants