Skip to content

Commit 1256cf5

Browse files
validbeckvalidbeck
authored
Merge pull request #551 from validmind/beck/fixing-2024feb14-release
Fixing merge conflicts for PR#550
2 parents 2dbb17c + 7c2e13c commit 1256cf5

File tree

149 files changed

+96462
-7632
lines changed

Some content is hidden

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

149 files changed

+96462
-7632
lines changed

‎.env.example

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
OPENAI_API_KEY=ADD_YOUR_KEY_HERE
1+
OPENAI_API_KEY=ADD_YOUR_KEY_HERE
2+
3+
# API INFO TO RUN /notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb
4+
PLATFORM_API_KEY=ADD_YOUR_API_KEY_HERE
5+
PLATFORM_API_SECRET=ADD_YOUR_API_SECRET_HERE

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Execute demo notebook
2+
description: Installs python3, validmind, checks dependencies then executes ONLY the Intro for Model Developers notebook with development heap tracking
3+
4+
inputs: {}
5+
6+
runs:
7+
using: "composite"
8+
steps:
9+
- name: Install python3 for Jupyter Notebooks
10+
shell: bash
11+
run: |
12+
python3 -m pip install jupyter
13+
python -m pip install --upgrade pip
14+
15+
- name: Install validmind for notebook execution
16+
shell: bash
17+
run: |
18+
pip install validmind
19+
pip install validmind[llm]
20+
pip install fairlearn aequitas
21+
pip install shap==0.44.1
22+
23+
- name: Check dependencies
24+
shell: bash
25+
run: |
26+
pip install pycairo
27+
pip check
28+
29+
- name: Execute ONLY the Intro for Model Developers notebook with heap development
30+
shell: bash
31+
run: |
32+
cd site
33+
quarto render --profile exe-demo notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
34+
echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
35+
cat render_errors.log;
36+
exit 1;
37+
}

‎.github/actions/fetch-quarto/action.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Fetch Quarto
2+
description: Checks out repo then downloads & installs the latest version of Quarto
3+
4+
inputs: {}
5+
6+
runs:
7+
using: "composite"
8+
steps:
9+
- name: Get latest Quarto release URL
10+
id: get-quarto-url
11+
shell: bash
12+
run: |
13+
API_URL="https://api.github.com/repos/quarto-dev/quarto-cli/releases/latest"
14+
DOWNLOAD_URL=$(curl -s $API_URL | jq -r '.assets[] | select(.name | endswith("linux-amd64.deb")).browser_download_url')
15+
echo "DOWNLOAD_URL=$DOWNLOAD_URL" >> $GITHUB_ENV
16+
17+
- name: Download and install Quarto
18+
shell: bash
19+
run: |
20+
wget ${{ env.DOWNLOAD_URL }} -O quarto-latest-linux-amd64.deb
21+
sudo dpkg -i quarto-latest-linux-amd64.deb

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Execute prod notebook
2+
description: Installs python3, validmind, checks dependencies then executes ONLY the Intro for Model Developers notebook with production heap tracking
3+
4+
inputs: {}
5+
6+
runs:
7+
using: "composite"
8+
steps:
9+
- name: Install python3 for Jupyter Notebooks
10+
shell: bash
11+
run: |
12+
python3 -m pip install jupyter
13+
python -m pip install --upgrade pip
14+
15+
- name: Install validmind for notebook execution
16+
shell: bash
17+
run: |
18+
pip install validmind
19+
pip install validmind[llm]
20+
pip install fairlearn aequitas
21+
pip install shap==0.44.1
22+
23+
- name: Check dependencies
24+
shell: bash
25+
run: |
26+
pip install pycairo
27+
pip check
28+
29+
- name: Execute ONLY the Intro for Model Developers notebook with heap production
30+
shell: bash
31+
run: |
32+
cd site
33+
quarto render --profile exe-prod notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
34+
echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
35+
cat render_errors.log;
36+
exit 1;
37+
}

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Execute staging notebook
2+
description: Installs python3, validmind, checks dependencies then executes ONLY the Intro for Model Developers notebook with staging heap tracking
3+
4+
inputs: {}
5+
6+
runs:
7+
using: "composite"
8+
steps:
9+
- name: Install python3 for Jupyter Notebooks
10+
shell: bash
11+
run: |
12+
python3 -m pip install jupyter
13+
python -m pip install --upgrade pip
14+
15+
- name: Install validmind for notebook execution
16+
shell: bash
17+
run: |
18+
pip install validmind
19+
pip install validmind[llm]
20+
pip install fairlearn aequitas
21+
pip install shap==0.44.1
22+
23+
- name: Check dependencies
24+
shell: bash
25+
run: |
26+
pip install pycairo
27+
pip check
28+
29+
- name: Execute ONLY the Intro for Model Developers notebook with heap staging
30+
shell: bash
31+
run: |
32+
cd site
33+
quarto render --profile exe-staging notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
34+
echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
35+
cat render_errors.log;
36+
exit 1;
37+
}

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

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,10 @@ jobs:
1818
- name: Check out repository
1919
uses: actions/checkout@v2
2020

