add guides section and fine-tuning overview #75
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check notebooks | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'notebooks/**' | |
| - 'scripts/**' | |
| - 'snippets/quickstart/**' | |
| - '.github/workflows/check-notebooks.yaml' | |
| pull_request: | |
| branches: | |
| - main | |
| paths: | |
| - 'notebooks/**' | |
| - 'scripts/**' | |
| - 'snippets/quickstart/**' | |
| - '.github/workflows/check-notebooks.yaml' | |
| workflow_dispatch: | |
| jobs: | |
| lint-and-typecheck: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: notebooks | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v6 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.12' | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v4 | |
| - name: Install dependencies | |
| run: | | |
| uv sync --extra dev | |
| - name: Run ruff linter | |
| run: | | |
| echo "π Running Ruff linter on notebooks..." | |
| uv run nbqa ruff . --output-format=github | |
| echo "" | |
| echo "β Ruff checks passed!" | |
| - name: Run mypy type check | |
| run: | | |
| echo "" | |
| echo "π Running mypy type checker on notebooks..." | |
| uv run nbqa mypy . | |
| echo "β Mypy type checks passed!" | |
| - name: Check snippet freshness | |
| working-directory: . | |
| run: | | |
| echo "π Checking that generated snippets match notebook source..." | |
| python3 scripts/generate_snippets.py --check | |
| echo "β Snippets are up to date!" | |
| - name: Summary | |
| if: success() | |
| run: | | |
| echo "" | |
| echo "β All required checks passed!" | |
| echo "π Validated $(find . -name '*.ipynb' | wc -l) notebooks" |