[Docs] Adding Store API Docs #45543

osalpekar · 2020-09-30T00:08:48Z

Stack from ghstack:

[Docs] Adding Store API Docs #45543 [Docs] Adding Store API Docs

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed.

See example render below:

Differential Revision: D24005598

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed. Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

dr-ci · 2020-09-30T00:50:25Z

💊 CI failures summary and remediations

As of commit 8ff4521 (more details on the Dr. CI page):

Commit 8ff4521 was recently pushed. Waiting for builds...

This comment was automatically generated by Dr. CI (expand for details).

Follow this link to opt-out of these comments for your Pull Requests.

Please report bugs/suggestions on the GitHub issue tracker or post in the (internal) Dr. CI Users group.

See how this bot performed.

This comment has been revised 21 times.

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed. Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

Pull Request resolved: #45543 This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. ghstack-source-id: 113195095 Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/)

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed. Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

Pull Request resolved: #45543 This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. ghstack-source-id: 113198095 Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/)

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed. Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

Pull Request resolved: #45543 This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. ghstack-source-id: 113202777 Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/)

codecov · 2020-09-30T09:35:01Z

Codecov Report

Merging #45543 into gh/osalpekar/90/base will decrease coverage by 0.00%.
The diff coverage is n/a.

@@                   Coverage Diff                    @@
##           gh/osalpekar/90/base   #45543      +/-   ##
========================================================
- Coverage                 68.50%   68.49%   -0.01%     
========================================================
  Files                       408      408              
  Lines                     52484    52484              
========================================================
- Hits                      35952    35951       -1     
- Misses                    16532    16533       +1

