Skip to content

Fix quickstart typos #96

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
Jun 12, 2023
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
2 changes: 1 addition & 1 deletion site/_site/guide/explore-validmind.html
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ <h2 class="anchored" data-anchor-id="explore-the-validmind-platform">Explore the
</div>
<p>This content is <em>generated</em> by the ValidMind Developer Framework and provides information about the dataset used, including histograms, information about dataset quality, and test results.</p>
<p>Sections that need your attention get flagged with <code>Requires Attention</code>. These sections get flagged <em>automatically</em> by the Developer Framework whenever a test result is above or below a certain threshold.</p></li>
<li><p>From the left sidebar, select <strong>3. Model Development</strong> and any of the subsection to see information that has been uploaded by the Developer Framework about:</p>
<li><p>From the left sidebar, select <strong>3. Model Development</strong> and any of the subsections to see information that has been uploaded by the Developer Framework about:</p>
<ul>
<li>Model training</li>
<li>Model evaluation</li>
Expand Down
2 changes: 1 addition & 1 deletion site/_site/guide/get-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ <h1 class="title">Get started</h1>

<section id="welcome-to-validmind" class="level2">
<h2 class="anchored" data-anchor-id="welcome-to-validmind">Welcome to ValidMind!</h2>
<p>ValidMind is a solution designed to help simplify and automate key aspects of model risk management (MRM) activities for model developers and model validators alike. The platform helps automate model documentation, validation, and testing. In addition, the platform offers with built-in communication and tracking features that enable all stakeholders to collaborate and communicate effectively throughout the model risk management process, ensuring that everyone is informed and up-to-date.</p>
<p>ValidMind is a solution designed to help simplify and automate key aspects of model risk management (MRM) activities for model developers and model validators alike. The platform helps automate model documentation, validation, and testing. In addition, the platform offers built-in communication and tracking features that enable all stakeholders to collaborate and communicate effectively throughout the model risk management process, ensuring that everyone is informed and up-to-date.</p>
</section>
<section id="how-does-it-work" class="level2">
<h2 class="anchored" data-anchor-id="how-does-it-work">How does it work?</h2>
Expand Down
6 changes: 3 additions & 3 deletions site/_site/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -221,14 +221,14 @@
"href": "guide/get-started.html",
"title": "Get started",
"section": "",
"text": "ValidMind is a solution designed to help simplify and automate key aspects of model risk management (MRM) activities for model developers and model validators alike. The platform helps automate model documentation, validation, and testing. In addition, the platform offers with built-in communication and tracking features that enable all stakeholders to collaborate and communicate effectively throughout the model risk management process, ensuring that everyone is informed and up-to-date."
"text": "ValidMind is a solution designed to help simplify and automate key aspects of model risk management (MRM) activities for model developers and model validators alike. The platform helps automate model documentation, validation, and testing. In addition, the platform offers built-in communication and tracking features that enable all stakeholders to collaborate and communicate effectively throughout the model risk management process, ensuring that everyone is informed and up-to-date."
},
{
"objectID": "guide/get-started.html#welcome-to-validmind",
"href": "guide/get-started.html#welcome-to-validmind",
"title": "Get started",
"section": "",
"text": "ValidMind is a solution designed to help simplify and automate key aspects of model risk management (MRM) activities for model developers and model validators alike. The platform helps automate model documentation, validation, and testing. In addition, the platform offers with built-in communication and tracking features that enable all stakeholders to collaborate and communicate effectively throughout the model risk management process, ensuring that everyone is informed and up-to-date."
"text": "ValidMind is a solution designed to help simplify and automate key aspects of model risk management (MRM) activities for model developers and model validators alike. The platform helps automate model documentation, validation, and testing. In addition, the platform offers built-in communication and tracking features that enable all stakeholders to collaborate and communicate effectively throughout the model risk management process, ensuring that everyone is informed and up-to-date."
},
{
"objectID": "guide/get-started.html#how-does-it-work",
Expand Down Expand Up @@ -578,7 +578,7 @@
"href": "guide/explore-validmind.html#explore-the-validmind-platform",
"title": "Explore ValidMind",
"section": "Explore the ValidMind Platform",
"text": "Explore the ValidMind Platform\nNext, let’s take a look at how the Developer Framework works hand-in-hand with the ValidMind Platform and how documentation and test results get uploaded.\nThe ValidMind Platform is the central place to:\n\nView results and documentation uploaded via the Developer Framework\nCollaborate with other model developers, model reviewers and validators, and other users involved in the documentation and validation workflow\n\n\n\n\n\n\n\nLog in to the ValidMind UI.\nFrom the side navigation, select Model Inventory.\nLocate or search for the [Quickstart] Customer Churn Model - Initial Validation and select it.\nOn the model details page that open, you can find important information about the model, such as:\n\nThe ID of the model and its specific use case\nThe owners, developers, validators, and business unit associated with the model\nThe risk tier and current version\nAnd more\n\nScroll down to Documentation Project History and select the model.\nOn the project overview page that opens, you can see what is included, such as model, project findings, recent activity, and project stakeholders, and more. In the left sidebar, you can find links to the documentation, project findings, validation report, audit trail, and client integration.\nFor this Quickstart, we will focus on the Documentation section to show you how content from the Developer Framework gets uploaded.\nNote that the model status is In Documentation. This is the status that a model starts in as part of a documentation project. You can click See workflow to look at what the full workflow is, from documentation, to validation, to review, and finally approval.\nFrom the left sidebar, select Documentation &gt; 2. Data preparation &gt; 2.1. Data description.\n\n\n\n\n\nThis content is generated by the ValidMind Developer Framework and provides information about the dataset used, including histograms, information about dataset quality, and test results.\nSections that need your attention get flagged with Requires Attention. These sections get flagged automatically by the Developer Framework whenever a test result is above or below a certain threshold.\nFrom the left sidebar, select 3. Model Development and any of the subsection to see information that has been uploaded by the Developer Framework about:\n\nModel training\nModel evaluation\nModel explainability and interpretability\nModel diagnosis\n\nThe Documentation Guidelines in the ValidMind Insights right sidebar can tell you more about what these sections mean and help you with the task of documenting the model.\nFinally, take a look at section 4. Monitoring and Governance.\nSections like 4.1 Monitoring Plan are not generated by the Developer Framework, but they get added by the model developer in the Platform UI."
"text": "Explore the ValidMind Platform\nNext, let’s take a look at how the Developer Framework works hand-in-hand with the ValidMind Platform and how documentation and test results get uploaded.\nThe ValidMind Platform is the central place to:\n\nView results and documentation uploaded via the Developer Framework\nCollaborate with other model developers, model reviewers and validators, and other users involved in the documentation and validation workflow\n\n\n\n\n\n\n\nLog in to the ValidMind UI.\nFrom the side navigation, select Model Inventory.\nLocate or search for the [Quickstart] Customer Churn Model - Initial Validation and select it.\nOn the model details page that open, you can find important information about the model, such as:\n\nThe ID of the model and its specific use case\nThe owners, developers, validators, and business unit associated with the model\nThe risk tier and current version\nAnd more\n\nScroll down to Documentation Project History and select the model.\nOn the project overview page that opens, you can see what is included, such as model, project findings, recent activity, and project stakeholders, and more. In the left sidebar, you can find links to the documentation, project findings, validation report, audit trail, and client integration.\nFor this Quickstart, we will focus on the Documentation section to show you how content from the Developer Framework gets uploaded.\nNote that the model status is In Documentation. This is the status that a model starts in as part of a documentation project. You can click See workflow to look at what the full workflow is, from documentation, to validation, to review, and finally approval.\nFrom the left sidebar, select Documentation &gt; 2. Data preparation &gt; 2.1. Data description.\n\n\n\n\n\nThis content is generated by the ValidMind Developer Framework and provides information about the dataset used, including histograms, information about dataset quality, and test results.\nSections that need your attention get flagged with Requires Attention. These sections get flagged automatically by the Developer Framework whenever a test result is above or below a certain threshold.\nFrom the left sidebar, select 3. Model Development and any of the subsections to see information that has been uploaded by the Developer Framework about:\n\nModel training\nModel evaluation\nModel explainability and interpretability\nModel diagnosis\n\nThe Documentation Guidelines in the ValidMind Insights right sidebar can tell you more about what these sections mean and help you with the task of documenting the model.\nFinally, take a look at section 4. Monitoring and Governance.\nSections like 4.1 Monitoring Plan are not generated by the Developer Framework, but they get added by the model developer in the Platform UI."
},
{
"objectID": "guide/explore-validmind.html#create-a-new-documentation-project",
Expand Down
2 changes: 1 addition & 1 deletion site/guide/explore-validmind.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The ValidMind Platform is the central place to:

Sections that need your attention get flagged with `Requires Attention`. These sections get flagged _automatically_ by the Developer Framework whenever a test result is above or below a certain threshold.

6. From the left sidebar, select **3. Model Development** and any of the subsection to see information that has been uploaded by the Developer Framework about:
6. From the left sidebar, select **3. Model Development** and any of the subsections to see information that has been uploaded by the Developer Framework about:

- Model training
- Model evaluation
Expand Down
2 changes: 1 addition & 1 deletion site/guide/get-started.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: "get started, model risk management, ValidMind"

## Welcome to ValidMind!

ValidMind is a solution designed to help simplify and automate key aspects of model risk management (MRM) activities for model developers and model validators alike. The platform helps automate model documentation, validation, and testing. In addition, the platform offers with built-in communication and tracking features that enable all stakeholders to collaborate and communicate effectively throughout the model risk management process, ensuring that everyone is informed and up-to-date.
ValidMind is a solution designed to help simplify and automate key aspects of model risk management (MRM) activities for model developers and model validators alike. The platform helps automate model documentation, validation, and testing. In addition, the platform offers built-in communication and tracking features that enable all stakeholders to collaborate and communicate effectively throughout the model risk management process, ensuring that everyone is informed and up-to-date.

## How does it work?

Expand Down