Skip to content

Commit 96ce934

Browse files
validbecknoosheen vazinkhoonoosheenv
authored
Created "Manage model inventory custom fields" page in Guides (#199)
* adding bare bones pages working navigation * more substance more soul * renamed file to add manage in front * Added 'Custom field types' table * Added section * Added Nik's changes locally --------- Co-authored-by: noosheen vazinkhoo <noosheenvazinkhoo@noosheens-MacBook-Air.local> Co-authored-by: Noosheen Vazinkhoo <noosheenv@gmail.com>
1 parent 55c7b4c commit 96ce934

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1687
-312
lines changed

site/_quarto.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,10 +147,12 @@ website:
147147
- guide/configure-aws-privatelink.qmd
148148
- text: "---"
149149
- text: "MODEL INVENTORY"
150+
- guide/register-models-in-model-inventory.qmd
150151
# - guide/customize-model-inventory-fields.qmd
151152
- guide/edit-model-inventory-fields.qmd
152153
# - guide/customize-model-registration-form.qmd
153-
- guide/register-models-in-model-inventory.qmd
154+
- text: "Manage inventory custom fields"
155+
file: guide/manage-inventory-custom-fields.qmd
154156
- text: "---"
155157
- text: "MODEL DOCUMENTATION"
156158
- file: guide/working-with-documentation-templates.qmd

site/_site/guide/assess-compliance.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,14 +275,20 @@
275275
</li>
276276
<li class="sidebar-item">
277277
<div class="sidebar-item-container">
278+
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
279+
<span class="menu-text">Register models in the inventory</span></a>
280+
</div>
281+
</li>
282+
<li class="sidebar-item">
283+
<div class="sidebar-item-container">
278284
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
279285
<span class="menu-text">Edit model inventory fields</span></a>
280286
</div>
281287
</li>
282288
<li class="sidebar-item">
283289
<div class="sidebar-item-container">
284-
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
285-
<span class="menu-text">Register models in the inventory</span></a>
290+
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
291+
<span class="menu-text">Manage inventory custom fields</span></a>
286292
</div>
287293
</li>
288294
<li class="px-0"><hr class="sidebar-divider hi "></li>

site/_site/guide/assign-documentation-section-statuses.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,14 +275,20 @@
275275
</li>
276276
<li class="sidebar-item">
277277
<div class="sidebar-item-container">
278+
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
279+
<span class="menu-text">Register models in the inventory</span></a>
280+
</div>
281+
</li>
282+
<li class="sidebar-item">
283+
<div class="sidebar-item-container">
278284
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
279285
<span class="menu-text">Edit model inventory fields</span></a>
280286
</div>
281287
</li>
282288
<li class="sidebar-item">
283289
<div class="sidebar-item-container">
284-
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
285-
<span class="menu-text">Register models in the inventory</span></a>
290+
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
291+
<span class="menu-text">Manage inventory custom fields</span></a>
286292
</div>
287293
</li>
288294
<li class="px-0"><hr class="sidebar-divider hi "></li>

site/_site/guide/collaborate-with-others.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,14 +275,20 @@
275275
</li>
276276
<li class="sidebar-item">
277277
<div class="sidebar-item-container">
278+
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
279+
<span class="menu-text">Register models in the inventory</span></a>
280+
</div>
281+
</li>
282+
<li class="sidebar-item">
283+
<div class="sidebar-item-container">
278284
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
279285
<span class="menu-text">Edit model inventory fields</span></a>
280286
</div>
281287
</li>
282288
<li class="sidebar-item">
283289
<div class="sidebar-item-container">
284-
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
285-
<span class="menu-text">Register models in the inventory</span></a>
290+
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
291+
<span class="menu-text">Manage inventory custom fields</span></a>
286292
</div>
287293
</li>
288294
<li class="px-0"><hr class="sidebar-divider hi "></li>

site/_site/guide/configure-aws-privatelink.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,14 +274,20 @@
274274
</li>
275275
<li class="sidebar-item">
276276
<div class="sidebar-item-container">
277+
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
278+
<span class="menu-text">Register models in the inventory</span></a>
279+
</div>
280+
</li>
281+
<li class="sidebar-item">
282+
<div class="sidebar-item-container">
277283
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
278284
<span class="menu-text">Edit model inventory fields</span></a>
279285
</div>
280286
</li>
281287
<li class="sidebar-item">
282288
<div class="sidebar-item-container">
283-
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
284-
<span class="menu-text">Register models in the inventory</span></a>
289+
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
290+
<span class="menu-text">Manage inventory custom fields</span></a>
285291
</div>
286292
</li>
287293
<li class="px-0"><hr class="sidebar-divider hi "></li>

site/_site/guide/customize-documentation-templates.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,14 +275,20 @@
275275
</li>
276276
<li class="sidebar-item">
277277
<div class="sidebar-item-container">
278+
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
279+
<span class="menu-text">Register models in the inventory</span></a>
280+
</div>
281+
</li>
282+
<li class="sidebar-item">
283+
<div class="sidebar-item-container">
278284
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
279285
<span class="menu-text">Edit model inventory fields</span></a>
280286
</div>
281287
</li>
282288
<li class="sidebar-item">
283289
<div class="sidebar-item-container">
284-
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
285-
<span class="menu-text">Register models in the inventory</span></a>
290+
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
291+
<span class="menu-text">Manage inventory custom fields</span></a>
286292
</div>
287293
</li>
288294
<li class="px-0"><hr class="sidebar-divider hi "></li>

site/_site/guide/edit-model-inventory-fields.html

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
<script src="../site_libs/quarto-search/fuse.min.js"></script>
3131
<script src="../site_libs/quarto-search/quarto-search.js"></script>
3232
<meta name="quarto:offset" content="../">
33-
<link href="../guide/register-models-in-model-inventory.html" rel="next">
33+
<link href="../guide/manage-inventory-custom-fields.html" rel="next">
34+
<link href="../guide/register-models-in-model-inventory.html" rel="prev">
3435
<link href="../validmind.png" rel="icon" type="image/png">
3536
<script src="../site_libs/cookie-consent/cookie-consent.js"></script>
3637
<link href="../site_libs/cookie-consent/cookie-consent.css" rel="stylesheet">
@@ -274,14 +275,20 @@
274275
</li>
275276
<li class="sidebar-item">
276277
<div class="sidebar-item-container">
278+
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
279+
<span class="menu-text">Register models in the inventory</span></a>
280+
</div>
281+
</li>
282+
<li class="sidebar-item">
283+
<div class="sidebar-item-container">
277284
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link active">
278285
<span class="menu-text">Edit model inventory fields</span></a>
279286
</div>
280287
</li>
281288
<li class="sidebar-item">
282289
<div class="sidebar-item-container">
283-
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
284-
<span class="menu-text">Register models in the inventory</span></a>
290+
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
291+
<span class="menu-text">Manage inventory custom fields</span></a>
285292
</div>
286293
</li>
287294
<li class="px-0"><hr class="sidebar-divider hi "></li>
@@ -959,10 +966,13 @@ <h2 class="anchored" data-anchor-id="whats-next">What’s next</h2>
959966
</script>
960967
<nav class="page-navigation">
961968
<div class="nav-page nav-page-previous">
969+
<a href="../guide/register-models-in-model-inventory.html" class="pagination-link" aria-label="Register models in the inventory">
970+
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Register models in the inventory</span>
971+
</a>
962972
</div>
963973
<div class="nav-page nav-page-next">
964-
<a href="../guide/register-models-in-model-inventory.html" class="pagination-link" aria-label="Register models in the inventory">
965-
<span class="nav-page-text">Register models in the inventory</span> <i class="bi bi-arrow-right-short"></i>
974+
<a href="../guide/manage-inventory-custom-fields.html" class="pagination-link" aria-label="Manage inventory custom fields">
975+
<span class="nav-page-text">Manage inventory custom fields</span> <i class="bi bi-arrow-right-short"></i>
966976
</a>
967977
</div>
968978
</nav>

site/_site/guide/export-documentation.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,14 +274,20 @@
274274
</li>
275275
<li class="sidebar-item">
276276
<div class="sidebar-item-container">
277+
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
278+
<span class="menu-text">Register models in the inventory</span></a>
279+
</div>
280+
</li>
281+
<li class="sidebar-item">
282+
<div class="sidebar-item-container">
277283
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
278284
<span class="menu-text">Edit model inventory fields</span></a>
279285
</div>
280286
</li>
281287
<li class="sidebar-item">
282288
<div class="sidebar-item-container">
283-
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
284-
<span class="menu-text">Register models in the inventory</span></a>
289+
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
290+
<span class="menu-text">Manage inventory custom fields</span></a>
285291
</div>
286292
</li>
287293
<li class="px-0"><hr class="sidebar-divider hi "></li>

site/_site/guide/get-started-developer-framework.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1894,7 +1894,7 @@ <h2 class="anchored" data-anchor-id="getting-started">Getting started</h2>
18941894
<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>
18951895
<div id="listing-developer-getting-started" class="quarto-listing quarto-listing-container-grid">
18961896
<div class="list grid quarto-listing-cols-3">
1897-
<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">
1897+
<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">
18981898
<a href="../notebooks/quickstart_customer_churn_full_suite.html" class="quarto-grid-link">
18991899
<div class="quarto-grid-item card h-100 card-left">
19001900
<div class="card-body post-contents">
@@ -1908,7 +1908,7 @@ <h5 class="no-anchor card-title listing-title">
19081908
</div>
19091909
</a>
19101910
</div>
1911-
<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">
1911+
<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">
19121912
<a href="../notebooks/tutorials/intro_for_model_developers.html" class="quarto-grid-link">
19131913
<div class="quarto-grid-item card h-100 card-left">
19141914
<div class="card-body post-contents">
@@ -1933,7 +1933,7 @@ <h2 class="anchored" data-anchor-id="learn-how-to-run-tests">Learn how to run te
19331933
<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>
19341934
<div id="listing-developer-how-to-beginner" class="quarto-listing quarto-listing-container-grid">
19351935
<div class="list grid quarto-listing-cols-3">
1936-
<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">
1936+
<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">
19371937
<a href="../notebooks/how_to/run_tests/1_run_dataset_based_tests.html" class="quarto-grid-link">
19381938
<div class="quarto-grid-item card h-100 card-left">
19391939
<div class="card-body post-contents">
@@ -1947,7 +1947,7 @@ <h5 class="no-anchor card-title listing-title">
19471947
</div>
19481948
</a>
19491949
</div>
1950-
<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">
1950+
<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">
19511951
<a href="../notebooks/code_samples/custom_tests/implement_custom_tests.html" class="quarto-grid-link">
19521952
<div class="quarto-grid-item card h-100 card-left">
19531953
<div class="card-body post-contents">
@@ -1973,7 +1973,7 @@ <h2 class="anchored" data-anchor-id="try-the-code-samples">Try the code samples<
19731973
<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>
19741974
<div id="listing-developer-code-samples" class="quarto-listing quarto-listing-container-grid">
19751975
<div class="list grid quarto-listing-cols-3">
1976-
<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">
1976+
<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">
19771977
<a href="../notebooks/code_samples/customization/customizing_metrics_with_output_templates.html" class="quarto-grid-link">
19781978
<div class="quarto-grid-item card h-100 card-left">
19791979
<div class="card-body post-contents">
@@ -1987,7 +1987,7 @@ <h5 class="no-anchor card-title listing-title">
19871987
</div>
19881988
</a>
19891989
</div>
1990-
<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">
1990+
<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">
19911991
<a href="../notebooks/code_samples/NLP_and_LLM/prompt_validation_demo.html" class="quarto-grid-link">
19921992
<div class="quarto-grid-item card h-100 card-left">
19931993
<div class="card-body post-contents">
@@ -2001,7 +2001,7 @@ <h5 class="no-anchor card-title listing-title">
20012001
</div>
20022002
</a>
20032003
</div>
2004-
<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">
2004+
<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">
20052005
<a href="../notebooks/code_samples/time_series/tutorial_time_series_forecasting.html" class="quarto-grid-link">
20062006
<div class="quarto-grid-item card h-100 card-left">
20072007
<div class="card-body post-contents">

site/_site/guide/guides.html

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

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

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

1111
<title>ValidMind – Guides</title>
1212
<style>
@@ -445,14 +445,20 @@
445445
</li>
446446
<li class="sidebar-item">
447447
<div class="sidebar-item-container">
448+
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
449+
<span class="menu-text">Register models in the inventory</span></a>
450+
</div>
451+
</li>
452+
<li class="sidebar-item">
453+
<div class="sidebar-item-container">
448454
<a href="../guide/edit-model-inventory-fields.html" class="sidebar-item-text sidebar-link">
449455
<span class="menu-text">Edit model inventory fields</span></a>
450456
</div>
451457
</li>
452458
<li class="sidebar-item">
453459
<div class="sidebar-item-container">
454-
<a href="../guide/register-models-in-model-inventory.html" class="sidebar-item-text sidebar-link">
455-
<span class="menu-text">Register models in the inventory</span></a>
460+
<a href="../guide/manage-inventory-custom-fields.html" class="sidebar-item-text sidebar-link">
461+
<span class="menu-text">Manage inventory custom fields</span></a>
456462
</div>
457463
</li>
458464
<li class="px-0"><hr class="sidebar-divider hi "></li>
@@ -637,7 +643,7 @@ <h1 class="title">Guides</h1>
637643
<div>
638644
<div class="quarto-title-meta-heading">Published</div>
639645
<div class="quarto-title-meta-contents">
640-
<p class="date">May 22, 2024</p>
646+
<p class="date">May 23, 2024</p>
641647
</div>
642648
</div>
643649

@@ -787,7 +793,21 @@ <h2 class="anchored" data-anchor-id="model-inventory">Model inventory</h2>
787793
<p>To configure the model inventory to your organization’s requirements and to register new models:</p>
788794
<div id="listing-guides-model-inventory" class="quarto-listing quarto-listing-container-grid">
789795
<div class="list grid quarto-listing-cols-3">
790-
<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">
796+
<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">
797+
<a href="../guide/register-models-in-model-inventory.html" class="quarto-grid-link">
798+
<div class="quarto-grid-item card h-100 card-left">
799+
<div class="card-body post-contents">
800+
<h5 class="no-anchor card-title listing-title">
801+
Register models in the inventory
802+
</h5>
803+
<div class="card-text listing-description">
804+
To be able to document models using ValidMind’s model documentation and validation features, you need to register them in the model inventory first.
805+
</div>
806+
</div>
807+
</div>
808+
</a>
809+
</div>
810+
<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">
791811
<a href="../guide/edit-model-inventory-fields.html" class="quarto-grid-link">
792812
<div class="quarto-grid-item card h-100 card-left">
793813
<div class="card-body post-contents">
@@ -801,15 +821,15 @@ <h5 class="no-anchor card-title listing-title">
801821
</div>
802822
</a>
803823
</div>
804-
<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">
805-
<a href="../guide/register-models-in-model-inventory.html" class="quarto-grid-link">
824+
<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">
825+
<a href="../guide/manage-inventory-custom-fields.html" class="quarto-grid-link">
806826
<div class="quarto-grid-item card h-100 card-left">
807827
<div class="card-body post-contents">
808828
<h5 class="no-anchor card-title listing-title">
809-
Register models in the inventory
829+
Manage model inventory custom fields
810830
</h5>
811831
<div class="card-text listing-description">
812-
To be able to document models using ValidMind’s model documentation and validation features, you need to register them in the model inventory first.
832+
Create and edit custom fields that appear on all models in your model inventory.
813833
</div>
814834
</div>
815835
</div>

0 commit comments

Comments
 (0)