Skip to content

Commit 9341f1b

Browse files
nrichersvalidbeckgithub-actions[bot]mehdi0501
authored
Merge staging into prod (#642)
* Updated mathematical formula support for content blocks (#631) * README tweak * Edited math formula instructions * Updated documentation for Metrics Over Time (#633) * Pulling in current latest notebooks * Edits to Work with metrics over time * Test adding anywidget dependency * Yay it works * Adding Juan's suggestion * Pulling in latest updates to Log metics notebook * Edits to Export documentation for validation reports (#635) * Release notes to Sprint 66 (`25.01`) (#634) (#641) * Generate initial release notes * Initial edit pass * Add versioning callout * Edits & tweaks * Get latest library source * Edits * Fix borked links * Add toggle for demo notebook execution * Fix stray git command * Update site/releases/2025/2025-jan-31/release-notes.qmd * Update site/releases/2025/2025-jan-31/release-notes.qmd * Address review comment from Mehdi * Add tech deep dive blog link to December release notes * Address review comments * Address more review comments * Fix notebook link * Add animated GIF for risk assessment prompt * Fixing borked tech deep dive add * Moving Enhancements into the right section * Editing & cleanup * Add missing math editor release notes & .tr some buttons because .tc is too messy * Missing docs links * Oops, wrong link * last tweak i swear * Fix some more broken links * Grammar better --------- Co-authored-by: Nik Richers <nik@validmind.ai> Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com>
1 parent e0fd2ea commit 9341f1b

File tree

56 files changed

+4244
-696
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+4244
-696
lines changed

‎.github/actions/demo-notebook/action.yml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ inputs:
66
description: "Load the created .env file"
77
required: true
88

9-
runs:
9+
runs:
1010
using: "composite"
11-
steps:
11+
steps:
1212
- name: Install python3 for Jupyter Notebooks
1313
shell: bash
1414
run: |
@@ -18,10 +18,11 @@ runs:
1818
- name: Install validmind for notebook execution
1919
shell: bash
2020
run: |
21-
pip install validmind
22-
pip install validmind[llm]
23-
pip install fairlearn aequitas
21+
pip install validmind
22+
pip install validmind[llm]
23+
pip install fairlearn aequitas
2424
pip install shap==0.44.1
25+
pip install anywidget
2526
2627
- name: Ensure .env file is available
2728
shell: bash
@@ -36,9 +37,9 @@ runs:
3637
shell: bash
3738
if: ${{ steps.find_env.outcome == 'success' }}
3839
run: |
39-
cd site
40+
cd site
4041
source ../${{ inputs.env_file }}
41-
quarto render --profile exe-demo notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
42+
quarto render --profile exe-demo notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
4243
echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
4344
cat render_errors.log;
4445
exit 1;

‎.github/actions/prod-notebook/action.yml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ inputs:
66
description: "Load the created .env file"
77
required: true
88

9-
runs:
9+
runs:
1010
using: "composite"
11-
steps:
11+
steps:
1212
- name: Install python3 for Jupyter Notebooks
1313
shell: bash
1414
run: |
@@ -18,10 +18,11 @@ runs:
1818
- name: Install validmind for notebook execution
1919
shell: bash
2020
run: |
21-
pip install validmind
22-
pip install validmind[llm]
23-
pip install fairlearn aequitas
21+
pip install validmind
22+
pip install validmind[llm]
23+
pip install fairlearn aequitas
2424
pip install shap==0.44.1
25+
pip install anywidget
2526
2627
- name: Ensure .env file is available
2728
shell: bash
@@ -36,9 +37,9 @@ runs:
3637
shell: bash
3738
if: ${{ steps.find_env.outcome == 'success' }}
3839
run: |
39-
cd site
40+
cd site
4041
source ../${{ inputs.env_file }}
41-
quarto render --profile exe-prod notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
42+
quarto render --profile exe-prod notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
4243
echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
4344
cat render_errors.log;
4445
exit 1;

‎.github/actions/staging-notebook/action.yml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ inputs:
66
description: "Load the created .env file"
77
required: true
88

9-
runs:
9+
runs:
1010
using: "composite"
11-
steps:
11+
steps:
1212
- name: Install python3 for Jupyter Notebooks
1313
shell: bash
1414
run: |
@@ -18,10 +18,11 @@ runs:
1818
- name: Install validmind for notebook execution
1919
shell: bash
2020
run: |
21-
pip install validmind
22-
pip install validmind[llm]
23-
pip install fairlearn aequitas
21+
pip install validmind
22+
pip install validmind[llm]
23+
pip install fairlearn aequitas
2424
pip install shap==0.44.1
25+
pip install anywidget
2526
2627
- name: Ensure .env file is available
2728
shell: bash
@@ -36,9 +37,9 @@ runs:
3637
shell: bash
3738
if: ${{ steps.find_env.outcome == 'success' }}
3839
run: |
39-
cd site
40+
cd site
4041
source ../${{ inputs.env_file }}
41-
quarto render --profile exe-staging notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
42+
quarto render --profile exe-staging notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
4243
echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
4344
cat render_errors.log;
4445
exit 1;

‎.github/workflows/deploy-docs-prod.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ jobs:
2828

2929
- name: Render prod docs site
3030
run: |
31-
cd site
32-
quarto render --profile production &> render_errors.log || {
31+
cd site
32+
quarto render --profile production &> render_errors.log || {
3333
echo "Quarto render failed immediately";
3434
cat render_errors.log;
3535
exit 1;
@@ -39,11 +39,11 @@ jobs:
3939
id: create_env
4040
run: |
4141
touch .env
42-
echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env
43-
echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env
44-
echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env
45-
echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env
46-
cat .env
42+
echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env
43+
echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env
44+
echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env
45+
echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env
46+
cat .env
4747
4848
# Only execute the prod notebook if .env file is created
4949
- name: Execute prod Intro for Model Developers notebook

‎.github/workflows/deploy-docs-staging.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ jobs:
2828

2929
- name: Render staging docs site
3030
run: |
31-
cd site
32-
quarto render --profile staging &> render_errors.log || {
31+
cd site
32+
quarto render --profile staging &> render_errors.log || {
3333
echo "Quarto render failed immediately";
3434
cat render_errors.log;
3535
exit 1;
@@ -39,11 +39,11 @@ jobs:
3939
id: create_env
4040
run: |
4141
touch .env
42-
echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env
43-
echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env
44-
echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env
45-
echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env
46-
cat .env
42+
echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env
43+
echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env
44+
echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env
45+
echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env
46+
cat .env
4747
4848
# Only execute the staging notebook if .env file is created
4949
- name: Execute staging Intro for Model Developers notebook

‎.github/workflows/validate-docs-site.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ jobs:
2727

2828
- name: Render demo docs site
2929
run: |
30-
cd site
31-
quarto render --profile development &> render_errors.log || {
30+
cd site
31+
quarto render --profile development &> render_errors.log || {
3232
echo "Quarto render failed immediately";
3333
cat render_errors.log;
3434
exit 1;
@@ -52,21 +52,21 @@ jobs:
5252
id: create_env
5353
run: |
5454
touch .env
55-
echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env
56-
echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env
57-
echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env
58-
echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env
59-
cat .env
55+
echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env
56+
echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env
57+
echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env
58+
echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env
59+
cat .env
6060
6161
# Only execute the demo notebook if .env file is created
6262
- name: Execute demo Intro for Model Developers notebook
63-
if: ${{ steps.create_env.outcome == 'success' }}
63+
if: ${{ env.ENABLE_DEMO_NOTEBOOK == 'true' && steps.create_env.outcome == 'success' }}
6464
uses: ./.github/actions/demo-notebook
6565
id: execute-demo-notebook
6666
with:
6767
env_file: .env
6868

69-
- name: Test for warnings or errors
69+
- name: Test for warnings or errors
7070
run: |
7171
if grep -q 'WARN:\|ERROR:' site/render_errors.log; then
7272
echo "Warnings or errors detected during Quarto render"
@@ -76,7 +76,7 @@ jobs:
7676
echo "No warnings or errors detected during Quarto render"
7777
fi
7878
79-
# Demo bucket is in us-east-1
79+
# Demo bucket is in us-east-1
8080
- name: Configure AWS credentials
8181
run: aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID }} && aws configure set aws_secret_access_key ${{ secrets.AWS_SECRET_ACCESS_KEY }} && aws configure set default.region us-east-1
8282

‎README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ You need:
2626

2727
## How to contribute
2828

29-
First, read through and familiarize yourself with our [ValidMind style guide](https://docs.validmind.ai/about/contributing/style-guide/style-guide.html).
29+
> [!IMPORTANT]
30+
> First, read through and familiarize yourself with our [ValidMind style guide](https://docs.validmind.ai/about/contributing/style-guide/style-guide.html).
3031
3132
- Our core user guides are sourced in Quarto Markdown under [`site/guide`](https://github.com/validmind/documentation/tree/main/site/guide).
3233
- If you create new documentation, make sure to add it to the [`_quarto.yml`](https://github.com/validmind/documentation/blob/main/site/_quarto.yml) file.
@@ -133,7 +134,8 @@ make get-source
133134

134135
After you pull in the changes, commit them to this repo as part of the release notes process.
135136

136-
**Want to author new code samples?** Refer to our [Jupyter Notebook template Quickstart](https://github.com/validmind/validmind-library/tree/main/notebooks/templates)!
137+
> [!TIP]
138+
> **Want to author new code samples?** Refer to our [Jupyter Notebook template Quickstart](https://github.com/validmind/validmind-library/tree/main/notebooks/templates)!
137139
138140
<!-- September 16, 2024: Need to mention rendered Python `.html` docs and generated `.md` test descriptions -->
139141

‎site/_quarto.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@ website:
170170
- text: "---"
171171
- text: "Releases"
172172
# MAKE-RELEASE-NOTES-EMBED-MARKER
173+
- releases/2025/2025-jan-31/release-notes.qmd
173174
# CURRENT-YEAR-END-MARKER
174175
- file: releases/2024/2024-releases.qmd
175176
contents:

‎site/guide/model-documentation/equation-preview.png

43 KB
Loading

‎site/guide/model-documentation/export-documentation.qmd

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ aliases:
77

88
Export your model documentation or validation reports as Microsoft Word files (`.docx`) for use outside of the {{< var validmind.platform >}}.
99

10+
::: {.callout}
11+
{{< var vm.product >}} supports Word 365, Word 2019, Word 2016, and Word 2013.
12+
:::
13+
14+
1015
::: {.attn}
1116

1217
## Prerequisites
@@ -16,10 +21,6 @@ Export your model documentation or validation reports as Microsoft Word files (`
1621
- [x] Model documentation is completed or in progress.[^2]
1722
- [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3]
1823

19-
::: {.callout}
20-
{{< var vm.product >}} supports Word 365, Word 2019, Word 2016, and Word 2013.
21-
:::
22-
2324
:::
2425

2526
## Export model documentation
@@ -32,30 +33,23 @@ Export your model documentation or validation reports as Microsoft Word files (`
3233

3334
4. In right sidebar, click **{{< fa download >}} Export Document**.
3435

35-
5. Configure the export options:
36-
37-
<!--- - Check **Include comment threads** to include comment threads in the exported file.
38-
- Check **Section activity logs** to include a history of changes in each section of the documentation. --->
39-
- Choose the file format for export. We currently support exporting to `.docx` for Microsoft Word format.
40-
41-
6. Click **{{< fa file-arrow-down >}} Download File** to download the file locally on your machine.
36+
7. Click **{{< fa file-arrow-down >}} Download File** to download the file locally on your machine.
4237

4338
## Export validation report
4439

4540
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
4641

4742
2. Select a model or find your model by applying a filter or searching for it.[^5]
4843

49-
<!--- NR Mar 2024 this option does not yet exist --->
5044
3. In the left sidebar that appears for your model, click **{{< fa shield >}} Validation Report**.
5145

5246
4. In right sidebar, click **{{< fa download >}} Export Document**.
5347

54-
5. Configure the export options:
48+
5. Configure what is exported in your document by checking off the relevant boxes:
5549

56-
<!--- - Check **Include comment threads** to include comment threads in the exported file.
57-
- Check **Section activity logs** to include a history of changes in each section of the documentation. --->
58-
- Choose the file format for export. We currently support exporting to `.docx` for Microsoft Word format.
50+
- Include compliance summary[^6]
51+
- Include validation guidelines information[^7]
52+
- Include validation guideline adherence details
5953

6054
6. Click **{{< fa file-arrow-down >}} Download File** to download the file locally on your machine.
6155

@@ -80,3 +74,6 @@ Export your model documentation or validation reports as Microsoft Word files (`
8074

8175
[^5]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
8276

77+
[^6]: [Assess compliance](/guide/model-validation/assess-compliance.qmd)
78+
79+
[^7]: [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd)

0 commit comments

Comments
 (0)