Skip to content

Documentation for filtering test result metadata #505

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
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
Binary file modified site/developer/model-documentation/test-run-details.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 23 additions & 1 deletion site/developer/model-documentation/work-with-test-results.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,35 @@ After you have added a test result to your document, you can view the following

4. Locate the test result whose metadata you want to view.

5. Under the test result's name, click on the row indicating the date of the latest changes.
5. Under the test result's name, click on the row indicating the currently [Active]{.green-bg} test result.

- On the test result timeline, click on the **{{< fa chevron-down >}}** associated with a test run to expand for details.
- When you are done, you can either click **Cancel** or **{{< fa x >}}** to close the metadata menu.

![Detail expansion of test runs on the test result timeline](test-run-details.gif){width=85% fig-alt="A gif showcasing detail expansion of test runs on the test result timeline" class="screenshot"}

#### Filter historical test results

By default, test result metadata are sorted by date run in descending order. The latest result is automatically indicated as [Active]{.green-bg}.

To narrow down test runs, you can apply some filters:

1. On the detail expansion for test result metadata, click **{{< fa filter >}} Filter**.

2. On the **Select Your Filters** dialog that opens, enter your filtering criteria for:

- Date range
- Model
- Dataset
- Run by

3. Click **Apply Filters**.

Filters can be removed from the list of test result metadata by clicking on the {{< fa xmark >}} next to them.

<!-- ## Pin historical test results -->

<!-- This functonality has been hidden for now: https://github.com/validmind/frontend/pull/1039#pullrequestreview-2363666887 -->

## What's next

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

### Resolve comments

1. Click the highlighted text portion to view the thread, then click <span style="color: green">{{< fa check >}}</span> to resolve the thread.
1. Click the highlighted text portion to view the thread, then click [{{< fa check >}}]{.green} to resolve the thread.

2. To view the resolved comment thread, click the **{{< fa envelope-circle-check >}} Comments archive** button in the toolbar.

Expand Down
4 changes: 2 additions & 2 deletions site/guide/model-documentation/collaborate-with-others.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ While working with content blocks in documentation,[^4] you can suggest changes

### Resolve changes

1. Suggested changes appear in <span style="color: green">green</span> or <span style="color: red">~~red~~</span> highlighted text, depending on if the change is adding or removing content respectively.
1. Suggested changes appear in [green]{.green} or [~~red~~]{.red} highlighted text, depending on if the change is adding or removing content respectively.

- To accept or decline a change, click the highlighted text, then click <span style="color: green">{{< fa check >}}</span> or <span style="color: red">{{< fa xmark >}}</span>.
- To accept or decline a change, click the highlighted text, then click [{{< fa check >}}]{.green} or [{{< fa xmark >}}]{.red}.
- You can also reply to a suggested change.

2. To mass accept or decline suggestions, click the dropdown arrow next to the **{{< fa file-pen >}} Track changes** button and select one of the options:
Expand Down
8 changes: 4 additions & 4 deletions site/guide/model-validation/view-filter-model-findings.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,15 @@ To view findings linked to a specific model:

## Filter model findings

By default, model findings for all models are displayed and sorted by creation date, with the latest findings displayed first.
By default, model findings for all models are listed by creation date in descending order.

To narrow down the findings to only those you want to see, you can apply some filters:
To narrow down the findings, you can apply some filters:

1. In the left sidebar, click **{{< fa triangle-exclamation >}} Model Findings** for the list of all model findings.

2. Click {{< fa filter >}} **Filter**.
2. Click **{{< fa filter >}} Filter**.

3. On the **Select Your Filters** dialog that opens, select your filtering criteria for:
3. On the **Select Your Filters** dialog that opens, enter your filtering criteria for:

- Status
- Model inventory
Expand Down
6 changes: 1 addition & 5 deletions site/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -145,10 +145,6 @@ a:hover {

::: {.w-30-ns .mr2 .mb4}

<!-- :::: {.f1}
<span style="color: #de257e">Valid</span>**Mind**
:::: -->

:::: {.f3}
The **purpose-built platform** for model risk management teams to test, document, validate, and govern Generative AI, AI, and statistical models with speed and confidence.
::::
Expand Down Expand Up @@ -318,7 +314,7 @@ Gain **hands-on experience** and explore what ValidMind has to offer with our in
![](assets/img/icon-trust.svg)

:::: {.f3}
<span style="color: #de257e">Be</span>**Valid.**
[Be]{.pink}**Valid.**
::::

:::: {.f4}
Expand Down
Binary file modified site/python-docs.zip
Binary file not shown.
20 changes: 20 additions & 0 deletions site/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,26 @@ figcaption {
text-align: center;
}

.green-bg {
background-color: #bbe1afff;
padding: 5px;
border-radius: 3px;
color: #0f3b02ff;
font-size: smaller;
}

.pink {
color: #DE257E;
}

.green {
color: green;
}

.red {
color: red;
}

.bubble {
border: 1px solid #222222;
padding: 5px;
Expand Down
Loading