Skip to content

docs: miner getting-started rework — backtesting step, 3-competition FAQs#300

Merged
Thykof merged 1 commit into
mainfrom
docs/miner-getting-started-backtester
Jul 13, 2026
Merged

docs: miner getting-started rework — backtesting step, 3-competition FAQs#300
Thykof merged 1 commit into
mainfrom
docs/miner-getting-started-backtester

Conversation

@Thykof

@Thykof Thykof commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

What

Rework of the miner getting-started journey: the docs now advertise the open-source synth-lib backtester and reflect the 3-competition model throughout.

README

  • Quick Start: after the run.py format check, a short section advertises the backtester (replays real validator scoring — CRPS, smoothed scores, rank, estimated earnings) with a minimal 3-command example.
  • New §2.1.4 Backtesting stub alongside Tutorial / Reference / Automated Deployment.

docs/miner_tutorial.md

  • New §2.3 Backtest your model (former §2.3–2.9 renumbered to §2.4–2.10; nothing links the old anchors — swept). Short why/what + one command; deep guide stays in the synth-lib README (single source).
  • §2.1: orientation bullets — the three competitions (linking the README competition table) and the response-format spec (linking the reference FAQ).
  • §2.2: real run.py output (start_time … then CORRECT) + caveat that it only exercises one BTC/24h prompt with 100 paths.
  • §3.3.1: dropped the deadsnakes PPA / apt python3.11 install — uv sync provisions Python.
  • §3.5.1: fixed the miner.config.js vs miner.local.config.js inconsistency (local copy pattern, matching §2.6 and .gitignore).

docs/miner_reference.md

Verification

Ran the exact documented backtest command from a fresh synth-lib clone — completes and writes charts (chart fix on macOS: synthdataco/synth-lib#17). Cross-repo anchors verified. Website counterpart: synthdataco/synth-landing-replit#30.

🤖 Generated with Claude Code

…FAQs

- README Quick Start: after the format check, advertise the synth-lib
  backtester (accuracy benchmark) with a minimal example; new §2.1.4 stub.
- miner_tutorial: new §2.3 'Backtest your model' (former §2.3-2.9 renumbered
  to §2.4-2.10); §2.1 orientation bullets (3 competitions, response-format
  pointer); §2.2 real run.py output + single-prompt caveat; drop the obsolete
  deadsnakes Python install (uv provisions Python); fix the
  miner.local.config.js inconsistency in §3.5.1.
- miner_reference: FAQ #2/#3/#5 generalized to all three competitions
  (per-competition points table); new FAQ #13 pointing at the backtester;
  netuid doc states 50 = mainnet / 247 = testnet.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Thykof Thykof merged commit d6f53ea into main Jul 13, 2026
5 checks passed
@Thykof Thykof deleted the docs/miner-getting-started-backtester branch July 13, 2026 18:15
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