README: make clear this is a fork, attribute upstream content explicitly - #15
Merged
Conversation
Every claim, benchmark number, vision statement, and roadmap item in the previous README was written in upstream's voice with no indication that JustVugg/colibri and dkurukula/colibri are different things -- a reader landing on this fork's README had no way to tell upstream's 6x RTX 5090 numbers from this fork's actual R720 hardware, or upstream's stated roadmap from commitments this fork is making. Added a "This fork" section up front: what hardware this fork actually runs on (Dell R720, dual Ivy Bridge Xeon E5-2660 v2, no AVX2, 125GB RAM, one GTX 1050 Ti), and a real, accurate list of the 14 merged fork-specific PRs, built from the actual GitHub PR history rather than summarized from memory. Every remaining section that represents upstream's own voice (vision, benchmarks, roadmap, community ask, naming rationale, acknowledgements) is now explicitly attributed as upstream's, mostly converted to blockquotes with a preceding attribution line; issue links point out they're upstream's tracker. Added this fork's own real, measured numbers (~27% decode tok/s improvement from tonight's CPU/GPU split work, real production config) alongside upstream's for honest comparison -- this fork's hardware lands close to upstream's own stated "25GB dev box" floor, nowhere near their flagship benchmarks, and the README now says so plainly instead of leaving upstream's numbers looking like this fork's own. Also fixed a stale file reference (c/glm.c -> c/colibri.c, matching upstream's own CHANGELOG JustVugg#391 rename) noticed while editing. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UJmXXDm2AWJTMqjV4y25bT
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
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.
Problem
Every claim, benchmark number, vision statement, and roadmap item in the README was written in upstream's (JustVugg/colibri) voice with no indication that JustVugg/colibri and dkurukula/colibri are different things. A reader landing on this fork's README had no way to tell upstream's 6x RTX 5090 numbers from this fork's actual hardware, or upstream's stated roadmap from a commitment this fork is making. Requested directly: make it clear what's this fork's and what's upstream's, and attribute every instance of upstream-maintainer voice explicitly.
Fix
Added a "This fork" section up front, right after the badges, stating plainly:
dkurukula/colibri, a persistent fork ofJustVugg/colibri, not a snapshot or one-off patch;/proc/cpuinfoandnvidia-smion the actual box, not guessed;gh/API query against dkurukula/colibri), not summarized from memory: the AVX-only Sandy/Ivy Bridge kernel paths (without which this fork's CPU doesn't even build the fast path),CUDA_MISS_GPU, its async double-buffered dispatch pipeline, theCOLI_MISS_CPU_EVERYCPU/GPU concurrent split (inspired by FreeToken, arXiv:2608.16157, re-derived against this hardware rather than copied), the ported ATSInfer live re-pin gate (arXiv:2607.10183 Algorithm 3), the decode heartbeat, stall watchdog, systemd deploy templates, live-usage watcher, and the podman quick-start path.Every remaining section that is upstream's own voice β the vision statement, the "What it achieves" benchmark numbers, the roadmap, the community/sponsorship ask, the naming rationale, the acknowledgements β is now explicitly marked with an attribution line ("Upstream's own stated vision:", etc.) and mostly converted to a blockquote, so it reads as a quote rather than this fork's own claim. Upstream issue links (
JustVugg/colibri/issues/NNN) are labeled "(upstream issue)" so they don't read as this repo's own tracker. The website/release badges at the top are relabeled "upstream" explicitly, and a new badge/link to the upstream repo itself was added.Added this fork's own real, measured numbers for honest comparison: decode at 0.123 tok/s with
CUDA_MISS_GPUalone, 0.156 tok/s with this fork's CPU/GPU split also enabled (~27% improvement, measured on the live production deployment,cap=3, single GTX 1050 Ti β see thecuda-miss-cpu-gpu-splitPR history for full methodology). Stated plainly that this lands close to upstream's own documented "25GB dev box" floor (0.05-0.1 tok/s), nowhere near their flagship 6-GPU numbers β this fork's hardware is old and constrained by upstream's standards, and the README now says so instead of leaving upstream's benchmark table looking like this fork's own results."Get started" clone URLs now point at this fork (
dkurukula/colibri) rather than upstream, since that's what running this specific README implies; the prebuilt-release path is kept but explicitly marked as upstream's own releases (this fork doesn't publish separate binaries).Also fixed while in there
c/glm.cβc/colibri.cin two places (the single-file engine reference and the repo-layout tree) β stale even relative to upstream itself, which renamed the file per their own CHANGELOG JustVugg#391; the README just never caught up. Small, adjacent, factual correction, not scope creep.Testing
Docs-only change. Verified: code fences balanced, all 13 section headers intact, no broken markdown structure. No build/engine files touched.
Generated by Claude Code