docs: add Randomness page explaining seed semantics#737
Open
leotrs wants to merge 1 commit into
Open
Conversation
Documents the three accepted seed types (None, int, Generator), the four reproducibility cases that surprise users (esp. that seed=42 vs seed=default_rng(42) produce different output), and the why-use-a- Generator pattern for multi-step pipelines. Per Max's suggestion on PR #724. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #737 +/- ##
==========================================
+ Coverage 93.65% 94.61% +0.95%
==========================================
Files 66 66
Lines 5168 5271 +103
==========================================
+ Hits 4840 4987 +147
+ Misses 328 284 -44 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Summary
Adds a new `randomness.rst` page to the User Guides documenting how XGI's `seed` arguments behave. Per Max's suggestion on PR #724.
The page covers:
Also wires it into the User Guides toctree and adds a card for discoverability.
Test plan