Fix `torch.min` docs by zou3519 · Pull Request #36319 · pytorch/pytorch

zou3519 · 2020-04-09T17:08:45Z

Stack from ghstack:

Fix torch.min docs #36319 Fix torch.min docs

On the way to resolving #35216.
This is a fix for just the master branch but once this goes in,
I'll send a cherry-pick to release/1.5

The problem is that we were not calling format on a string that had
templates (e.g., '{input}', '{dim}'). This change makes it so that we
call format on the entire docstring for torch.min.

Test Plan:

The torch.max docs are OK:
https://pytorch.org/docs/master/torch.html#torch.max and don't need
changing.
torch.min docs, before this change: see second screenshot in API doc for torch.max/min is broken #35216.
after this change:

Differential Revision: D20946702

On the way to resolving #35216. This is a fix for just the master branch but once this goes in, I'll send a cherry-pick to release/1.5 The problem is that we were not calling `format` on a string that had templates (e.g., '{input}', '{dim}'). This change makes it so that we call format on the entire docstring for `torch.min`. Test Plan: - The `torch.max` docs are OK: https://pytorch.org/docs/master/torch.html#torch.max and don't need changing. - `torch.min` docs, before this change: see second screenshot in #35216. - after this change: <Insert link here on github> [ghstack-poisoned]

On the way to resolving #35216. This is a fix for just the master branch but once this goes in, I'll send a cherry-pick to release/1.5 The problem is that we were not calling `format` on a string that had templates (e.g., '{input}', '{dim}'). This change makes it so that we call format on the entire docstring for `torch.min`. Test Plan: - The `torch.max` docs are OK: https://pytorch.org/docs/master/torch.html#torch.max and don't need changing. - `torch.min` docs, before this change: see second screenshot in #35216. - after this change: <Insert link here on github> ghstack-source-id: b3bb4bc Pull Request resolved: #36319

dr-ci · 2020-04-09T17:31:22Z

💊 CircleCI build failures summary and remediations

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

✅ None of the build failures appear to be your fault 💚

1/2 tentatively recognized as flaky ❄️
- Click here to rerun these jobs
1/2 broken upstream at merge base f813e71 since Apr 09
Please rebase on the viable/strict branch (expand for instructions)

If your commit is newer than viable/strict, you can try basing on an older, stable commit:
```
git fetch https://github.com/pytorch/pytorch viable/strict
git rebase --onto FETCH_HEAD $(git merge-base origin/master HEAD)
```
If your commit is older than viable/strict:
```
git fetch https://github.com/pytorch/pytorch viable/strict
git rebase FETCH_HEAD
```
Check out the recency history of this "viable master" tracking branch.

❄️ 1 tentatively flaky failure

1 failure tentatively classified as flaky but have not triggered reruns to confirm:

pytorch_macos_10_13_py3_test (1/1)

Step: "Test" (full log | pattern match details | 🔁 rerun) ❄️

Apr 09 11:46:57 AssertionError: 12 not less than or equal to 1e-05 :

Apr 09 11:46:57 ---------------------------------------------------------------------- 
Apr 09 11:46:57 Traceback (most recent call last): 
Apr 09 11:46:57   File "/Users/distiller/workspace/miniconda3/lib/python3.7/site-packages/torch/testing/_internal/common_distributed.py", line 175, in wrapper 
Apr 09 11:46:57     self._join_processes(fn) 
Apr 09 11:46:57   File "/Users/distiller/workspace/miniconda3/lib/python3.7/site-packages/torch/testing/_internal/common_distributed.py", line 285, in _join_processes 
Apr 09 11:46:57     self._check_return_codes(elapsed_time) 
Apr 09 11:46:57   File "/Users/distiller/workspace/miniconda3/lib/python3.7/site-packages/torch/testing/_internal/common_distributed.py", line 324, in _check_return_codes 
Apr 09 11:46:57     self.assertEqual(p.exitcode, first_process.exitcode) 
Apr 09 11:46:57   File "/Users/distiller/workspace/miniconda3/lib/python3.7/site-packages/torch/testing/_internal/common_utils.py", line 927, in assertEqual 
Apr 09 11:46:57     super(TestCase, self).assertLessEqual(abs(x - y), prec, message) 
Apr 09 11:46:57 AssertionError: 12 not less than or equal to 1e-05 :  
Apr 09 11:46:57  
Apr 09 11:46:57 ---------------------------------------------------------------------- 
Apr 09 11:46:57 Ran 62 tests in 187.501s 
Apr 09 11:46:57  
Apr 09 11:46:57 FAILED (failures=1, skipped=3) 
Apr 09 11:46:57  
Apr 09 11:46:57 Generating XML reports... 
Apr 09 11:46:57 Generated XML report: test-reports/dist-gloo/TEST-DistAutogradTestWithSpawn-20200409114349.xml 
Apr 09 11:46:57 Traceback (most recent call last): 
Apr 09 11:46:57   File "test/run_test.py", line 696, in <module>

🚧 1 upstream failure:

These were probably caused by upstream breakages:

pytorch_linux_xenial_py3_clang5_asan_test since Apr 09
- 🔁 rerun

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.

