Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#155: Added a Notebook Link Checker to Github Actions #156

Merged
merged 3 commits into from
Jan 31, 2024
Merged

#155: Added a Notebook Link Checker to Github Actions #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00f81b6
Added a Notebook Link Checker to Github Actions
tkilias Jan 31, 2024
4847b93
Fix links in the notebooks
tkilias Jan 31, 2024
b423bef
Updated changelog
tkilias Jan 31, 2024
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
22 changes: 22 additions & 0 deletions .github/workflows/check_notebook_links.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Check Notebook Links

on:
push:
branches-ignore:
- "main"

jobs:
check_notebook_links:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Python & Poetry Environment
uses: ./.github/actions/prepare_poetry_env

- name: Run build ai-lab tests
run: >
poetry run pytest --check-links exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think it will search deep for all files in the directory?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably easier to give it a try and see what will happen.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from the CI run


exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/cloud_store_config.ipynb . [  0%]
..                                                                       [  1%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/main_config.ipynb . [  2%]
                                                                         [  2%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/start.ipynb . [  2%]
........                                                                 [  7%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/cloud/01_import_data.ipynb . [  8%]
...                                                                      [ 10%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/data/data_abalone.ipynb . [ 10%]
..                                                                       [ 11%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/data/data_content.ipynb . [ 12%]
.                                                                        [ 13%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/data/data_telescope.ipynb . [ 13%]
..                                                                       [ 14%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sagemaker/sme_deploy_model.ipynb . [ 15%]
.......                                                                  [ 19%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sagemaker/sme_init.ipynb . [ 19%]
....                                                                     [ 22%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sagemaker/sme_introduction.ipynb . [ 22%]
.                                                                        [ 23%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sagemaker/sme_train_model.ipynb . [ 23%]
.......                                                                  [ 27%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sklearn/sklearn_introduction.ipynb . [ 28%]
........                                                                 [ 33%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sklearn/sklearn_predict_abalone.ipynb . [ 33%]
.....                                                                    [ 36%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sklearn/sklearn_predict_telescope.ipynb . [ 37%]
.....                                                                    [ 40%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sklearn/sklearn_predict_udf.ipynb . [ 41%]
..                                                                       [ 42%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sklearn/sklearn_train_abalone.ipynb . [ 42%]
.......                                                                  [ 47%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sklearn/sklearn_train_telescope.ipynb . [ 47%]
........                                                                 [ 52%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/slc/script-languages.ipynb . [ 52%]
......                                                                   [ 56%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/masked_modelling.ipynb . [ 57%]
........                                                                 [ 61%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/question_answering.ipynb . [ 61%]
.......                                                                  [ 66%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/sequence_classification.ipynb . [ 66%]
.......                                                                  [ 70%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/te_init.ipynb . [ 71%]
.                                                                        [ 72%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/te_introduction.ipynb . [ 72%]
.........                                                                [ 77%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/text_generation.ipynb . [ 78%]
......                                                                   [ 82%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/token_classification.ipynb . [ 82%]
.......                                                                  [ 86%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/translation.ipynb . [ 87%]
.......                                                                  [ 91%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/zero_shot_classification.ipynb . [ 92%]
.......                                                                  [ 96%]
exasol/ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/transformers/utils/model_retrieval.ipynb . [ 97%]

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks convincing.


1 change: 1 addition & 0 deletions doc/changes/changes_0.1.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Version: 0.1.0
* #255: Renamed data science sandbox to exasol-ai-lab
* #145: Added Docker Test Library to prepare Notebook tests
* #151: Setup SageMaker Credentials for notebook testing in the CI
* #155: Added a Notebook Link Checker to Github Actions

## Bug Fixes

Expand Down
2 changes: 1 addition & 1 deletion .../ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sagemaker/sme_deploy_model.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"# Model deployment\n",
"\n",
"In this notebook, we will deploy the binary classification model created in the [previous notebook](train_model.ipynb) to a real-time AWS SageMaker endpoint. We will then use the model to make predictions on a test dataset. Please refer to the SageMaker Extension <a href=\"https://github.com/exasol/sagemaker-extension/blob/main/doc/user_guide/user_guide.md#prediction-on-aws-sagemaker-endpoint\" target=\"_blank\" rel=\"noopener\">User Guide</a> for a detailed description of this process.\n",
"In this notebook, we will deploy the binary classification model created in the [previous notebook](sme_train_model.ipynb) to a real-time AWS SageMaker endpoint. We will then use the model to make predictions on a test dataset. Please refer to the SageMaker Extension <a href=\"https://github.com/exasol/sagemaker-extension/blob/main/doc/user_guide/user_guide.md#prediction-on-aws-sagemaker-endpoint\" target=\"_blank\" rel=\"noopener\">User Guide</a> for a detailed description of this process.\n",
"\n",
"<b>Important! Please make sure you perform the last step - deletion of the endpoint. Leaving the endpoint in the cloud will incur continuous charges by AWS.</b>\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion .../ds/sandbox/runtime/ansible/roles/jupyter/files/notebook/sagemaker/sme_introduction.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"metadata": {},
"source": [
"The extension requires a number of initialization steps.\n",
"Please proceed to the [extension initialization](sme_int.ipynb) notebook."
"Please proceed to the [extension initialization](sme_init.ipynb) notebook."
]
},
{
Expand Down
Loading
Loading