Skip to content

Commit

Permalink
Merge branch 'main' into feature/#150-Use_multipart_upload_for_VM_ima…
Browse files Browse the repository at this point in the history
…ges_on_AWS
  • Loading branch information
ckunki committed Jan 31, 2024
2 parents 57ebbf2 + 71c8db1 commit 2c4b9a5
Show file tree
Hide file tree
Showing 8 changed files with 659 additions and 20 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/check_documentation_links.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Check Documentation Links

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

jobs:
check_documentation_links:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Link Checker
id: lychee
uses: lycheeverse/[email protected]
with:
fail: true
args: --verbose --no-progress 'doc/**/*.md' 'README.md'

22 changes: 22 additions & 0 deletions .github/workflows/check_notebook_links.yaml
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/
2 changes: 2 additions & 0 deletions doc/changes/changes_0.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Version: 0.1.0
* #150: Used multipart upload for VM images
* #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
* #157: Added link checker for the documentation

## Bug Fixes

Expand Down
6 changes: 3 additions & 3 deletions doc/developer_guide/notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Please add or update the notebook files in folder [exasol/ds/sandbox/runtime/ans
## Notebook Testing

We are running tests for the notebooks in the Docker Edition of the AI Lab. For this we are creating a Docker test setup in
[test_notebooks_in_dss_docker_image.py](test/integration/test_notebooks_in_dss_docker_image.py) which installs test libraries into the AI Lab Docker Image.
It further creates a new test and Docker Container for each notebook test in [test/notebooks](test/notebooks).
[test_notebooks_in_dss_docker_image.py](../../test/notebook_test_runner/test_notebooks_in_dss_docker_image.py) which installs test libraries into the AI Lab Docker Image.
It further creates a new test and Docker Container for each notebook test in [test/notebooks](../../test/notebooks).
Notebook test names need to fit the pattern `nbtest_*.py`, to prevent pytest running them outside of Docker setup.

Environment variables with the prefix `NBTEST_` with which you call
[test_notebooks_in_dss_docker_image.py](test/integration/test_notebooks_in_dss_docker_image.py) are forwarded
[test_notebooks_in_dss_docker_image.py](../../test/notebook_test_runner/test_notebooks_in_dss_docker_image.py) are forwarded
into the Docker container and to the notebook test. You can use this to forward secrets to the notebook tests.

By default all created containers and images are removed after running the tests regardless of success or failure.
Expand Down
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
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

0 comments on commit 2c4b9a5

Please sign in to comment.