21-
- name: Get latest Quarto release URL
22-
id: get-quarto-url
23-
run: |
24-
API_URL="https://api.github.com/repos/quarto-dev/quarto-cli/releases/latest"
25-
DOWNLOAD_URL=$(curl -s $API_URL | jq -r '.assets[] | select(.name | endswith("linux-amd64.deb")).browser_download_url')
26-
echo "DOWNLOAD_URL=$DOWNLOAD_URL" >> $GITHUB_ENV
27-
28-
- name: Download and install Quarto
29-
run: |
30-
wget ${{ env.DOWNLOAD_URL }} -O quarto-latest-linux-amd64.deb
31-
sudo dpkg -i quarto-latest-linux-amd64.deb
21+
- name: Fetch Quarto
22+
uses: ./.github/actions/fetch-quarto
3223

33-
- name: Render docs site
24+
- name: Render prod docs site
3425
run: |
3526
cd site
3627
quarto render --profile production &> render_errors.log || {
@@ -39,9 +30,27 @@ jobs:
3930
exit 1;
4031
}
4132
33+
# See if site/notebooks/ has updates
34+
- name: Filter changed files
35+
uses: dorny/paths-filter@v2
36+
id: filter
37+
with:
38+
filters: |
39+
notebooks:
40+
- 'site/notebooks/**'
41+
42+
# If yes then execute the prod notebook
43+
- name: Execute prod Intro for Model Developers notebook
44+
if: steps.filter.outputs.notebooks == 'true'
45+
uses: ./.github/actions/prod-notebook
46+
id: execute-prod-notebook
47+
env:
48+
PLATFORM_API_KEY: ${{ secrets.PLATFORM_API_KEY }}
49+
PLATFORM_API_SECRET: ${{ secrets.PLATFORM_API_SECRET }}
50+
4251
# Prod bucket is in us-east-1
4352
- name: Configure AWS credentials
4453
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
4554

46-
- name: Deploy docs site
55+
- name: Deploy docs prod site
4756
run: aws s3 sync site/_site s3://docs-ci-cd-prod/site --delete && aws cloudfront create-invalidation --distribution-id E2I9R40IH01NW3 --paths "/*" --no-cli-pager

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

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,10 @@ jobs:
1818
- name: Check out repository
1919
uses: actions/checkout@v2
2020

21-
- name: Get latest Quarto release URL
22-
id: get-quarto-url
23-
run: |
24-
API_URL="https://api.github.com/repos/quarto-dev/quarto-cli/releases/latest"
25-
DOWNLOAD_URL=$(curl -s $API_URL | jq -r '.assets[] | select(.name | endswith("linux-amd64.deb")).browser_download_url')
26-
echo "DOWNLOAD_URL=$DOWNLOAD_URL" >> $GITHUB_ENV
27-
28-
- name: Download and install Quarto
29-
run: |
30-
wget ${{ env.DOWNLOAD_URL }} -O quarto-latest-linux-amd64.deb
31-
sudo dpkg -i quarto-latest-linux-amd64.deb
21+
- name: Fetch Quarto
22+
uses: ./.github/actions/fetch-quarto
3223

33-
- name: Render docs site
24+
- name: Render staging docs site
3425
run: |
3526
cd site
3627
quarto render --profile staging &> render_errors.log || {
@@ -39,9 +30,27 @@ jobs:
3930
exit 1;
4031
}
4132
33+
# See if site/notebooks/ has updates
34+
- name: Filter changed files
35+
uses: dorny/paths-filter@v2
36+
id: filter
37+
with:
38+
filters: |
39+
notebooks:
40+
- 'site/notebooks/**'
41+
42+
# If yes then execute the staging notebook
43+
- name: Execute staging Intro for Model Developers notebook
44+
if: steps.filter.outputs.notebooks == 'true'
45+
uses: ./.github/actions/staging-notebook
46+
id: execute-staging-notebook
47+
env:
48+
PLATFORM_API_KEY: ${{ secrets.PLATFORM_API_KEY }}
49+
PLATFORM_API_SECRET: ${{ secrets.PLATFORM_API_SECRET }}
50+
4251
# Staging bucket is in us-west-2
4352
- name: Configure AWS credentials
4453
run: aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID_STAGING }} && aws configure set aws_secret_access_key ${{ secrets.AWS_SECRET_ACCESS_KEY_STAGING }} && aws configure set default.region us-west-2
4554

46-
- name: Deploy docs site
55+
- name: Deploy docs staging site
4756
run: aws s3 sync site/_site s3://docs-ci-cd-staging/site --delete && aws cloudfront create-invalidation --distribution-id E2FB73KGY63MV6 --paths "/*" --no-cli-pager

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

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,35 @@ jobs:
1717
- name: Check out repository
1818
uses: actions/checkout@v2
1919

