Python application workflow (ndif-team/nnsight)
The Python application workflow from ndif-team/nnsight, explained and optimized by Latchkey.
CI health: D - needs work
Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the Python application workflow from the ndif-team/nnsight repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.
Below, Latchkey shows a faster, safer version produced by its optimization engine.
The workflow
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: Python application
on:
push:
branches: ["main", "dev"]
pull_request:
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.10
uses: actions/setup-python@v3
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pytest pillow
pip install ./
- name: Test with pytest
run: |
pytest \
tests/test_lm.py \
tests/test_tiny.py \
tests/test_0516_features.py \
tests/test_debug.py \
tests/test_memory_cleanup.py \
tests/test_multiple_wrappers.py \
tests/test_source.py \
tests/test_envoys.py \
tests/test_iter_edge_cases.py \
tests/test_transform.py \
tests/test_local_recursion.py \
tests/test_local_mutual_recursion.py \
tests/test_mutual_recursion.py \
tests/test_local_env.py \
tests/test_local_simulation.py \
--device cpu
The same workflow, on Latchkey
Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.
# This workflow will install Python dependencies, run tests and lint with a single version of Python # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python name: Python application on: push: branches: ["main", "dev"] pull_request: permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build: timeout-minutes: 30 runs-on: latchkey-small steps: - uses: actions/checkout@v3 - name: Set up Python 3.10 uses: actions/setup-python@v3 with: cache: 'pip' python-version: "3.10" - name: Install dependencies run: | python -m pip install --upgrade pip pip install pytest pillow pip install ./ - name: Test with pytest run: | pytest \ tests/test_lm.py \ tests/test_tiny.py \ tests/test_0516_features.py \ tests/test_debug.py \ tests/test_memory_cleanup.py \ tests/test_multiple_wrappers.py \ tests/test_source.py \ tests/test_envoys.py \ tests/test_iter_edge_cases.py \ tests/test_transform.py \ tests/test_local_recursion.py \ tests/test_local_mutual_recursion.py \ tests/test_mutual_recursion.py \ tests/test_local_env.py \ tests/test_local_simulation.py \ --device cpu
What changed
- Run on Latchkey managed runners with one line (
runs-on), which apply the fixes below automatically and self-heal transient failures. This example useslatchkey-small; pick the runner size that fits the job. - Cancel superseded runs when a branch or PR gets a newer push.
- Cache dependency installs on the setup step so they are served from cache.
- Add a job timeout so a hung step cannot burn hours of runner time.
What Latchkey heals here
This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:
- Dependency installs
This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.