Skip to content

docs: bring the GI docs in line with the final commands and states (task_061026_21 Part E) - #315

Draft
umermjd11 wants to merge 2 commits into
InfiniteZeroFoundation:developfrom
umermjd11:docs/task-061026-21-gi-docs
Draft

umermjd11 wants to merge 2 commits into
InfiniteZeroFoundation:developfrom
umermjd11:docs/task-061026-21-gi-docs

Conversation

@umermjd11

Copy link
Copy Markdown
Collaborator

Summary

task_061026_21 Part E, PR 4: the GI docs, brought in line with the final commands and states. Spec: Developer/tasks/task_061026_21.md. Tracking: Discussion #231.

Draft, and it merges last. Some pages describe behaviour from PRs that are still open:

  • #314: deploy --model-id defaults and setDinToken
  • #313: per-wallet commit caches (…/commits/<address>/)

I'll mark this ready once both have merged.

Changes, by the spec's table

Doc What changed
workflows/model-workflow.md Foundry artifacts + --model-id; create-task-dir / cache-default-artifacts; create-genesis-model / submit-genesis-model; register-request + DIN-Rep approval (with the modelId() check); update-manifest-request; funding before gi start; auditor key prerequisite; train-lms → submit-lm; seed and test-data states; the three reveal windows; T2 set-score; new §16 (claim, release slots) and §17 (both dispute families)
roles/model-owner.md Deploy options; system get-registry-fee (replacing the nonexistent get-fees); task model-owner … registry commands (replacing the nonexistent model-owner registry …); genesis names; funding; start-reveal for evaluation, T1 and T2; create-testdataset --submit options; set-score; claim; release slots; disputes
roles/auditors.md register-encryption-key, lms-evaluation reveal, the AuditSeedLocked state, claim, dispute-test-data, dual-role rule
roles/clients.md train-lms then submit-lm; claim
roles/aggregators.md lock-seed; claim; reveal-t2 (it has no --batch: there is one T2 batch); dispute / claim-dispute-bond; dual-role rule
getting-started.md aggregator show-t1/t2-batches (it said model-owner aggregation …); auditor key, lock-seed and reveal; submit-lm; the "rewards not the focus" line replaced; a claim step for each role
manifest.md, guides/keystore-migration.md Genesis command name; cache-default-artifacts; update-manifest-request; train-lms --submit → submit-lm
workflows/din-workflow.md The 7 contracts; withdraw → sweep-fees (coordinator and registry); fee values fixed: proprietary registration is 0.00001 ETH, not 0.000001, and open-source requests pay a fee too
setup.md Option B: pip install "git+https://github.com/InfiniteZeroFoundation/DevNet.git@main" builds from the repo root (main has a root pyproject.toml; dist/ holds only the wheel and sdist). Option A: wheel name dincli-0.2.0, the one on main
DINShared.md §2.2 Funding gate on startGI (TC_GIRewardPoolNotFunded); endGI settles rewards; releaseGIRegistrationSlots is state-neutral. The seed and test-data states were already drawn by #287
CLAUDE.md 7 platform contracts; GI summary with funding, seed locks, keys, reveals, claim and release slots

Also fixed while there:

For Umer

  • ROADMAP.md:19: the deploy-blocker sentence ("24,585 B … 9 B over EIP-170") is already gone; the Oct 29 refresh (ROADMAP.md: refresh "What is still open for P3" (several items were fixed in October) #285) rewrote it. Nothing to change here.
  • "DevNet 3.0" vs "DevNet 2.0": the README, ROADMAP and public docs all call the next deploy DevNet 2.0. "DevNet 3.0" survives only in BACK_LOG (e.g. BL-27's priority) and the task specs. Which name is right?
  • Node README: it still says "local Hardhat devnet". Flagged only, per the spec.

After merge

Follow up on the wiki pages that still say "no dincli command yet": rewards claim/withdraw, release slots, auditor encryption key and disputes all have commands now.

Checks

python3 .github/scripts/check_doc_links.py Documentation   → all inline relative links resolve
python3 .github/scripts/check_doc_links.py Developer       → all inline relative links resolve

Every command and option in these pages was checked against the CLI's command tree on this branch.

🤖 Generated with Claude Code

umermjd11 and others added 2 commits November 5, 2026 21:34
…ask_061026_21 Part E)

Public docs (model-workflow, roles/*, getting-started, manifest,
keystore-migration, din-workflow, setup, fashion-mnist guide):
- deploy from foundry/out with --model-id (and its defaults) and setDinToken;
- create-genesis-model / submit-genesis-model; task directory is
  tasks/<network>/<coordinator_address> (no task_ prefix, as get_task_dir);
- registration and manifest updates as requests the DIN-Representative
  approves (`task model-owner register-request`, `update-manifest-request`,
  `dinrep registry approve-*`), with the fees and `system get-registry-fee`;
- reward-pool funding before `gi start`; auditor encryption keys; the
  dual-role rule;
- train-lms then submit-lm;
- the seed-lock and test-data states and the three reveal windows;
  T2 set-score before slashing;
- reward claim/withdraw, gi release-slots, and both dispute families;
- din-workflow: the seven platform contracts, sweep-fees instead of
  withdraw, and the registry fee values;
- setup: Option B installs from the repo root on main; the wheel is 0.2.0.

Technical: DINShared.md §2.2 shows the funding gate on startGI and that
endGI settles rewards; DINTaskAuditor.md §13 No. 9 notes the per-wallet
commit caches. CLAUDE.md: seven platform contracts and the full GI summary.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Resolve conflicts with PR No. 305 in three docs:
- roles/model-owner.md: keep this branch's deploy section, add PR No.
  305's din_info prerequisites (stake, token, registry), the
  taskProtocolVersion generation check, and the legacy-artifact note.
- workflows/model-workflow.md: keep the optional [--model-id] command
  blocks; develop's new intro paragraph merged cleanly above them.
- DINTaskAuditor.md section 13: take develop's No. 8 (dincli now supports
  the four-argument constructor), keep this branch's No. 9 with the
  per-wallet commit caches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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