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
2 changes: 1 addition & 1 deletion site/about/contributing/style-guide/conventions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Use backticks to enclose keyboard commands, parameters, field values, and file n

| Correct | Incorrect |
|------|-----|
| Learn how to store project identifier credentials in a `.env` file instead of using inline credentials. | Learn how to store project identifier credentials in a ".env" file instead of using inline credentials. |
| Learn how to store model identifier credentials in a `.env` file instead of using inline credentials. | Learn how to store model identifier credentials in a ".env" file instead of using inline credentials. |
| For example, the `classifier_full_suite` test suite runs tests from the `tabular_dataset` and `classifier` test suites to fully document the data and model sections for binary classification model use cases. | For example, the "classifier_full_suite" test suite runs tests from the "tabular_dataset" and "classifier" test suites to fully document the data and model sections for binary classification model use cases. |
| Under When these conditions are met, you are able to set both `AND` and `OR` conditions. | Under When these conditions are met, you are able to set both "AND" and "OR" conditions.|
: **Backtick** examples {.hover}
Expand Down
2 changes: 1 addition & 1 deletion site/about/overview-model-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ What the {{< var validmind.developer >}} offers:
```python
import validmind as vm

vm.init(project="PROJECT_IDENTIFIER")
vm.init(model="MODEL_IDENTIFIER")
```

```python
Expand Down
2 changes: 1 addition & 1 deletion site/about/overview-model-risk-management.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The {{< var vm.platform >}} employs a multi-tenant architecture, hosting the clo
With the {{< var vm.platform >}}, you can:

- **Track your model inventory** — Manage the model lifecycle, track the workflow status for models, plan for upcoming validation dates, and more.
- **Work on validation projects** — Collaborate with developers and validators to review documentation, add findings, keep track of review statuses, and generate validation reports.
- **Work on validation initiatives** — Collaborate with developers and validators to review documentation, add findings, keep track of review statuses, and generate validation reports.
- **Configure workflows** — Set up ValidMind to follow your existing model risk management processes, manage statuses for different parts of the workflow, and get an end-to-end view of workflows and who is involved.
- **Use, create, or edit tests, test suites, and templates** — Create and/or configure required validation tests, test suites, and documentation templates for specific model use cases, tailoring it to your own specific needs.
- **Integrate with your stack** — Import and export model documentation and validation reports.
Expand Down
2 changes: 1 addition & 1 deletion site/developer/model-documentation/document-models.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Generate model documentation starting with your model or model predictions, load

## What's next

- [Store project credentials in `.env` files](store-credentials-in-env-file.qmd)
- [Store model credentials in `.env` files](store-credentials-in-env-file.qmd)
- [Work with test results](work-with-test-results.qmd)


Expand Down
4 changes: 2 additions & 2 deletions site/developer/model-documentation/documenting-models.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ aliases:
- ../../guide/generate-model-documentation.html
---

Use the {{< var vm.developer >}} to generate model documentation, view the results and refine your documentation in the {{< var vm.platform >}}, and collaborate with your team to complete documentation and validation projects within the same interface.
Use the {{< var vm.developer >}} to generate model documentation, view the results and refine your documentation in the {{< var vm.platform >}}, and collaborate with your team to complete documentation and validation initiatives within the same interface.

## How do I use the {{< var validmind.developer >}}?

Expand Down Expand Up @@ -87,7 +87,7 @@ When you have registered all the required tests as content blocks in the documen
```

::: {.callout-important title="ValidMind may not support all potential use cases or provide a universally applicable documentation template."}
Typically, you initiate the process of putting ValidMind into production by constructing a template specific for your own use case and then refine your the documentation project.
Typically, you initiate the process of putting ValidMind into production by constructing a template specific for your own use case and then refine your model documentation.
:::


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In order to integrate the {{< var vm.developer >}} and to be able to upload to t
| `api_host` | The location of the ValidMind API |
| `api_key` | The account API key |
| `api_secret` | The account secret key |
| `project` | The project identifier |
| `model` | The model identifier |

If you do not have a suitable model with a code snippet to use, you can register a model first.[^2]

Expand All @@ -33,7 +33,7 @@ The {{< var vm.developer >}} also requires access to the data sources where data

## Locate the {{< var vm.developer >}} integration instructions

For existing projects, this information can be found in the {{< var validmind.platform >}}:
For existing models, this information can be found in the {{< var validmind.platform >}}:

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

Expand Down Expand Up @@ -62,7 +62,7 @@ vm.init(
api_host = "{{< var api.host >}}/tracking",
api_key = "API_KEY",
api_secret = "API_SECRET",
project = "PROJECT-IDENTIFIER"
model = "MODEL_IDENTIFIER"
)
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: "Store project credentials in `.env` files"
title: "Store model credentials in `.env` files"
date: last-modified
aliases:
- ../../guide/store-credentials-in-env-file.html
---

Learn how to store project identifier credentials in a `.env` file instead of using inline credentials. This topic is relevant for model developers who want to follow best practices for security when running notebooks.
Learn how to store model identifier credentials in a `.env` file instead of using inline credentials. This topic is relevant for model developers who want to follow best practices for security when running notebooks.

## Why is this recommended?

