docs(book): add Node Operator Guide and DisTrO explainer - #653
Closed
salch-cred wants to merge 1 commit into
Closed
Conversation
Author
|
Closing as a duplicate - superseded by two focused PRs: DisTrO explainer in #651 and Node Operator Guide in #652. This PR's head branch now points at the operator-guide-only commit (identical to #652), so its title no longer matches its contents. The two focused PRs merge independently and avoid SUMMARY.md conflicts. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds two new chapters to the
psyche-book:Node Operator Guide (
psyche-book/src/explain/operator-guide.md) — a field manual for people operating Psyche training nodes long-term:DisTrO (
psyche-book/src/explain/distro.md) — an explainer for the DisTrO optimizer, grounded in the actual implementation (shared/modeling/src/distro.rs):Distro::generate(decode peers' updates -> apply -> gradient -> residual update -> DCT encode -> top-k -> 1-bit sign quantization -> P2P broadcast), with a mermaid diagramcompression_decay,compression_chunk,compression_topk,quantize_1bit) and how they interact withmax_round_train_timeAlso wires both into
SUMMARY.md(DisTrO under "Psyche in depth", Operator Guide as its own top-level section after it).Why
shared/modeling/src/distro.rs, its wire format, or its config knobs. The explainer links the optimizer to the run config and the general workflow chapter.All content is grounded in the repo itself: the epoch state machine and witness/quorum terminology come from
general-workflow.md/glossary.md, the reward rules fromrewards.md, the delegation flow fromquickstart-compute-provider.md/join-run.md, and the DisTrO mechanics from theDistro/TransformDCT/CompressDCTimplementations inshared/modeling/src/distro.rs. Internal links verified to resolve against the book tree.Happy to restructure (e.g. move the operator guide under
enduser/, or change section ordering) if maintainers prefer a different placement.