[docs] add an example usage of get_kernel_variants #1365
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: Test kernels | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| types: [opened, synchronize, reopened] # trigger on PRs | |
| paths-ignore: | |
| - "docs/**" | |
| - "*.md" | |
| - "kernel-builder/**" | |
| - "nix-builder/**" | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| name: Run kernels tests | |
| runs-on: | |
| group: aws-g6-24xlarge | |
| permissions: | |
| contents: read | |
| packages: write | |
| strategy: | |
| max-parallel: 4 | |
| matrix: | |
| python-version: ["3.10", "3.14"] | |
| torch-version: ["2.11.0", "2.12.0"] | |
| env: | |
| UV_PYTHON_PREFERENCE: only-managed | |
| CHECK_COVERAGE: ${{ matrix.python-version == '3.10' && matrix.torch-version == '2.12.0' }} | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Install uv and set the python version | |
| uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Override kernels-data source to local bindings | |
| working-directory: ./kernels | |
| run: uv add ../kernels-data/bindings/python --no-sync | |
| - name: Override the Torch version | |
| working-directory: ./kernels | |
| run: uv add "torch==${{ matrix.torch-version }}" --no-sync | |
| - name: Install the project | |
| working-directory: ./kernels | |
| run: uv sync --all-extras --dev | |
| - name: Install setuptools for Triton-based test | |
| working-directory: ./kernels | |
| run: uv pip install setuptools | |
| - name: Check typing | |
| working-directory: ./kernels | |
| run: uv run mypy src/kernels | |
| - name: Run tests | |
| working-directory: ./kernels | |
| env: | |
| HF_HUB_DOWNLOAD_TIMEOUT: 60 | |
| run: | | |
| if [ "${CHECK_COVERAGE}" = "true" ]; then | |
| uv run pytest tests \ | |
| --cov=kernels \ | |
| --cov-report=term-missing \ | |
| --cov-report=json:coverage.json | |
| else | |
| uv run pytest tests | |
| fi | |
| - name: Re-run dependency test with dependencies installed | |
| working-directory: ./kernels | |
| env: | |
| HF_HUB_DOWNLOAD_TIMEOUT: 60 | |
| run: | | |
| uv pip install einops nvidia-cutlass-dsl | |
| uv run pytest tests/test_deps.py | |
| - name: Import check without torch | |
| working-directory: ./kernels | |
| run: | | |
| uv pip uninstall torch | |
| uv run python -c "import kernels" | |
| - name: tvm-ffi check without torch | |
| working-directory: ./kernels | |
| run: | | |
| uv run pytest tests/test_tvm_ffi.py | |
| - name: Run command-line tools without Torch | |
| working-directory: ./kernels | |
| run: | | |
| uv run kernels versions kernels-community/activation | |
| # This is done to securely run the coverage test and to post comments even | |
| # on fork PRs. | |
| - name: Render coverage report for PR comment | |
| if: env.CHECK_COVERAGE == 'true' && github.event_name == 'pull_request' | |
| working-directory: ./kernels | |
| env: | |
| HEAD_SHA: ${{ github.event.pull_request.head.sha }} | |
| PR_NUMBER: ${{ github.event.pull_request.number }} | |
| PY_VERSION: ${{ matrix.python-version }} | |
| TORCH_VERSION: ${{ matrix.torch-version }} | |
| run: | | |
| set -euo pipefail | |
| mkdir -p coverage-artifact | |
| PCT=$(jq -r '.totals.percent_covered' coverage.json) | |
| PCT_INT=$(printf '%.0f' "$PCT") | |
| PCT_DISPLAY=$(printf '%.1f' "$PCT") | |
| if [ "$PCT_INT" -ge 80 ]; then | |
| EMOJI=":white_check_mark:" | |
| elif [ "$PCT_INT" -ge 70 ]; then | |
| EMOJI=":warning:" | |
| else | |
| EMOJI=":red_circle:" | |
| fi | |
| uv run coverage report --format=markdown > coverage-artifact/cov-table.md | |
| { | |
| echo "<!-- coverage-report -->" | |
| echo "## Coverage report — \`kernels/\`" | |
| echo | |
| echo "> Measured on: **Python ${PY_VERSION} / Torch ${TORCH_VERSION}**." | |
| echo "> Other CI configurations are not included in this number." | |
| echo "> Hardware-gated code paths (ROCm/XPU/NPU/Darwin/Windows) are excluded or unreachable on the Linux+CUDA runner." | |
| echo | |
| echo "**Total coverage: \`${PCT_DISPLAY}%\`** — threshold: 80% — ${EMOJI}" | |
| echo | |
| echo "<details>" | |
| echo "<summary>Per-file breakdown</summary>" | |
| echo | |
| cat coverage-artifact/cov-table.md | |
| echo | |
| echo "</details>" | |
| echo | |
| echo "_Updated by the \`Test kernels\` workflow on commit \`${HEAD_SHA}\`._" | |
| } > coverage-artifact/body.md | |
| # `workflow_run.pull_requests` is empty for fork PRs, so the | |
| # downstream comment workflow reads the PR number from here. | |
| echo "${PR_NUMBER}" > coverage-artifact/pr_number.txt | |
| - name: Upload coverage artifact | |
| if: env.CHECK_COVERAGE == 'true' && github.event_name == 'pull_request' | |
| uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 | |
| with: | |
| name: coverage-report | |
| path: kernels/coverage-artifact/ | |
| retention-days: 1 | |
| if-no-files-found: error |