(docs-scout/staleness)[torchx][docs] Fix 7 stale references across components, advanced, and tracker docs#1258
Open
(docs-scout/staleness)[torchx][docs] Fix 7 stale references across components, advanced, and tracker docs#1258
Conversation
…mponents, advanced, and tracker docs Summary: Fix 7 accuracy issues found during docs-scout rotation audit of components/advanced section. **component_best_practices.rst (item 1, HIGH):** - Replace reference to non-existent `torchx.components.base` module (no `__init__.py`) with link to `custom_components` guide for simple single-node components **components/__init__.py (item 2, HIGH):** - Update doctest example from deprecated `specs.named_resources[host]` dict-access to current `specs.resource(h=host)` API **advanced.rst (items 3 + 5, MEDIUM/LOW):** - Add note that `register` migration is pending for components (other plugin types already migrated) - Fix seealso reference from non-existent `find()` to `registry()` (actual export) **fb/distributed.rst (item 4, MEDIUM):** - Fix example from `-s mast` to `-s hpc` (preferred scheduler per quickstart.rst) **fb/tracker_usage.rst (item 6, LOW):** - Update "MAST/MSL" to "MSL" (forward-looking, MAST deprecated) **custom_components.rst (item 7, LOW):** - Add note that `register` migration is pending for components in seealso Differential Revision: D96451468
meta-cla
Bot
added
the
CLA Signed
|
@kiukchung has exported this pull request. If you are a Meta employee, you can view the originating Diff in D96451468. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1258 +/- ##
=======================================
Coverage 92.19% 92.19%
=======================================
Files 94 94
Lines 6726 6726
=======================================
Hits 6201 6201
Misses 525 525
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 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
2 participants
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:
Fix 7 accuracy issues found during docs-scout rotation audit of components/advanced section.
component_best_practices.rst (item 1, HIGH):
torchx.components.basemodule (no__init__.py)with link to
custom_componentsguide for simple single-node componentscomponents/init.py (item 2, HIGH):
specs.named_resources[host]dict-accessto current
specs.resource(h=host)APIadvanced.rst (items 3 + 5, MEDIUM/LOW):
registermigration is pending for components (other plugin typesalready migrated)
find()toregistry()(actual export)fb/distributed.rst (item 4, MEDIUM):
-s mastto-s hpc(preferred scheduler per quickstart.rst)fb/tracker_usage.rst (item 6, LOW):
custom_components.rst (item 7, LOW):
registermigration is pending for components in seealsoDifferential Revision: D96451468