Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ graph LR
```
<br>

1. **Develop your model** — In your existing developer environment, build one or more candidate models that need to be validated. This step includes all the usual activities you already follow as a model developer.
1. **Develop your model**[^1] — In your existing developer environment, build one or more candidate models that need to be validated. This step includes all the usual activities you already follow as a model developer.

2. **Generate model documentation** — With the {{< var validmind.developer >}}, generate automated model documentation and run validation tests. This step includes making use of the automation and testing functionality provided by the {{< var vm.developer >}} and uploading the output to the {{< var vm.platform >}}. You can iteratively regenerate the documentation as you work though the next step of refining your documentation.

Expand Down Expand Up @@ -118,3 +118,11 @@ Next, go to **In the {{< var validmind.platform >}}, Step 5**. {{< fa arrow-rig
- For existing blocks: Select from available texts from content provider

6. [Submit your model documentation for review](/guide/model-documentation/submit-for-approval.qmd).


<!-- FOOTNOTES -->

[^1]:

**No available model?**<br>
You can still run tests and log documentation with ValidMind as long as you're able to [load the model predictions](/faq/faq-documentation.qmd#can-i-run-tests-and-log-documentation-without-having-a-model-available).
20 changes: 20 additions & 0 deletions site/faq/faq-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,26 @@ title: "Documentation"
date: last-modified
---

## Can I run tests and log documentation without having a model available?

If you do not have a model ready, or your model can't be loaded directly, or you only have access to model predictions, you can still run tests and log documentation with ValidMind as long as you're able to load the model predictions.

- Use [`assign_predictions()`](https://docs.validmind.ai/validmind/validmind/vm_models.html#VMDataset.assign_predictions) to load predictions from a separate file or a dataset with predictions.
- Call [`init_model()`](https://docs.validmind.ai/validmind/validmind.html#init_model) but instead of a trained model instance, pass an `input_id` and model metadata. [`ModelMetadata()`](https://docs.validmind.ai/validmind/validmind/tests/model_validation/ModelMetadata.html#ModelMetadata) will use the provided metadata instead of trying to calculate it from the model's library.

For example:

```python
external_model = vm.init_model(
input_id="spark_ml_model",
metadata={...}
)
```

::: {.callout title="If neither a trained model instance nor metadata is provided, `init_model()` will return an error. "}
However, tests that need a trained model will not work with "empty" models.
:::

## Can documentation templates be configured per model use case or to match our existing templates?

ValidMind's platform allows you to configure multiple templates based on documentation requirements for each model use case. During the model registration process, the platform automatically selects the template based on the provided model use case information.
Expand Down