Storing credentials in a `.env` file is considered a best practice for security. Embedding credentials directly within the code makes them more susceptible to accidental exposure when sharing code or collaborating on projects.
Storing credentials in a `.env` file is considered a best practice for security. Embedding credentials directly within the code makes them more susceptible to accidental exposure when sharing code or collaborating on models.

::: {.callout-important}
Keeing project credentials in a separate file also allows for precise access control and ensures that sensitive credentials are not publically accessible.
Keeing model credentials in a separate file also allows for precise access control and ensures that sensitive credentials are not publically accessible.
:::

::: {.prereq}
Expand All @@ -37,13 +37,13 @@ Keeing project credentials in a separate file also allows for precise access con
- Copy the values from this page and paste them into your `.env` file in the following format:

```yaml
VM_API_PROJECT=<Project Identifier>
VM_API_MODEL=<Model Identifier>
VM_API_HOST=<API Host URL>
VM_API_KEY=<API Key>s
VM_API_SECRET=<API Secret>
```

3. Insert this code snippet above your project identifier credentials:
3. Insert this code snippet above your model identifier credentials:

```python
%load_ext dotenv
Expand All @@ -60,12 +60,12 @@ Keeing project credentials in a separate file also allows for precise access con

vm.init(
api_host = "http://localhost:3000/api/v1/tracking",
project = "..."
model = "..."
)
```


4. Run the cell. Instead of using inline credentials, this cell will now load your project credentials from a `.env` file.
4. Run the cell. Instead of using inline credentials, this cell will now load your model credentials from a `.env` file.

<!---
## Troubleshooting
Expand Down
6 changes: 3 additions & 3 deletions site/faq/faq-models.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ Models get registered into ValidMind via the Model Inventory. To add a model int
- Model Dependencies
- And more

## Can the fields for project registration questionnaires be configured?
## Can the fields for model registration questionnaires be configured?

ValidMind enables you to configure project registration fields, including dropdown options for model risk tiers, model use cases, and documentation templates.
ValidMind enables you to configure model registration fields, including options for model risk tiers, model use cases, and documentation templates.

You can modify these fields as needed and on an ongoing basis.
You can modify these fields as needed and on an ongoing basis: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)

## Can we leverage content from historical documentations? 

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Signing up is FREE — {{< var link.register >}}
- `api_host`: The location of the ValidMind API
- `api_key`: The account API key
- `api_secret`: The account secret key
- `project`: The project identifier
- `model`: The model identifier

This code snippet can be copied and pasted directly into your developer source code to integrate the {{< var vm.developer >}} and to be able to upload to the {{< var validmind.platform >}}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Working with documentation templates"
date: last-modified
listing:
- id: documentation-project-templates
- id: documentation-templates
type: grid
max-description-length: 250
sort: false
Expand All @@ -16,7 +16,7 @@ aliases:
- ../working-with-documentation-templates.html
---

Documentation templates offer a standardized approach to creating consistent and comprehensive model documentation and validation reports. You customize these templates to fit your specific project needs.
Documentation templates offer a standardized approach to creating consistent and comprehensive model documentation and validation reports. You customize these templates to fit your specific case-by-case needs.

:::{#documentation-project-templates}
:::{#documentation-templates}
:::
11 changes: 7 additions & 4 deletions site/guide/model-inventory/view-model-activity.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,11 @@ Shows model level updates:

- Inventory fields updated on the model[^5]
- Updates to model documentation, validation reports,[^6] or ongoing monitoring plans[^7]
- Test results added to your model[^8]
- Findings added, updated, or removed[^9]
- Findings added, updated, or removed[^8]

#### Test results

Shows test results logged for your model via the {{< var validmind.developer >}}.[^9]


## What's next
Expand All @@ -80,8 +83,8 @@ Shows model level updates:

[^7]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)

[^8]: [ValidMind Developer Framework](/developer/get-started-developer-framework.qmd)
[^8]: [Working with model findings](/guide/model-validation/working-with-model-findings.qmd)

[^9]: [Working with model findings](/guide/model-validation/working-with-model-findings.qmd)
[^9]: [Work with test results](/developer/model-documentation/work-with-test-results.qmd)


7 changes: 2 additions & 5 deletions site/guide/model-validation/review-model-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,8 @@ The **{{< fa check >}} #/# Done** indicator reflects the completion status of yo
### Recent activity
At the bottom of the Document Overview page, you will also see quick view of any recent documentation activity.

Use the top tabs to narrow down the recent activity.

<!-- Below was removed as of Sept 17, 2024 -->

<!-- Click on **{{< fa eye >}} See all Activity** to be taken to the **Model Activity** page. -->
- Use the top tabs to narrow down the recent activity.
- Click on **{{< fa eye >}} See All Activity** to be taken to the **Model Activity** page.

## What's next
- [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd)
Expand Down
2 changes: 1 addition & 1 deletion site/guide/monitoring/enable-monitoring.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ To enable ongoing monitoring for a model, add `monitoring=True` to your code sni
api_host="https://api.prod.validmind.ai/api/v1/tracking",
api_key="...",
api_secret="...",
project="...",
model="...",
monitoring=True
)
```
Expand Down
Binary file modified site/notebooks.zip
Binary file not shown.
Loading