mode-economics: add an ASF-scoped LLMAO section

Open
#1,262 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Domain
build-system, documentation

Research direction

Start with docs/mode-economics.md and inspect the generated block and the existing organization-specific pattern under organizations/ASF/. Use #1261 for the LLMAO measurements and verify the section is ASF-only, dated, and outside the general tables. Run check-doc-sync and the token-count hook; done means both pass and the general tables remain unchanged.

Written by the indexing model from the issue text.

Description

documentation kind:policy mode:cross-cutting

Follow-up to #1260 and #1261.

What

Give docs/mode-economics.md an ASF-scoped section carrying the LLMAO measurements from #1261, rather than folding those numbers into the page's main tables.

Why scoped rather than inline

LLMAO is available to ASF committers only. Numbers that most readers of a public page cannot act on do not belong in the tables they read first — they invite the reasonable-but-wrong conclusion that these are costs anyone can obtain.

Magpie already solves this shape elsewhere: the framework is organisation-agnostic and carries organisation-specific material in clearly-marked sections, with organizations/ASF/ as the ASF instance of it. This should follow the same pattern rather than inventing a new one.

The page's own Long-term: the ASF inference endpoint section already anticipates this content:

As pilot adopters accumulate real usage data, this page will be updated with observed ranges rather than theoretical estimates, so the endpoint sizing argument rests on evidence.

So this is filling an existing promise, not adding a new claim.

Shape

  • An ASF-scoped section, marked as such, holding per-skill token and wall-clock figures per LLMAO model.
  • Explicit that access requires an ASF committer PAT, so a reader outside the ASF knows immediately whether this applies to them.
  • Figures labelled with the date and model version measured. These are pilot numbers on a service under active capacity work; an undated figure will be quietly wrong within weeks.
  • The main tables stay vendor-comparable and untouched.

Done when

  • The section exists, is populated from #1261, and is unambiguously marked ASF-only.
  • Nothing in the general tables implies LLMAO numbers apply to a non-ASF reader.
  • check-doc-sync and the token-count hook pass — this page is partly generated, so hand-edits must land outside the generated block.
Dominant language
Python
Stars
96
Forks
92
Avg merge
13h 23m
Merged PRs (30d)
163

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/magpie

All issues in apache/magpie

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.