Impacted Files	Coverage Δ
torch/testing/_internal/expecttest.py	`77.55% <0.00%> (-1.03%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1efdbfa...8ff4521. Read the comment docs.

torch/csrc/distributed/c10d/init.cpp

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed. Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

Pull Request resolved: #45543 This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. ghstack-source-id: 113256371 Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/)

pritamdamania87 · 2020-10-01T01:48:07Z

docs/source/distributed.rst

+Key-Value Stores: :class:`~torch.distributed.TCPStore`,
+:class:`~torch.distributed.FileStore`, and :class:`~torch.distributed.HashStore`.
+
+.. autoclass:: TCPStore


Should we also add Store here? Similar to torch.optim where there is documentation about the base class.

pritamdamania87 · 2020-10-01T01:50:10Z

torch/csrc/distributed/c10d/init.cpp

+add(key: str, amount: int) -> None
+
+The first call to add for a given ``key`` creates a counter associated
+with ``key`` in the store, initialized to ``amount``. Subsequent calls to add
+with the same ``key`` increment the counter by the specified ``amount``.


What is the behavior if the key is already present via set call? We should document that as well.

It seems to throw an exception - will make a note about it in the docs.

pritamdamania87 · 2020-10-01T01:51:33Z

torch/csrc/distributed/c10d/init.cpp

+num_keys() -> int
+
+Returns the number of keys set in the store. Note that this number will typically
+be one greater than the number of keys added by :meth:`~torch.distributed.store.get`


This should be set and not get?

pritamdamania87 · 2020-10-01T01:54:47Z

torch/csrc/distributed/c10d/init.cpp

-  shared_ptr_class_<::c10d::HashStore>(module, "HashStore", store)
+  shared_ptr_class_<::c10d::HashStore>(module, "HashStore", store,
+      R"(
+A thread-safe store implementation based on an underlying hashmap (C++ std::unordered_map).


Don't add implementation details like c++ unordered_map. Also, mention that this store can only be used within the same process and not across processes.

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed. Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

Pull Request resolved: #45543 This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. ghstack-source-id: 113373590 Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/)

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed. Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

Pull Request resolved: #45543 This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. ghstack-source-id: 113380360 Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/)

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed. See example render below: <img width="837" alt="Screen Shot 2020-09-29 at 11 42 33 PM" src="https://user-images.githubusercontent.com/14008860/94864458-dc6b8380-03f0-11eb-9776-81a45f93f888.png"> Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

pritamdamania87 · 2020-10-02T00:08:52Z

torch/csrc/distributed/c10d/init.cpp

-          module, "Store")
+          module, "Store",
+          R"(
+Base class for the 3 store implementations: (:class:`~torch.distributed.TCPStore`,


Probably just mention this is the base class for all store implementations. There could be other user implementations on top of this apart from these 3.

This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing altogether even though we exposed a Python API for our distributed key-value store. This Store API could be useful for users looking for a quick way to share information across workers when using PyTorch distributed. See example render below: <img width="837" alt="Screen Shot 2020-09-29 at 11 42 33 PM" src="https://user-images.githubusercontent.com/14008860/94864458-dc6b8380-03f0-11eb-9776-81a45f93f888.png"> Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/) [ghstack-poisoned]

Pull Request resolved: #45543 This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. ghstack-source-id: 113409195 Differential Revision: [D24005598](https://our.internmc.facebook.com/intern/diff/D24005598/)

Summary: Pull Request resolved: pytorch#45543 This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. ghstack-source-id: 113409195 Test Plan: Will verify screenshots by building the docs. Reviewed By: pritamdamania87 Differential Revision: D24005598 fbshipit-source-id: 45c3600e7c3f220710e99a0483a9ce921d75d044

facebook-github-bot · 2020-10-02T20:10:26Z

This pull request has been merged in 3799ba8.

Summary: Pull Request resolved: #45543 This PR adds documentation for the c10d Store to the public docs. Previously these docs were missing although we exposed a lightly-used (but potentially useful) Python API for our distributed key-value store. ghstack-source-id: 113409195 Test Plan: Will verify screenshots by building the docs. Reviewed By: pritamdamania87 Differential Revision: D24005598 fbshipit-source-id: 45c3600e7c3f220710e99a0483a9ce921d75d044

osalpekar requested review from mrshenli, pietern, pritamdamania87, rohan-varma and zhaojuanmao as code owners September 30, 2020 00:08

osalpekar mentioned this pull request Sep 30, 2020

[Docs] Adding Store API Docs #45542

Closed

osalpekar requested a review from jiayisuse September 30, 2020 04:35

rohan-varma reviewed Sep 30, 2020

View reviewed changes

torch/csrc/distributed/c10d/init.cpp Outdated Show resolved Hide resolved

pritamdamania87 reviewed Oct 1, 2020

View reviewed changes

osalpekar requested a review from pritamdamania87 October 1, 2020 21:18

pritamdamania87 approved these changes Oct 2, 2020

View reviewed changes

facebook-github-bot closed this in 3799ba8 Oct 2, 2020

This was referenced Oct 2, 2020

[v1.7.0 Patch][Docs] Adding Distributed Store API Docs #45758

Merged

[v1.7.0] Release Tracker #45592

Closed

facebook-github-bot added the merged label Oct 2, 2020

facebook-github-bot deleted the gh/osalpekar/90/head branch October 6, 2020 14:21

mruberry added the Merged label Oct 28, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Docs] Adding Store API Docs #45543

[Docs] Adding Store API Docs #45543

Uh oh!

osalpekar commented Sep 30, 2020 •

edited

Loading

Uh oh!

dr-ci bot commented Sep 30, 2020 •

edited

Loading

Uh oh!

codecov bot commented Sep 30, 2020 •

edited

Loading

Uh oh!

Uh oh!

pritamdamania87 Oct 1, 2020

Uh oh!

pritamdamania87 Oct 1, 2020

Uh oh!

osalpekar Oct 1, 2020

Uh oh!

pritamdamania87 Oct 1, 2020

Uh oh!

pritamdamania87 Oct 1, 2020

Uh oh!

pritamdamania87 Oct 2, 2020

Uh oh!

facebook-github-bot commented Oct 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

[Docs] Adding Store API Docs #45543

[Docs] Adding Store API Docs #45543

Uh oh!

Conversation

osalpekar commented Sep 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dr-ci bot commented Sep 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💊 CI failures summary and remediations

Uh oh!

codecov bot commented Sep 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

pritamdamania87 Oct 1, 2020

Choose a reason for hiding this comment

Uh oh!

pritamdamania87 Oct 1, 2020

Choose a reason for hiding this comment

Uh oh!

osalpekar Oct 1, 2020

Choose a reason for hiding this comment

Uh oh!

pritamdamania87 Oct 1, 2020

Choose a reason for hiding this comment

Uh oh!

pritamdamania87 Oct 1, 2020

Choose a reason for hiding this comment

Uh oh!

pritamdamania87 Oct 2, 2020

Choose a reason for hiding this comment

Uh oh!

facebook-github-bot commented Oct 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

osalpekar commented Sep 30, 2020 •

edited

Loading

dr-ci bot commented Sep 30, 2020 •

edited

Loading

codecov bot commented Sep 30, 2020 •

edited

Loading