Skip to content

docs: clarify train_rows vs full-shard streaming (recipe 1.2) - #5

Merged
echobt merged 1 commit into
mainfrom
docs/recipe-1.2-train-rows-clarity
Aug 7, 2026
Merged

docs: clarify train_rows vs full-shard streaming (recipe 1.2)#5
echobt merged 1 commit into
mainfrom
docs/recipe-1.2-train-rows-clarity

Conversation

@echobt

@echobt echobt commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document that production train_rows: 2048 is the baseline cut (~2M GPT-2 tokens), not a hard ceiling for competitive trainers.
  • Note that site “2.6B tokens” figures were observed leader telemetry, not a recipe quota.
  • Warn that open 1.4.0 / v3 docs PRs describe unreleased control-plane work — prod is recipe 1.2.0.

Test plan

  • Skim getting-started against live GET https://chain.joinbase.ai/challenge/prism/v1/recipe
  • Confirm no control-plane source leaked

Summary by CodeRabbit

  • Documentation
    • Clarified default training and validation row settings versus competitive dataset usage.
    • Explained that training may process the full pinned dataset until time or step limits are reached.
    • Added guidance on variable token counts and intentionally limited baseline performance.
    • Expanded recipe pin details and identified version 1.2.0 as the current production release.

Production advertises train_rows=2048 for the baseline cut; competitive
trainers may stream the pinned shard under the 6h/20k-step caps. Note
that open 1.4.0/v3 docs PRs are not what prod executes today.
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The getting-started guide now explains dataset row budgets, competitive streaming limits, baseline performance, recipe metadata, and production release status.

Changes

Dataset Budget Documentation

Layer / File(s) Summary
Budget and recipe guidance
docs/getting-started.md
Documents train_rows and val_rows, competitive execution caps, variable token counts, baseline performance, recipe metadata, and recipe release status.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main documentation change: clarifying the distinction between train_rows and full-shard streaming for recipe 1.2.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/recipe-1.2-train-rows-clarity

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/getting-started.md`:
- Around line 93-96: Update the production-status wording in the surrounding
recipe-version documentation to replace “Production today” with an explicit
verification date or clearly identify recipe 1.2.0 as the last verified
production value, while preserving the existing live-endpoint guidance.
- Around line 81-83: Update the token-count wording in the getting-started
documentation to use precise notation for an observed quantity, replacing the
mixed approximate/asymptotic expression “~O(10⁹)” with a clear approximate count
or range. Keep the surrounding explanation about loop- and GPU-dependent counts
unchanged.
- Around line 74-75: Update the recipe endpoint references in
getting-started.md, including the “Always trust live...” guidance and the
documented train_rows, val_rows, pin_hex, caps, and 1.2.0 values, to use the
live chain.joinbase.ai gateway with the /challenge/prism/v1/recipe path instead
of /v1/recipe.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1e0b25c3-1767-43b7-8c32-6e478a617091

📥 Commits

Reviewing files that changed from the base of the PR and between 794e258 and 42a3e7e.

📒 Files selected for processing (1)
  • docs/getting-started.md

Comment thread docs/getting-started.md
Comment on lines +74 to +75
| `train_rows` (from `GET /v1/recipe`) | **2048** — baseline / default cut in `ctx` |
| `val_rows` | **256** — frozen val scored by the harness |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

curl --fail --silent --show-error \
  https://chain.joinbase.ai/v1/recipe |
  jq '{version, recipe_version, train_rows, val_rows, caps, pin_hex}'

Repository: BaseIntelligence/prism

Length of output: 211


🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

echo "Changed docs context:"
sed -n '60,105p' docs/getting-started.md

echo
echo "Locate recipe references:"
rg -n 'v1/recipe|GET /v1/recipe|recipe_version|pin_hex|val_rows|train_rows|Production today' docs README.md examples/baseline/training.py 2>/dev/null || true

Repository: BaseIntelligence/prism

Length of output: 3272


🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

echo "$1=$1"
echo "API docs candidates:"
cat -n docs/api.md | sed -n '1,80p'

Repository: BaseIntelligence/prism

Length of output: 195


🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

echo "docs/api.md route references:"
cat -n docs/api.md | sed -n '1,80p'

echo
echo "All route references in docs and README:"
rg -n 'chain\.joinbase\.ai|/v1/recipe|/recipe/baseline|v1/recipe|recipe version|val_rows|pin_hex' docs README.md 2>/dev/null || true

Repository: BaseIntelligence/prism

Length of output: 4170


Update getting-started.md to document /challenge/prism/v1/recipe.

Docs elsewhere record chain.joinbase.ai as the prod gateway plus the /challenge/prism/... prefix, but these lines and the Always trust live... guidance point to GET /v1/recipe, which is the 404 route. Keep the live URL/path accurate alongside the documented train_rows, val_rows, pin_hex, caps, and 1.2.0 values.

Also applies to: 92-97

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/getting-started.md` around lines 74 - 75, Update the recipe endpoint
references in getting-started.md, including the “Always trust live...” guidance
and the documented train_rows, val_rows, pin_hex, caps, and 1.2.0 values, to use
the live chain.joinbase.ai gateway with the /challenge/prism/v1/recipe path
instead of /v1/recipe.

Comment thread docs/getting-started.md
Comment on lines +81 to +83
fires. Token count then depends on your loop and the GPU — a long Lium run can
reach ~O(10⁹) tokens. Marketing charts that once said “2.6B tokens · single
pass” were showing a leader’s **observed** telemetry, not a fixed recipe

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use precise notation for the observed token count.

~O(10⁹) mixes approximation and asymptotic notation. Use a clear expression for an observed quantity.

Proposed wording
-a long Lium run can reach ~O(10⁹) tokens.
+a long Lium run can process on the order of 10⁹ tokens.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
fires. Token count then depends on your loop and the GPU — a long Lium run can
reach ~O(10⁹) tokens. Marketing charts that once said “2.6B tokens · single
pass” were showing a leader’s **observed** telemetry, not a fixed recipe
fires. Token count then depends on your loop and the GPU — a long Lium run can
process on the order of 10⁹ tokens. Marketing charts that once said “2.6B tokens · single
pass” were showing a leader’s **observed** telemetry, not a fixed recipe
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/getting-started.md` around lines 81 - 83, Update the token-count wording
in the getting-started documentation to use precise notation for an observed
quantity, replacing the mixed approximate/asymptotic expression “~O(10⁹)” with a
clear approximate count or range. Keep the surrounding explanation about loop-
and GPU-dependent counts unchanged.

Comment thread docs/getting-started.md
Comment on lines +93 to +96
`train_rows` / `val_rows`, recipe version, `pin_hex`). Production today is
recipe **1.2.0** — open docs PRs that advertise 1.3+/1.4.0/v3 scoring describe
**unreleased** control-plane work (`prism-better`), not what
`https://chain.joinbase.ai` executes. `GET /v1/recipe/baseline` returns the

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Replace the relative production date.

Production today will become stale and can contradict the live-endpoint guidance. State the exact verification date, such as As of August 7, 2026, or identify this version as the last verified value.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/getting-started.md` around lines 93 - 96, Update the production-status
wording in the surrounding recipe-version documentation to replace “Production
today” with an explicit verification date or clearly identify recipe 1.2.0 as
the last verified production value, while preserving the existing live-endpoint
guidance.

@echobt
echobt merged commit 8abba00 into main Aug 7, 2026
7 of 13 checks passed
@echobt
echobt deleted the docs/recipe-1.2-train-rows-clarity branch August 7, 2026 14:16
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