Skip to content
Merged
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
48 changes: 47 additions & 1 deletion site/faq/faq-testing.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,36 @@ Yes, {{< var vm.product >}} allows tests to be manipulated at several levels:
In addition to custom tests, you can also add use case and test-specific context for any test to enhance the LLM-generated test descriptions using the {{< var validmind.developer >}}.[^8]
:::

## How do I log tests as a developer?

You use the {{< var validmind.developer >}} to run and log tests during model development, the results of which are then inserted your model documentation within the {{< var validmind.platform >}}.[^9] The {{< var vm.developer >}} also automatically generates draft test descriptions for your test results — generations that can be modified for your custom use cases.[^10]

To log tests as a developer with the {{< var validmind.developer >}}:

- You must have the [{{< fa code >}} Developer]{.bubble} role[^11] or another role with sufficient permissions to create and own models, and to work with model documentation.
- You must be the model owner or model developer, but not the model validator,[^12] for the model you want to log tests and update documentation for.

::: {.callout}
## Want to learn how to use {{< var vm.product >}} as a developer?

Check our our introductory series — [**{{< var vm.product >}} for model development**](/developer/validmind-library.qmd#for-model-development)
:::

## How do I log tests as a validator?

You use the {{< var validmind.developer >}} to run and log tests during model validation, the results of which are then inserted your validation report within the {{< var validmind.platform >}}.[^13] The {{< var vm.developer >}} also automatically generates draft test descriptions for your test results — generations that can be modified for your custom use cases.[^14]

To log tests as a validator with the {{< var validmind.developer >}}:

- You must have the [{{< fa circle-check >}} Validator]{.bubble} role[^15] or another role with sufficient permissions to access models for validation, to review model documentation, and to work with validation reports and model findings.
- You must be the model validator, but not the model owner or model developer,[^16] for the model you want to log tests and update documentation for.

::: {.callout}
## Want to learn how to use {{< var vm.product >}} as a validator?

Check our our introductory series — [**{{< var vm.product >}} for model validation**](/developer/validmind-library.qmd#for-model-validation)
:::

{{< include _faq-explainability.qmd >}}

{{< include _faq-synthetic-datasets.qmd >}}
Expand Down Expand Up @@ -72,4 +102,20 @@ In addition to custom tests, you can also add use case and test-specific context

[^7]: [Understand and utilize `RawData` in {{< var vm.product >}} tests](/notebooks/how_to/understand_utilize_rawdata.ipynb)

[^8]: [Add context to LLM-generated test descriptions](/notebooks/how_to/add_context_to_llm_descriptions.ipynb)
[^8]: [Add context to LLM-generated test descriptions](/notebooks/how_to/add_context_to_llm_descriptions.ipynb)

[^9]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd)

[^10]: [Can we configure, customize, or add our own tests?](#can-we-configure-customize-or-add-our-own-tests)

[^11]: [Manage roles](/guide/configuration/manage-roles.qmd)

[^12]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd)

[^13]: [Assess compliance](/guide/model-validation/assess-compliance.qmd#link-validator-evidence)

[^14]: [Can we configure, customize, or add our own tests?](#can-we-configure-customize-or-add-our-own-tests)

[^15]: [Manage roles](/guide/configuration/manage-roles.qmd)

[^16]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd)
Loading