Skip to content
9 changes: 5 additions & 4 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -203,10 +203,11 @@ website:
- guide/model-inventory/register-models-in-inventory.qmd
- guide/model-inventory/customize-model-inventory-layout.qmd
- guide/model-inventory/edit-model-inventory-fields.qmd
# - guide/register-models-in-model-inventory.qmd
# - guide/customize-model-registration-form.qmd
- text: "Manage inventory custom fields"
file: guide/model-inventory/manage-inventory-custom-fields.qmd
- file: guide/model-inventory/managing-model-inventory.qmd
contents:
- guide/model-inventory/configure-model-interdependencies.qmd
- text: "Manage inventory custom fields"
file: guide/model-inventory/manage-inventory-custom-fields.qmd
- text: "---"
- text: "MODEL DOCUMENTATION"
- file: guide/model-documentation/working-with-documentation-templates.qmd
Expand Down
4 changes: 2 additions & 2 deletions site/guide/guides.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ listing:
fields: [title, description]
contents:
- model-inventory/working-with-model-inventory.qmd
- model-inventory/manage-inventory-custom-fields.qmd
- model-inventory/managing-model-inventory.qmd
- id: guides-model-documentation
type: grid
max-description-length: 250
Expand Down Expand Up @@ -121,7 +121,7 @@ Use workflows to match your organizational needs for overseeing model developmen

## Model inventory

To configure the model inventory to your organization's requirements and to register new models:
Get started with the model inventory and configure it to match your organization's requirements:

:::{#guides-model-inventory}
:::
Expand Down
85 changes: 85 additions & 0 deletions site/guide/model-inventory/configure-model-interdependencies.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: "Configure model interdependencies"
date: last-modified
filters:
- tachyons
---

Link two or more models in your ValidMind model inventory together. Dependencies are useful to understand a model is
affected by or affects other models in your inventory.

::: {.prereq}

## Prerequisites

- [x] {{< var link.login >}}
- [x] There are two or more models registered in the model inventory.[^1]
- [x] You are the model owner for the model you want to set interdependencies for, a `Developer`, or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]

:::

## View interdependencies

1. In the left sidebar, click **Model Inventory**.

2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^3]

3. Any existing model interdependencies are shown under the Model Interdependencies section.

On the interactive flowchart, the currently viewed model is highlighted:

- Click and drag to change what is displayed on the flowchart.
- To zoom in and out, use your mouse scroll button or zoom trackpad gesture.

![](model-interdependencies.png){fig-alt="A screenshot showing example model interdependencies"}

## Edit interdependencies

1. In the left sidebar, click **Model Inventory**.

2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^4]

3. Click **Manage Dependencies** to open up the model interdependencies detail menu.

4. Select either the **{{< fa arrow-up >}} Upstream** or **{{< fa arrow-down >}}Downstream** tab:

- **Upstream models** — Provides input or intermediate results to another model.
- **Downstream models** — Receives input and typically performs further processing, predictions, or actions based on that input.

You can swap between the **{{< fa arrow-up >}} Upstream** or **{{< fa arrow-down >}}Downstream** tabs to set both interdependency types at once.

5. On your list of models populated by the model inventory, add or remove interdependencies as desired:

- **Add** — Check off any models that are either upstream or downstream dependent on this current model.
- **Remove** — Uncheck any models previously linked as upstream or downstream dependent on this current model.

6. Click **Save** to apply your changes.

Once applied, model interdependencies will populate on all models linked together.

:::: {.flex .flex-wrap .justify-around}

::: {.w-50-ns}

![Upstream Model linked to the downstream Current Model](upstream-model.png){fig-alt="A screenshot showing the Upstream Model linked to the downstream Current Model" }

:::

::: {.w-50-ns}

![Downstream Model linked to the upstream Current Model](downstream-model.png){fig-alt="A screenshot showing the Downstream Model linked to the upstream Current Model"}

:::

::::


<!-- FOOTNOTES -->

[^1]: [Register models in the inventory](register-models-in-inventory.qmd)

[^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd)

[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)

[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Customize model inventory layout"
date: last-modified
---

Configure the information that displays on the model inventory, and swap between inventory views.
Expand Down
Binary file added site/guide/model-inventory/downstream-model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 0 additions & 8 deletions site/guide/model-inventory/edit-model-inventory-fields.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ Edit individual model detailed fields in the model inventory to customize them t

## Steps

<!--- NR TO DO Check with Mehdi: these steps didn't work for me, can't edit. Wrong permissions maybe? --->

1. In the left sidebar, click **Model Inventory**.

2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^3]
Expand All @@ -28,12 +26,6 @@ Edit individual model detailed fields in the model inventory to customize them t
- Click **Save** to apply your changes.
- Click **Cancel** to discard your changes.

<!---
## Troubleshooting

[Include any common issues or errors that may arise during the task and how to resolve them.]
--->

## What's next

- [Register models in the inventory](register-models-in-inventory.qmd)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Manage model inventory custom fields"
date: last-modified
---

Create and edit custom fields that appear on all models in your model inventory.
Create and edit custom fields that appear on all models in your model inventory. Choose from an array of custom field types with different properties and use cases.

::: {.prereq}

Expand Down
18 changes: 18 additions & 0 deletions site/guide/model-inventory/managing-model-inventory.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Managing the model inventory"
date: last-modified
listing:
- id: model-inventory-management
type: grid
max-description-length: 250
sort: false
fields: [title, description]
contents:
- configure-model-interdependencies.qmd
- manage-inventory-custom-fields.qmd
---

Once you're familiar with the model inventory, dive into more advanced features like managing model interdependencies, changing the stage of models, and customizing what's shown on the model inventory to support your organization's requirements.

:::{#model-inventory-management}
:::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/guide/model-inventory/upstream-model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion site/guide/model-inventory/working-with-model-inventory.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ listing:
- customize-model-inventory-layout.qmd
- edit-model-inventory-fields.qmd
---
Use the model inventory within the {{< var validmind.platform >}} to easily track comprehensive details for all your models throughout the model lifecycle. The model inventory is customizable and extensible, and can be configured to suit your unique needs.

Get started with the ValidMind model inventory, which tracks comprehensive details for all your models throughout the model lifecycle. The model inventory is customizable and extensible, with a layout that can be configured to suit each user's needs.

::: {.prereq}

Expand Down
4 changes: 4 additions & 0 deletions site/releases/2024-aug-13/release-notes.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,10 @@ Manage both upstream and downstream model interdependencies:

![Model dependencies diagram](model-dependencies.png){fig-alt="A diagram of model interdependencies"}

<form method="get" action="/guide/model-inventory/configure-model-interdependencies.html" target="_blank">
<button type="submit" style="color: white; background-color: #de257e; border-radius: 8px; border: none; font-size: 16px; padding: 6.25px 12.5px; margin-left: 16px; margin-bottom: 20px;">Learn more...</button>
</form>

:::

::: {.w-50-ns}
Expand Down