Skip to content

Created "Manage model inventory custom fields" page in Guides #199

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
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
4 changes: 3 additions & 1 deletion site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,12 @@ website:
- guide/configure-aws-privatelink.qmd
- text: "---"
- text: "MODEL INVENTORY"
- guide/register-models-in-model-inventory.qmd
# - guide/customize-model-inventory-fields.qmd
- guide/edit-model-inventory-fields.qmd
# - guide/customize-model-registration-form.qmd
- guide/register-models-in-model-inventory.qmd
- text: "Manage inventory custom fields"
file: guide/manage-inventory-custom-fields.qmd
- text: "---"
- text: "MODEL DOCUMENTATION"
- file: guide/working-with-documentation-templates.qmd
Expand Down
10 changes: 8 additions & 2 deletions site/_site/guide/assess-compliance.html
Original file line number Diff line number Diff line change
Expand Up @@ -275,14 +275,20 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit model inventory fields</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Manage inventory custom fields</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
Expand Down
10 changes: 8 additions & 2 deletions site/_site/guide/assign-documentation-section-statuses.html
Original file line number Diff line number Diff line change
Expand Up @@ -275,14 +275,20 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit model inventory fields</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Manage inventory custom fields</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
Expand Down
10 changes: 8 additions & 2 deletions site/_site/guide/collaborate-with-others.html
Original file line number Diff line number Diff line change
Expand Up @@ -275,14 +275,20 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit model inventory fields</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Manage inventory custom fields</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
Expand Down
10 changes: 8 additions & 2 deletions site/_site/guide/configure-aws-privatelink.html
Original file line number Diff line number Diff line change
Expand Up @@ -274,14 +274,20 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit model inventory fields</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Manage inventory custom fields</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
Expand Down
10 changes: 8 additions & 2 deletions site/_site/guide/customize-documentation-templates.html
Original file line number Diff line number Diff line change
Expand Up @@ -275,14 +275,20 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit model inventory fields</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Manage inventory custom fields</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
Expand Down
20 changes: 15 additions & 5 deletions site/_site/guide/edit-model-inventory-fields.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
<script src="../site_libs/quarto-search/fuse.min.js"></script>
<script src="../site_libs/quarto-search/quarto-search.js"></script>
<meta name="quarto:offset" content="../">
<link href="../guide/register-models-in-model-inventory.html" rel="next">
<link href="../guide/manage-inventory-custom-fields.html" rel="next">
<link href="../guide/register-models-in-model-inventory.html" rel="prev">
<link href="../validmind.png" rel="icon" type="image/png">
<script src="../site_libs/cookie-consent/cookie-consent.js"></script>
<link href="../site_libs/cookie-consent/cookie-consent.css" rel="stylesheet">
Expand Down Expand Up @@ -274,14 +275,20 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Edit model inventory fields</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Manage inventory custom fields</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
Expand Down Expand Up @@ -959,10 +966,13 @@ <h2 class="anchored" data-anchor-id="whats-next">What’s next</h2>
</script>
<nav class="page-navigation">
<div class="nav-page nav-page-previous">
<a href="../guide/register-models-in-model-inventory.html" class="pagination-link" aria-label="Register models in the inventory">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Register models in the inventory</span>
</a>
</div>
<div class="nav-page nav-page-next">
<a href="../guide/register-models-in-model-inventory.html" class="pagination-link" aria-label="Register models in the inventory">
<span class="nav-page-text">Register models in the inventory</span> <i class="bi bi-arrow-right-short"></i>
<a href="../guide/manage-inventory-custom-fields.html" class="pagination-link" aria-label="Manage inventory custom fields">
<span class="nav-page-text">Manage inventory custom fields</span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
Expand Down
10 changes: 8 additions & 2 deletions site/_site/guide/export-documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -274,14 +274,20 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit model inventory fields</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Manage inventory custom fields</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
Expand Down
14 changes: 7 additions & 7 deletions site/_site/guide/get-started-developer-framework.html
Original file line number Diff line number Diff line change
Expand Up @@ -1894,7 +1894,7 @@ <h2 class="anchored" data-anchor-id="getting-started">Getting started</h2>
<p>After you <a href="https://app.prod.validmind.ai"><strong>sign up</strong></a> for ValidMind to get access, try one our getting started guide:</p>
<div id="listing-developer-getting-started" class="quarto-listing quarto-listing-container-grid">
<div class="list grid quarto-listing-cols-3">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716420774805" data-listing-reading-time-sort="10" data-listing-word-count-sort="1953">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716499896983" data-listing-reading-time-sort="10" data-listing-word-count-sort="1953">
<a href="../notebooks/quickstart_customer_churn_full_suite.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1908,7 +1908,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716479414817" data-listing-reading-time-sort="27" data-listing-word-count-sort="5380">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716499897078" data-listing-reading-time-sort="27" data-listing-word-count-sort="5380">
<a href="../notebooks/tutorials/intro_for_model_developers.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1933,7 +1933,7 @@ <h2 class="anchored" data-anchor-id="learn-how-to-run-tests">Learn how to run te
<p>ValidMind provides many built-in tests and test suites which make it easy for developers to automate their model documentation. Start by running a pre-made test, then modify it, and finally create your own test:</p>
<div id="listing-developer-how-to-beginner" class="quarto-listing quarto-listing-container-grid">
<div class="list grid quarto-listing-cols-3">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716479414816" data-listing-reading-time-sort="10" data-listing-word-count-sort="1824">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716499897004" data-listing-reading-time-sort="10" data-listing-word-count-sort="1824">
<a href="../notebooks/how_to/run_tests/1_run_dataset_based_tests.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1947,7 +1947,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716479414812" data-listing-reading-time-sort="15" data-listing-word-count-sort="2811">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716499896985" data-listing-reading-time-sort="15" data-listing-word-count-sort="2811">
<a href="../notebooks/code_samples/custom_tests/implement_custom_tests.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1973,7 +1973,7 @@ <h2 class="anchored" data-anchor-id="try-the-code-samples">Try the code samples<
<p>Our code samples showcase the capabilities of the ValidMind Developer Framework. Examples that you can build on and adapt for your own use cases include:</p>
<div id="listing-developer-code-samples" class="quarto-listing quarto-listing-container-grid">
<div class="list grid quarto-listing-cols-3">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716479414812" data-listing-reading-time-sort="16" data-listing-word-count-sort="3027">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716499896985" data-listing-reading-time-sort="16" data-listing-word-count-sort="3027">
<a href="../notebooks/code_samples/customization/customizing_metrics_with_output_templates.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1987,7 +1987,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716479414812" data-listing-reading-time-sort="8" data-listing-word-count-sort="1443">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716499896995" data-listing-reading-time-sort="8" data-listing-word-count-sort="1443">
<a href="../notebooks/code_samples/NLP_and_LLM/prompt_validation_demo.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -2001,7 +2001,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="2" data-listing-file-modified-sort="1716479414813" data-listing-reading-time-sort="9" data-listing-word-count-sort="1658">
<div class="g-col-1" data-index="2" data-listing-file-modified-sort="1716499896996" data-listing-reading-time-sort="9" data-listing-word-count-sort="1658">
<a href="../notebooks/code_samples/time_series/tutorial_time_series_forecasting.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand Down
38 changes: 29 additions & 9 deletions site/_site/guide/guides.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="dcterms.date" content="2024-05-22">
<meta name="dcterms.date" content="2024-05-23">

