Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
78 changes: 78 additions & 0 deletions .github/workflows/claude-code.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Claude Code

on:
issue_comment:
types: [created]
pull_request_review_comment:
types: [created]
issues:
types: [opened]

jobs:
claude-code:
# Early exit conditions:
# 1. Must be pytorch org
# 2. Must be triggered by pilot user
# 3. Must mention @claude
if: |
github.repository_owner == 'pytorch' &&
contains(fromJSON('[
"huydhn",
"seemethere",
"malfet",
"ZainRizvi",
"jeanschmidt",
"atalman",
"wdvr",
"izaitsevfb",
"yangw-dev",
"ezyang",
"drisspg",
"albanD",
"eellison",
"pytorch-auto-revert[bot]",
"janeyx99",
"SherlockNoMad",
"svekars",
"sekyondaMeta",
"AlannaBurke",
"ngimel"
]'), github.actor) &&
(
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'issues' && contains(github.event.issue.body, '@claude'))
)
runs-on: ubuntu-latest
timeout-minutes: 60
environment: bedrock
permissions:
contents: read
pull-requests: write
issues: write
id-token: write
steps:
# Fork PR support enabled by using izaitsevfb/claude-code-action@forked-pr-fix

- uses: actions/checkout@v4
with:
fetch-depth: 1

- name: Configure AWS credentials via OIDC
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: arn:aws:iam::308535385114:role/gha_workflow_claude_code
aws-region: us-east-1

- name: Run Claude Code
uses: izaitsevfb/claude-code-action@forked-pr-fix
with:
# We filter by github.actor at workflow level, there is no point of filtering here as well
allowed_bots: "*"
claude_args: "--model global.anthropic.claude-opus-4-6-v1"
settings: '{"alwaysThinkingEnabled": true}'
use_bedrock: "true"

- name: Upload usage metrics
if: always()
uses: pytorch/test-infra/.github/actions/upload-claude-usage@main
82 changes: 82 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Environment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, another note:

CLAUDE.md contains general guidelines for agents (including those run by people who check out the repo locally)

you might want to extract review-specific guidelines into a separate skill


If any tool you're trying to use (make, sphinx-build, lintrunner, python, etc.) is missing, always stop and ask the user if an environment is needed. Do NOT try to find alternatives or install these tools.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this conflicts with the installation instructions below. Ask claude to analyze the text for contradictions locally.


# Project Structure

This is the PyTorch Tutorials website (`pytorch.org/tutorials`), built with Sphinx and Sphinx Gallery.

- `beginner_source/`, `intermediate_source/`, `advanced_source/`, `recipes_source/`, `unstable_source/` — tutorial source files (`.py` and `.rst`)
- `index.rst`, `recipes_index.rst` — card listings and toctrees for the website
- `conf.py` — Sphinx configuration (gallery dirs, extensions, theme)
- `_static/` — images, CSS, and thumbnails
- `requirements.txt` — all Python dependencies (Sphinx, tutorial packages)
- `.jenkins/` — CI build scripts, data download logic, post-processing
- `Makefile` — build entry points

Tutorials authored as `.py` files use Sphinx Gallery format: top-level docstrings become RST prose, code blocks become executable cells. These are executed during CI builds and converted to Jupyter notebooks and HTML. Tutorials authored as `.rst` are static and their code is not executed.

# Build

- `make html-noplot` — builds HTML without executing tutorial code. Fast, no GPU needed. Use this for local validation of RST/Sphinx structure.
- `make docs` — full build that downloads data, executes all `.py` tutorials, and produces the final site. Requires a GPU-powered machine with CUDA.
- `GALLERY_PATTERN="my_tutorial.py" make html` — build only a single tutorial by name (regex supported).

The CI build runs inside Docker across 15 GPU-powered shards via `.jenkins/build.sh`. Do not attempt to replicate the full CI build locally unless you have a proper GPU setup.

# Linting

This repo uses `lintrunner`. Do not use `spin`, `flake8`, or other linters directly.

```
pip install lintrunner==0.12.5

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't it make more sense to pre-install these tools in the workflow?

lintrunner init
```

- `lintrunner -m main` — lint changes relative to the main branch
- `lintrunner --all-files` — lint all files in the repo

# Testing

There is no unit test suite. Validation is done by building tutorials:

- `make html-noplot` is the quick sanity check for RST and Sphinx errors.
- Full execution of `.py` tutorials is handled by CI (GPU shards). Do not attempt to run all tutorials locally.
- To test a single tutorial locally: `GALLERY_PATTERN="my_tutorial.py" make html`

# Tutorial File Format

- Interactive tutorials are `.py` files using Sphinx Gallery conventions. Filenames should end in `_tutorial.py`.
- Non-interactive tutorials are `.rst` files.
- Data dependencies must be added via `.jenkins/download_data.py`, not the Makefile. Follow the existing patterns in that file.
- New Python package dependencies go in `requirements.txt`.

# Adding a New Tutorial

1. Place the file in the appropriate `*_source/` directory based on difficulty level.
2. Add a `customcarditem` entry in `index.rst` (or `recipes_index.rst` for recipes).
3. Add the tutorial to the corresponding `toctree` in `index.rst`.
4. Add a square, high-resolution thumbnail image to `_static/img/thumbnails/cropped/`.

# Commit Messages

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure the current permissions allow committing:

    permissions:
      contents: read

also, please note that write access could be a security concern.


Don't commit unless the user explicitly asks you to.

When writing a commit message, don't make a bullet list of the individual
changes. Instead, if the PR is large, explain the order to review changes
(e.g., the logical progression), or if it's short just omit the bullet list
entirely.

Disclose that the PR was authored with Claude.

Do not use ghstack. It is not supported in this repo.

# Coding Style Guidelines

Follow these rules for all code changes in this repository:

- Minimize comments; be concise; code should be self-explanatory.
- Match existing code style and architectural patterns.
- Tutorial prose should be written for a global audience with clear, easy to understand language. Avoid idioms.
- Use active voice in tutorial instructions.
- If uncertain, choose the simpler, more concise implementation.