20-
- name: Get latest Quarto release URL
21-
id: get-quarto-url
22-
run: |
23-
API_URL="https://api.github.com/repos/quarto-dev/quarto-cli/releases/latest"
24-
DOWNLOAD_URL=$(curl -s $API_URL | jq -r '.assets[] | select(.name | endswith("linux-amd64.deb")).browser_download_url')
25-
echo "DOWNLOAD_URL=$DOWNLOAD_URL" >> $GITHUB_ENV
26-
27-
- name: Download and install Quarto
28-
run: |
29-
wget ${{ env.DOWNLOAD_URL }} -O quarto-latest-linux-amd64.deb
30-
sudo dpkg -i quarto-latest-linux-amd64.deb
20+
- name: Fetch Quarto
21+
uses: ./.github/actions/fetch-quarto
3122

32-
- name: Render site
23+
- name: Render demo docs site
3324
run: |
3425
cd site
3526
quarto render --profile development &> render_errors.log || {
3627
echo "Quarto render failed immediately";
3728
cat render_errors.log;
3829
exit 1;
3930
}
31+
32+
# See if site/notebooks/ has updates
33+
- name: Filter changed files
34+
uses: dorny/paths-filter@v2
35+
id: filter
36+
with:
37+
filters: |
38+
notebooks:
39+
- 'site/notebooks/**'
40+
41+
# If yes then execute the demo notebook
42+
- name: Execute demo Intro for Model Developers notebook
43+
if: steps.filter.outputs.notebooks == 'true'
44+
uses: ./.github/actions/demo-notebook
45+
id: execute-demo-notebook
46+
env:
47+
PLATFORM_API_KEY: ${{ secrets.PLATFORM_API_KEY }}
48+
PLATFORM_API_SECRET: ${{ secrets.PLATFORM_API_SECRET }}
4049

4150
- name: Test for warnings or errors
4251
run: |
@@ -48,7 +57,7 @@ jobs:
4857
echo "No warnings or errors detected during Quarto render"
4958
fi
5059
51-
# Demo bucket is in us-east-1
60+
# Demo bucket is in us-east-1
5261
- name: Configure AWS credentials
5362
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
5463

‎.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,6 @@ site/.quarto/
1111
site/.gitignore
1212

1313
# Rendered docs site
14-
site/_site/
14+
site/_site/
15+
site/_freeze/
16+
site/notebooks/tutorials/my_tests/

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,4 +135,4 @@ After you pull in the changes, commit them to this repo as part of the release n
135135

136136
<!-- September 16, 2024: Need to mention rendered Python `.html` docs and generated `.md` test descriptions -->
137137

138-
<!-- Testing simplified merge strategy -->
138+
<!-- Testing conditional changes on site/notebooks/ -->

‎internal/templates/_single-source.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@
44
<!-- VISIBLE IN USER GUIDES ONlY -->
55

66
:::: {.content-visible unless-format="revealjs"}
7-
1. In the left sidebar, click **Model Inventory**.
7+
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
88

99
1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
1010

11-
1. In the expanded sidebar that appears for your model, click **Model Activity**.
11+
1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.
1212

1313
::::
1414

1515

1616
<!-- VISIBLE IN TRAINING SLIDES ONLY -->
1717

1818
:::: {.content-hidden unless-format="revealjs"}
19-
1. In the left sidebar, click **Model Inventory**.
19+
1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
2020

2121
1. Select a model by clicking on it or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models).
2222

23-
1. In the expanded sidebar that appears for your model, click **Model Activity**.
23+
1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**.
2424

2525
::::

‎internal/templates/videos/_extensions/quarto-ext/fontawesome/assets/css/all.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4490,7 +4490,7 @@ readers do not read off random characters that represent icons */
44904490
.fa-skull::before {
44914491
content: "\f54c"; }
44924492

4493-
.fa-tower-broadcast::before {
4493+
.fa-wifi::before {
44944494
content: "\f519"; }
44954495

44964496
.fa-broadcast-tower::before {

‎internal/templates/videos/index_files/libs/quarto-contrib/fontawesome6-0.1.0/all.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4490,7 +4490,7 @@ readers do not read off random characters that represent icons */
44904490
.fa-skull::before {
44914491
content: "\f54c"; }
44924492

4493-
.fa-tower-broadcast::before {
4493+
.fa-wifi::before {
44944494
content: "\f519"; }
44954495

44964496
.fa-broadcast-tower::before {

‎site/_extensions/quarto-ext/fontawesome/assets/css/all.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5680,7 +5680,7 @@ readers do not read off random characters that represent icons */
56805680
.fa-tornado::before {
56815681
content: "\f76f"; }
56825682

5683-
.fa-tower-broadcast::before {
5683+
.fa-wifi::before {
56845684
content: "\f519"; }
56855685

56865686
.fa-broadcast-tower::before {

‎site/_quarto-exe-demo.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
format:
2+
html:
3+
page-layout: full
4+
navbar: false
5+
code-tools: true
6+
include-in-header:
7+
- environments/heap-development.html
8+
include-after-body:
9+
- https://unpkg.com/@jupyter-widgets/html-manager@*/dist/embed-amd.js
10+
execute:
11+
enabled: true
12+
freeze: auto

0 commit comments

Comments
 (0)