<title>ValidMind – Guides</title>
<style>
Expand Down Expand Up @@ -445,14 +445,20 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit model inventory fields</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Manage inventory custom fields</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
Expand Down Expand Up @@ -637,7 +643,7 @@ <h1 class="title">Guides</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">May 22, 2024</p>
<p class="date">May 23, 2024</p>
</div>
</div>

Expand Down Expand Up @@ -787,7 +793,21 @@ <h2 class="anchored" data-anchor-id="model-inventory">Model inventory</h2>
<p>To configure the model inventory to your organization’s requirements and to register new models:</p>
<div id="listing-guides-model-inventory" class="quarto-listing quarto-listing-container-grid">
<div class="list grid quarto-listing-cols-3">
<div class="g-col-1" data-index="0" data-listing-date-sort="1716002082000" data-listing-file-modified-sort="1716002082516" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="1" data-listing-word-count-sort="183">
<div class="g-col-1" data-index="0" data-listing-date-sort="1716002082000" data-listing-file-modified-sort="1716002082545" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="1" data-listing-word-count-sort="197">
<a href="../guide/register-models-in-model-inventory.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
<h5 class="no-anchor card-title listing-title">
Register models in the inventory
</h5>
<div class="card-text listing-description">
To be able to document models using ValidMind’s model documentation and validation features, you need to register them in the model inventory first.
</div>
</div>
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-date-sort="1716002082000" data-listing-file-modified-sort="1716002082516" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="1" data-listing-word-count-sort="183">
<a href="../guide/edit-model-inventory-fields.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -801,15 +821,15 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-date-sort="1716002082000" data-listing-file-modified-sort="1716002082545" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="1" data-listing-word-count-sort="197">
<a href="../guide/register-models-in-model-inventory.html" class="quarto-grid-link">
<div class="g-col-1" data-index="2" data-listing-date-sort="1716499815000" data-listing-file-modified-sort="1716499815979" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="2" data-listing-word-count-sort="357">
<a href="../guide/manage-inventory-custom-fields.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
<h5 class="no-anchor card-title listing-title">
Register models in the inventory
Manage model inventory custom fields
</h5>
<div class="card-text listing-description">
To be able to document models using ValidMind’s model documentation and validation features, you need to register them in the model inventory first.
Create and edit custom fields that appear on all models in your model inventory.
</div>
</div>
</div>
Expand Down
10 changes: 8 additions & 2 deletions site/_site/guide/manage-groups.html
Original file line number Diff line number Diff line change
Expand Up @@ -274,14 +274,20 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit model inventory fields</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Register models in the inventory</span></a>
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Manage inventory custom fields</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
Expand Down
Loading
Loading