Repository navigation
docs: regenerate the algorithm configuration reference - #57
Merged
Merged
Conversation
The generated reference was stale: the executor, num_workers, torch_num_threads and rng_mode fields introduced with the parallel execution layer were missing from all 20 per-algorithm tables. Regenerated with docs/gen_config_reference.py.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #57 +/- ##
==========================================
+ Coverage 82.32% 82.41% +0.08%
==========================================
Files 55 55
Lines 5640 5640
==========================================
+ Hits 4643 4648 +5
+ Misses 997 992 -5 🚀 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
The generated configuration reference (
docs/source/api/config_reference.rst) was stale: theexecutor,num_workers,torch_num_threads(server) andrng_mode(client) fields introduced with the parallel execution layer were missing from all 20 per-algorithm tables.Regenerated with
docs/gen_config_reference.py(build-time artifact synced back into the repo, as before).Validation
python docs/gen_config_reference.pythenmake html-en: zero warnings, no further diff (generator is idempotent against the current configs).