Skip to content

docs: README header covers all four model families (main) - #710

Closed
JustVugg wants to merge 1 commit into
mainfrom
docs/readme-header-main
Closed

docs: README header covers all four model families (main)#710
JustVugg wants to merge 1 commit into
mainfrom
docs/readme-header-main

Conversation

@JustVugg

Copy link
Copy Markdown
Owner

Same header change as #709, cherry-picked onto main so the landing page matches what main actually ships.

main already contains all four engines (colibri.c, inkling.c, kimi_k3.c, olmoe.c) and the roster table at line 333 β€” it was only the header that still said "Explore GLM-5.2 (744B-parameter MoE)", contradicting the repo description and hiding three of the four families 300 lines down the page.

What is in this PR

  • scale claim is a range, 744B to 2.8T, instead of one model name
  • the four families announced under the tagline, linking to the roster table that is already on main
  • blockquote reworked: "an inference engine you can run today, and an open research platform", with the product/research tension resolved by a distinction rather than a hedge β€” no SLA on speed, and a hard guarantee on semantics
  • sample banner v1.1.0 β†’ v1.3.0 (v1.3.0 is the current release)
  • all four files: README.md, README.it.md, README.zh-CN.md, README.zh-TW.md

What is deliberately NOT in this PR

dev also has README changes documenting the Vulkan backend (#418) and the OLMoE chat mode. Those describe code that is on dev and not on main, so copying the README files wholesale would have given main a page promising a backend it does not ship. Only the header commit was cherry-picked; the Vulkan documentation travels with the Vulkan code whenever dev next merges.

Every screenshot caption is untouched β€” they describe real measured runs, and inflating them to sound bigger would be falsifying a measurement.

Docs only. No code, no build, no behaviour change.

The header still opened with "Explore GLM-5.2 (744B-parameter MoE)" while the
repo description had already moved to "Run frontier MoE models". Inkling (975B)
and Kimi K3 (2.8T) shipped in v1.3.0 and the roster table listing all four
families sits at line 337 β€” so a reader met "GLM-5.2" at line 16 and only
discovered the other three engines 300 lines later.

Header now states the range rather than one model, and announces the roster up
front with a link down to the table. A range does not go stale the next time
someone ships a larger model; naming a single model does.

The blockquote said "experimental inference engine and research platform" and
then "not a production runtime with an SLA", which reads as a contradiction
next to a usable engine that four model families run on. It is both things at
once, and the reconciliation is a distinction rather than a hedge: no SLA on
speed, a hard guarantee on semantics. That second half was already the last
sentence of the paragraph β€” insufficient fast memory may reduce speed, it must
not quietly redefine the model β€” it just was not where a reader would see it.

Not touched, deliberately: every screenshot caption (744B at 4 tok/s, 19,456
experts, 13,260 characterised experts) describes a real run, and GLM-5.2 stays
the worked example under "the core idea" because it is the model with the most
measured data behind it. Reference model, not only model.

Also fixes the sample banner, which claimed v1.1.0 across all four files.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@JustVugg

Copy link
Copy Markdown
Owner Author

Superseded by #711, which merges all of `dev` into `main` and already contains this exact commit (`2dbfdc1`, "docs: the README is about four model families, not one") along with the four updated README files.

This PR existed to get the header onto `main` on its own, in case the rest of `dev` was not ready to ship. It is, so the cherry-pick is redundant β€” and merging both would apply the same change twice. Closing rather than merging.

The Vulkan documentation that was deliberately held out of this PR travels with the Vulkan code in #711, which is where it belongs.

@JustVugg JustVugg closed this Jul 30, 2026
@JustVugg
JustVugg deleted the docs/readme-header-main branch July 30, 2026 07:23
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