[dtensor] expose the __create_chunk_list__ in the doc #144100
Conversation
as titled, this PR expose this dunder method as a public API in the doc, so that different checkpoint implementations can leverage this protocol, instead of exposing a separate API [ghstack-poisoned]
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/144100
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 1381e29 with merge base d88a8c4 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
as titled, this PR expose this dunder method as a public API in the doc, so that different checkpoint implementations can leverage this protocol, instead of exposing a separate API cc H-Huang awgu kwen2501 fegin fduwjj wz337 wconstab d4l3k c-p-i-o [ghstack-poisoned]
|
@pytorchbot merge |
Merge startedYour change will be merged once all checks pass (ETA 0-4 Hours). Learn more about merging in the wiki. Questions? Feedback? Please reach out to the PyTorch DevX Team |
as titled, this PR expose this dunder method as a public API in the doc, so that different checkpoint implementations can leverage this protocol, instead of exposing a separate API Pull Request resolved: #144100 Approved by: https://github.com/awgu ghstack dependencies: #144099 (cherry picked from commit eb7a303)
| @@ -606,6 +606,16 @@ def __create_write_items__(self, fqn: str, object: Any): | |||
| raise RuntimeError("Unsupported tensor type!") | |||
|
|
|||
| def __create_chunk_list__(self): | |||
There was a problem hiding this comment.
Hmm, dunder functions usually has some special meaning in Python runtime. What is it decorated like that?
There was a problem hiding this comment.
I am wondering what's the special meaning refers to? iirc some dunder methods do operator overload, while others retrieves object information. This method is mainly retrieves the chunk storage metadata for distributed checkpoint purpose.
Stack from ghstack (oldest at bottom):
as titled, this PR expose this dunder method as a public API in the doc,
so that different checkpoint implementations can leverage this protocol,
instead of exposing a separate API
cc @H-Huang @awgu @kwen2501 @fegin @fduwjj @wz337 @wconstab @d4l3k @c-p-i-o