feat(agents): add CLAUDE.md files to help claude code#1083
Conversation
Some agents look for AGENTS.md, but claude code looks for CLAUDE.md and ignores AGENTS.md unless mentioned or imported. This change allows claude to research the information faster.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
There was a problem hiding this comment.
Pull request overview
Adds CLAUDE.md entrypoints so Claude Code auto-loads existing AGENTS.md guides across key Optimum Neuron subdirectories, and documents the convention for future model additions.
Changes:
- Add minimal
CLAUDE.mdfiles (importing@AGENTS.md) in vLLM, inference, and several model subdirectories. - Update
optimum/neuron/models/inference/AGENTS.mdwith a “New Model Checklist” documenting theCLAUDE.mdconvention. - Update root
AGENTS.mdwith “Context Loading” guidance.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
optimum/neuron/vllm/CLAUDE.md |
Adds Claude entrypoint to load optimum/neuron/vllm/AGENTS.md. |
optimum/neuron/models/inference/CLAUDE.md |
Adds Claude entrypoint to load optimum/neuron/models/inference/AGENTS.md. |
optimum/neuron/models/inference/gemma3/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/granite/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/llama/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/llama4/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/mixtral/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/phi3/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/qwen2/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/qwen3/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/qwen3_moe/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/smollm3/CLAUDE.md |
Adds Claude entrypoint to load model-specific AGENTS.md. |
optimum/neuron/models/inference/AGENTS.md |
Documents adding CLAUDE.md when creating new model directories. |
AGENTS.md |
Adds context-loading section (but currently contains a bad reference and confusing wording—see comments). |
| - `optimum/neuron/models/inference/backend/modules/attention/AGENTS.md` — attention or NKI kernel work | ||
| - `optimum/neuron/models/inference/<model>/AGENTS.md` — model-specific work (gemma3, llama, qwen3, etc.) | ||
| - `optimum/neuron/vllm/AGENTS.md` — vLLM integration work |
There was a problem hiding this comment.
optimum/neuron/models/inference/backend/modules/attention/AGENTS.md is referenced here, but that file does not exist in the repository (and the attention/ directory currently contains only Python sources). Please either add the referenced guide file or update/remove this bullet to point at the correct existing documentation path.
| - `optimum/neuron/models/inference/backend/modules/attention/AGENTS.md` — attention or NKI kernel work | |
| - `optimum/neuron/models/inference/<model>/AGENTS.md` — model-specific work (gemma3, llama, qwen3, etc.) | |
| - `optimum/neuron/vllm/AGENTS.md` — vLLM integration work | |
| - `optimum/neuron/vllm/AGENTS.md` — vLLM integration work | |
| - `tools/cache/AGENTS.md` — cache tooling and shared cache infrastructure |
Some agents look for AGENTS.md, but claude code looks for CLAUDE.md and ignores AGENTS.md unless mentioned or imported. This change allows claude to research the information faster.