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.

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

Added tests for example notebooks #282

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
37 changes: 37 additions & 0 deletions .github/workflows/test-example-notebooks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Test Example Notebooks

on:
pull_request:
branches: ["master"]

jobs:
api-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Setup Python
uses: actions/setup-python@v1
with:
python-version: "3.8"

- name: Upgrade Pip
run: |
python -m pip install --upgrade pip
python -m pip install setuptools wheel

- name: Setup Linux
run: |
sudo apt-get install -y cmake libsndfile1

- name: Install Ludwig
run: |
pip install ludwig[full]

- name: Install test dependencies
run: pip install pytest nbmake

- name: Test example notebooks
run: pytest --nbmake --nbmake-timeout=3000 docs/examples/**/*ipynb
4 changes: 2 additions & 2 deletions docs/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ The requirements for additional functionality are separated out so that users ar
If your machine has a GPU to accelerate the training process, make sure you install a GPU-enabled version of PyTorch before installing Ludwig:

``` sh
pip install torch -f https://download.pytorch.org/whl/cu113/torch_stable.html
pip install torch -f https://download.pytorch.org/whl/cu118/torch_stable.html
```

The example above will install the latest version of PyTorch with CUDA 11.3. See the official [PyTorch docs](https://pytorch.org/get-started/locally/) for
The example above will install the latest version of PyTorch with CUDA 11.8. See the official [PyTorch docs](https://pytorch.org/get-started/locally/) for
more details on installing the right version of PyTorch for your environment.

# Docker { #with-docker }
Expand Down