See how this bot performed.

This comment has been revised 3 times.

Summary: Pull Request resolved: pytorch#36319 On the way to resolving pytorch#35216. This is a fix for just the master branch but once this goes in, I'll send a cherry-pick to release/1.5 The problem is that we were not calling `format` on a string that had templates (e.g., '{input}', '{dim}'). This change makes it so that we call format on the entire docstring for `torch.min`. Test Plan: - The `torch.max` docs are OK: https://pytorch.org/docs/master/torch.html#torch.max and don't need changing. - `torch.min` docs, before this change: see second screenshot in pytorch#35216. - after this change: <Insert link here on github> ![image](https://user-images.githubusercontent.com/5652049/78921702-4e2acc00-7a63-11ea-9ea0-89636ff6fb0a.png) Differential Revision: D20946702 Pulled By: zou3519 fbshipit-source-id: a1a28707e41136a9bb170c8a4191786cf037a0c2

facebook-github-bot · 2020-04-10T00:25:14Z

@zou3519 merged this pull request in 9662ef6.

Summary: Pull Request resolved: pytorch#36319 On the way to resolving pytorch#35216. This is a fix for just the master branch but once this goes in, I'll send a cherry-pick to release/1.5 The problem is that we were not calling `format` on a string that had templates (e.g., '{input}', '{dim}'). This change makes it so that we call format on the entire docstring for `torch.min`. Test Plan: - The `torch.max` docs are OK: https://pytorch.org/docs/master/torch.html#torch.max and don't need changing. - `torch.min` docs, before this change: see second screenshot in pytorch#35216. - after this change: <Insert link here on github> ![image](https://user-images.githubusercontent.com/5652049/78921702-4e2acc00-7a63-11ea-9ea0-89636ff6fb0a.png) Differential Revision: D20946702 Pulled By: zou3519 fbshipit-source-id: a1a28707e41136a9bb170c8a4191786cf037a0c2

Summary: Pull Request resolved: #36319 On the way to resolving #35216. This is a fix for just the master branch but once this goes in, I'll send a cherry-pick to release/1.5 The problem is that we were not calling `format` on a string that had templates (e.g., '{input}', '{dim}'). This change makes it so that we call format on the entire docstring for `torch.min`. Test Plan: - The `torch.max` docs are OK: https://pytorch.org/docs/master/torch.html#torch.max and don't need changing. - `torch.min` docs, before this change: see second screenshot in #35216. - after this change: <Insert link here on github> ![image](https://user-images.githubusercontent.com/5652049/78921702-4e2acc00-7a63-11ea-9ea0-89636ff6fb0a.png) Differential Revision: D20946702 Pulled By: zou3519 fbshipit-source-id: a1a28707e41136a9bb170c8a4191786cf037a0c2

Summary: Pull Request resolved: pytorch#36319 On the way to resolving pytorch#35216. This is a fix for just the master branch but once this goes in, I'll send a cherry-pick to release/1.5 The problem is that we were not calling `format` on a string that had templates (e.g., '{input}', '{dim}'). This change makes it so that we call format on the entire docstring for `torch.min`. Test Plan: - The `torch.max` docs are OK: https://pytorch.org/docs/master/torch.html#torch.max and don't need changing. - `torch.min` docs, before this change: see second screenshot in pytorch#35216. - after this change: <Insert link here on github> ![image](https://user-images.githubusercontent.com/5652049/78921702-4e2acc00-7a63-11ea-9ea0-89636ff6fb0a.png) Differential Revision: D20946702 Pulled By: zou3519 fbshipit-source-id: a1a28707e41136a9bb170c8a4191786cf037a0c2

zou3519 requested a review from gchanan April 9, 2020 17:09

gchanan approved these changes Apr 9, 2020

View reviewed changes

gchanan added this to the 1.5.0 milestone Apr 9, 2020

facebook-github-bot closed this in 9662ef6 Apr 9, 2020

zou3519 mentioned this pull request Apr 9, 2020

Fix torch.min docs (#36319) #36347

Merged

facebook-github-bot added the merged label Apr 10, 2020

facebook-github-bot deleted the gh/zou3519/244/head branch April 13, 2020 14:16

zou3519 mentioned this pull request Apr 14, 2020

API doc for torch.max/min is broken #35216

Closed

mruberry added the Merged label Oct 28, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix `torch.min` docs#36319

Fix `torch.min` docs#36319
zou3519 wants to merge 1 commit intogh/zou3519/244/basefrom
gh/zou3519/244/head

zou3519 commented Apr 9, 2020 •

edited

Loading

Uh oh!

dr-ci Bot commented Apr 9, 2020 •

edited

Loading

Uh oh!

facebook-github-bot commented Apr 10, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

zou3519 commented Apr 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dr-ci Bot commented Apr 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💊 CircleCI build failures summary and remediations

❄️ 1 tentatively flaky failure

pytorch_macos_10_13_py3_test (1/1)

🚧 1 upstream failure:

Uh oh!

facebook-github-bot commented Apr 10, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

zou3519 commented Apr 9, 2020 •

edited

Loading

dr-ci Bot commented Apr 9, 2020 •

edited

Loading