Skip to content

[SC-18631] Document styled test summary tables (pandas Styler) #1533

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emmavdh merged 1 commit into from
Oct 1, 2026
Merged

[SC-18631] Document styled test summary tables (pandas Styler) #1533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/about/glossary/key_concepts/_outputs.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

outputs
: Custom tests can return elements like tables or plots. Tables may be a list of dictionaries (each representing a row) or a [pandas DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html). Plots may be [matplotlib](https://matplotlib.org/) or [plotly](https://plotly.com/) figures.
: Custom tests can return elements like tables or plots. Tables may be a list of dictionaries (each representing a row), a [pandas DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html), or a [pandas Styler](https://pandas.pydata.org/docs/reference/api/pandas.io.formats.style.Styler.html), whose cell styles (background color, text color, font weight, and text alignment) are preserved in the {{< var validmind.platform >}} and in exported documents. Plots may be [matplotlib](https://matplotlib.org/) or [plotly](https://plotly.com/) figures.
4 changes: 3 additions & 1 deletion site/developer/how-to/testing-overview.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ listing:
- Any setting that isn't a dataset or model[^1]

**Outputs**
: Tests return results like tables and plots. Tables can be lists of dictionaries or pandas DataFrames; plots can be matplotlib or plotly figures.
: Tests return results like tables and plots. Tables can be lists of dictionaries, pandas DataFrames, or pandas Stylers;[^2] plots can be matplotlib or plotly figures.

**Logging results**
: Call `.log()` on a test result to send it to the {{< var validmind.platform >}}.
Expand Down Expand Up @@ -235,3 +235,5 @@ Learn more about using the other features of the {{< var validmind.developer >}}

[^1]: Use `vm.tests.describe_test("test_id")` for programmatic parameter details, or browse the [{{< var vm.product >}} test sandbox](test-sandbox.qmd).

[^2]: Cell styles applied with a [pandas `Styler`](https://pandas.pydata.org/docs/reference/api/pandas.io.formats.style.Styler.html) (background color, text color, font weight, and text alignment) are kept when the result is logged, and shown in the {{< var validmind.platform >}} and in HTML and DOCX exports of your documents. Requires {{< var validmind.developer >}} version **2.14** or later.

Loading