Skip to content

Trim repo for taste: drop committed checkpoint, stale roadmap, market-y README - #13

Merged
peterajhgraham merged 2 commits into
mainfrom
claude/sleepy-einstein-wcyz2m
Jun 22, 2026
Merged

peterajhgraham merged 2 commits into
mainfrom
claude/sleepy-einstein-wcyz2m

Conversation

@peterajhgraham

Copy link
Copy Markdown
Owner

Cleanup pass focused on how the repo reads to a first-time reviewer. No code or behavior changes.

Changes

Untrack the committed checkpoint. cortex_s_final.pt (95 MB) was tracked in git, bloating .git to ~89 MB and violating CLAUDE.md ("Do not commit large files. Use git-lfs or W&B artifacts for checkpoints"). Removed from the index and added *.pt/*.pth/*.ckpt/*.safetensors to .gitignore.

Note: this untracks the file going forward but does not rewrite history — the blob still exists in past commits. If you want a smaller clone, a git filter-repo pass + force-push would be needed (didn't do this since it rewrites merged main).

Delete docs/CORTEX_ENGINE_ROADMAP.md. It was stale and contradicted the README's careful honesty — still carrying the old "5x throughput / sub-30ms p99 on a single A10" hero framing that the README explicitly walks back. A reviewer opening it would catch the inconsistency. Superseded by ROADMAP.md.

Tighten the README.

  • Removed the duplicate ASCII architecture diagram (kept the one under ## Architecture).
  • Broke up the 120-word single-sentence hero paragraph.
  • Merged the repeated hardware caveats (p99 note + "Honest Results" callout + scattered "pending CUDA") into one plainly-stated caveat.
  • Cut the "Why This Matters Beyond BCI" section (read as a cover letter).
  • Dropped the for-the-badge shields; kept the flat CI badge.

The underlying engineering is solid — this is purely packaging so the substance reads with the research taste it deserves.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NdYqf4yyqUrhQAsZze24Lw


Generated by Claude Code

claude added 2 commits June 22, 2026 15:18
- Untrack 95MB cortex_s_final.pt and gitignore weight files (*.pt/*.pth/*.ckpt/*.safetensors); checkpoints belong in W&B artifacts, not git
- Delete docs/CORTEX_ENGINE_ROADMAP.md (stale, contradicted README's honest hardware caveats with old 5x/sub-30ms hero claims)
- README: collapse duplicate ASCII diagram, tighten hero paragraph, merge redundant hardware caveats into one, cut the 'Why This Matters Beyond BCI' section

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NdYqf4yyqUrhQAsZze24Lw
- Rewrite README in a minimal, results-forward style (364 -> ~105 lines):
  drop the Phase 1-5 status-report section, the Tech Stack table, the ten
  expanded command blocks, and the per-dashboard prose. Lead with results,
  one architecture diagram, a make-target quickstart, and links out to
  BENCHMARKS.md / docs/writeup.md for depth.
- Fix bench-kernels: it pointed at a nonexistent cortex.benchmarks.kernels
  module; now runs the actual cortex.kernels.bench_* modules.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NdYqf4yyqUrhQAsZze24Lw
@peterajhgraham
peterajhgraham marked this pull request as ready for review June 22, 2026 15:31
@peterajhgraham
peterajhgraham merged commit 7b8f4c3 into main Jun 22, 2026
4 checks passed
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.

2 participants