Skip to content

add guidelines to creating notebooks to be tested on the CI #228

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add guidelines to creating notebooks to be tested on the CI #228

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aef428c
add guidelines to creating notebooks to be tested on the CI
atqy Jul 27, 2023
29ed23a
add guidelines to creating notebooks to be tested on the CI
atqy Jul 27, 2023
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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ Contributions via pull requests are much appreciated. Before sending us a pull r

### Create the Example

Notebooks in Studio Lab Examples are tested on a daily basis. Here are a few rules you need to follow to ensure that your notebook passes the CI test and is not flagged for failing:

* Make sure your environment YML file starts with the prefix "env". Otherwise the CI system will not detect it and use the default Studio Lab environment.
* Your environment YML should be located either in the same directory as your notebook or in a child directory of your notebook's directory.
* Make sure to include the "Open in Studio Lab" icon in your notebooks to make sure they are treated as a Studio Lab notebook in testing. This can be done by adding `[![Open In Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/aws/studio-lab-examples/blob/main/NOTEBOOK_PATH)` in a markdown cell underneath your notebook's title. The NOTEBOOK_PATH is location of your notebook in the repo relative to the repo's root directory (i.e. `computer-vision/weather-data/weather-image-classification-pytorch.ipynb`).

Here are some general guidelines to follow when writing example notebooks:

* Do not require user input to run the notebook.
Expand Down