[Doc] Add CLAUDE.md project reference for AI assistants#225
Merged
Conversation
YWHyuk
commented
May 21, 2026
| - **Adding a new op (Inductor lowering):** `PyTorchSimFrontend/mlir/mlir_ops.py`, `mlir_lowering.py`, plus a new `mlir_<op>_template.py` if it needs its own MLIR template. Decomposition rules: `mlir_decomposition.py`. Scheduling: `mlir_scheduling.py`. Autotune: `mlir_autotune.py`. | ||
| - **Adding a PyTorch device op:** `PyTorchSimDevice/csrc/aten/native/*` (Minimal/Extra split mirrors `torch_openreg`). | ||
| - **TOGSim hardware model changes:** `TOGSim/src/{Core,Dram,Interconnect,L2Cache,Tile,TileGraph}.cc` + matching `include/*.h`. | ||
| - **TOG generation (ONNX→TOG):** `AsmParser/tog_generator.py`. |
Collaborator
Author
There was a problem hiding this comment.
It not true. raw_tog.py is converted to onnx format (which is a TOG format)
YWHyuk
commented
May 21, 2026
|
|
||
| ## Gotchas / things I've already learned | ||
|
|
||
| - The repo expects `python` to be a Python 3.10+ binary with `torch==2.2.0`. The frontend extends PyTorch 2 Inductor; newer PyTorch is not yet supported (see "Future Works" in README). |
Collaborator
Author
There was a problem hiding this comment.
Not 2.2.0 2.8.0 check this out
YWHyuk
added a commit
that referenced
this pull request
May 21, 2026
- TOG generation: clarify that tog_generator.py builds the raw graph and onnx_utility serializes it to ONNX (which IS the on-disk TOG format), rather than the incorrect "ONNX -> TOG" direction. - PyTorch pin: 2.8.0, not 2.2.0; drop the stale "newer not supported" line. - Remove the Paper/cite section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Drop-in reference for Claude Code (and similar AI tools) covering the three-simulator pipeline (Gem5 -> Spike -> TOGSim), directory map, test entry points, key env vars and YAML knobs, multi-tenant API contract, build steps, and known gotchas. Complements README.md with a denser cheat-sheet aimed at code navigation. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
YWHyuk
force-pushed
the
docs/claude-md-reference
branch
from
aad8ed3 to
9c4ed17
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CLAUDE.mdaimed at AI coding assistants (Claude Code, Cursor, etc.) working in this repoREADME.mdwith a denser navigation cheat-sheet rather than user-facing docs