docs: explain DIN model fit and partner participation - #189
Santiagocetran wants to merge 3 commits into
Conversation
|
Thank you, @Santiagocetran - excellent, I've read it through and I am happy on the vision, public contact, and policy language. Clear from my side. |
|
Reviewed against Claimed: Verified, holds: I re-ran both in the worktree. The script printed Claimed (technical-accuracy review requested): fees, slashing, rewards, staking, and scope language match DevNet 2.0 on Verified, all hold against
Policy row, for @abrahamnash: the fair-launch row ("no ICO, pre-sale, or VC allocation in the current plan") matches BL-18 in Non-blocking nits:
Not independently re-verified: the claims about framework portability (TensorFlow, scikit-learn, JAX) and LoRA-style adapter fine-tuning. The PR correctly labels them as untested possibilities, and nothing in the repo exercises them. Every checkable technical claim held up against the current contracts and docs. From a technical-accuracy standpoint this is mergeable once it leaves draft, with the three nits as optional polish. The remaining gate is Abraham's sign-off on the vision, contact, and policy wording. |
Files changed (4) — as of
|
| Field | Value |
|---|---|
| Change | New |
| Lines | +56/-0 |
| Diff (what exactly is in this PR) | New public guide for issue No. 157: a fit table by kind of idea (similar-data, tabular/language, LLM fine-tune, async), what a model owner must bring (task, client training, test data and scoring, aggregation, people and resources), the GI round in 5 steps, a pre-start checklist (fit, resources, data and privacy, people, costs), and how to try it. |
| Functionality — how & why | How: Pure docs. It separates the tested MNIST/Model_0 path from the custom-service path (services.md, manifest.md) and from untested ideas. The protocol-level claims match foundry/src/ (registry approval gate approveModel/approveManifestUpdate, fee tiers) and the reference services (DP off by default, clients.md:194). Why: Issue No. 157. A newcomer or partner couldn't tell from services.md and client-onboarding.md which parts of "any framework / any model" are tested and which are aspirational. |
Diff vs current develop HEAD |
None (new file) |
| Recommended merge proposal | Merge as-is. Optional nits No. 1 (H1 vs. link-text wording) and No. 3 (mention the slasher-authorization gate before registry approval) from the verification comment. |
| Actual merge proposal | Soon |
| Pending proposal | Nits No. 1 and No. 3 (optional) |
| Local merge conflict | No |
| GitHub merge conflict | No |
Documentation/public/partner-introduction.md
| Field | Value |
|---|---|
| Change | New |
| Lines | +55/-0 |
| Diff (what exactly is in this PR) | New partner-facing introduction for issue No. 158: what DIN is, a roles table (client/auditor/aggregator/model owner/developer), team needs (time, hardware, setup, tokens and costs), 4 steps from interest to a first round, a settled-vs-undecided table (fees, validator rewards, slashing, future token distribution, testnet resets), and a contact section (README email plus Discussion No. 102). |
| Functionality — how & why | How: Pure docs. Every "in the code" row matches the contracts: fee tiers and fee router in DINModelRegistry; slashing via slashAuditors/slashAggregators with fraction params still open in issue No. 155; DinEmission and DinFairLaunchDistributor present but unparameterized; clients stake-free in submitLocalModel. The fair-launch row follows BL-18. Why: Issue No. 158. Outreach needed one consistent, reviewed explanation of participation that makes no reward, allocation, or continuity promises. |
Diff vs current develop HEAD |
None (new file) |
| Recommended merge proposal | Merge after Abraham's sign-off on the vision, contact, and policy rows (the author asked for this; the PR is still draft). Optional nit No. 2: say registration fees are paid in test ETH, not DIN. |
| Actual merge proposal | Soon |
| Pending proposal | Abraham review of the fair-launch/ICO and testnet-reset wording; nit No. 2 (optional) |
| Local merge conflict | No |
| GitHub merge conflict | No |
Documentation/README.md and Documentation/public/getting-started.md
| Field | Value |
|---|---|
| Change | Modified (both) |
| Lines | +2/-0 each |
| Diff (what exactly is in this PR) | README: two new rows in the public-docs index table for the two new pages. getting-started.md: one pointer line under the welcome paragraph, sending readers with a different model or dataset to the new fit guide. |
| Functionality — how & why | How: Link-only additions. check_doc_links.py resolves all 181 relative links, including these. Why: Makes the new pages discoverable from the docs index and from the Model_0 entry point, where readers with their own model would otherwise stop. |
Diff vs current develop HEAD |
None. Neither file changed on develop since the merge-base. |
| Recommended merge proposal | Merge as-is. Nit No. 1 would change the link text here if the H1 wording is chosen instead. |
| Actual merge proposal | Soon |
| Pending proposal | Nit No. 1 (optional) |
| Local merge conflict | No |
| GitHub merge conflict | No |
Verification
Docs-only, so there is no forge or pytest signal to add. python3 .github/scripts/check_doc_links.py Documentation reports 181 links, all resolving (exit 0), and git diff --check passes. Each technical claim is traced to foundry/src/ line references in the verification comment above.
Local vs. GitHub agree: yes. Both report a clean merge with no conflicts.
Summary
Review focus
@abrahamnash: Please review the vision, public contact, and policy language before this is shared externally, especially the fair-launch and testnet-reset rows.
@umeradl: Please check technical accuracy, current DevNet 2.0 scope, hardware baseline, fees, slashing, and rewards language.
The partner guide deliberately does not promise rewards, future allocation, or continuity of testnet state. Issue #155 still tracks testnet tokenomics settings; issue #75 still tracks fair-launch eligibility. The contact email is the one already listed in the repository README and should be confirmed as the partner intake route.
Validation
python3 .github/scripts/check_doc_links.py Documentation— 181 relative links resolve.git diff --checkpasses.Related: #157, #158