Skip to content

Update README with verified benchmarks, MCP docs, and FAQ - #5

Merged
RudrenduPaul merged 1 commit into
mainfrom
docs/readme-update-2026-08-03
Aug 4, 2026
Merged

RudrenduPaul merged 1 commit into
mainfrom
docs/readme-update-2026-08-03

Conversation

@RudrenduPaul

Copy link
Copy Markdown
Owner

Summary

  • Rewrites the README with a fact-checked comparison table against TransformerLens, nnsight, SAELens, circuit-tracer, and Neuronpedia (stars/release/activity pulled live on 2026-08-03)
  • Adds real command output for trace (table and --json), a full CLI reference table, MCP server setup instructions for Claude Code and Claude Desktop
  • Adds a dedicated FAQ section and a Known Limitations section covering the circuit approximation, missing resource caps, and the upstream HookedTransformer.from_pretrained deprecation

Test plan

  • Verified no em dashes, no placeholder text, no fundraising language
  • Confirmed docs/demo.gif referenced in the hero image already exists in the repo
  • GitHub description and topics already match target metadata, no gh repo edit needed

Rewrites the README with a fact-checked comparison table against
TransformerLens, nnsight, SAELens, circuit-tracer, and Neuronpedia,
real command output, MCP server setup instructions, and a dedicated
FAQ and known-limitations section.
@RudrenduPaul
RudrenduPaul merged commit 8e3ab7d into main Aug 4, 2026
4 checks passed
@RudrenduPaul
RudrenduPaul deleted the docs/readme-update-2026-08-03 branch August 4, 2026 06:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant