Gary Miguel
703cfdc9ed
[JIT] improve documentation ( #57991 )
...
Summary:
* Fix lots of links.
* Minor improvements for consistency, clarity or grammar.
* Update jit_python_reference to note the limitations on __exit__.
(Related to https://github.com/pytorch/pytorch/issues/41420 ).
* Fix a comment in exit_transforms.cpp: removed the word "not" which
made the comment say the opposite of the truth.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/57991
Reviewed By: malfet
Differential Revision: D28522247
Pulled By: SplitInfinity
fbshipit-source-id: fc63a59d19ea6c89f957c9f7d451be17d1c5fc91
2021-05-19 11:47:32 -07:00
Elias Ellison
d1c375f071
fix fork formatting ( #49436 )
...
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/49436
Test Plan: Imported from OSS
Reviewed By: tugsbayasgalan
Differential Revision: D25788166
Pulled By: eellison
fbshipit-source-id: e368b473ad64a1168be01fc674625415a07ff31c
2021-01-05 16:38:34 -08:00
Samuel Marks
e6779d4357
[*.py] Rename "Arguments:" to "Args:" ( #49736 )
...
Summary:
I've written custom parsers and emitters for everything from docstrings to classes and functions. However, I recently came across an issue when I was parsing/generating from the TensorFlow codebase: inconsistent use of `Args:` and `Arguments:` in its docstrings.
```sh
(pytorch#c348fae)$ for name in 'Args:' 'Arguments:'; do
printf '%-10s %04d\n' "$name" "$(rg -IFtpy --count-matches "$name" | paste -s -d+ -- | bc)"; done
Args: 1095
Arguments: 0336
```
It is easy enough to extend my parsers to support both variants, however it looks like `Arguments:` is wrong anyway, as per:
- https://google.github.io/styleguide/pyguide.html#doc-function-args @ [`ddccc0f`](https://github.com/google/styleguide/blob/ddccc0f/pyguide.md )
- https://chromium.googlesource.com/chromiumos/docs/+/master/styleguide/python.md#describing-arguments-in-docstrings @ [`9fc0fc0`](https://chromium.googlesource.com/chromiumos/docs/+/9fc0fc0/styleguide/python.md )
- https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html @ [`c0ae8e3`](https://github.com/sphinx-contrib/napoleon/blob/c0ae8e3/docs/source/example_google.rst )
Therefore, only `Args:` is valid. This PR replaces them throughout the codebase.
PS: For related PRs, see tensorflow/tensorflow/pull/45420
PPS: The trackbacks automatically appearing below are sending the same changes to other repositories in the [PyTorch](https://github.com/pytorch ) organisation.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/49736
Reviewed By: albanD
Differential Revision: D25710534
Pulled By: soumith
fbshipit-source-id: 61e8ff01abb433e9f78185c2d1d0cbd7c22c1619
2020-12-28 09:34:47 -08:00
Michael Suo
ca1b8ebbcb
move misc implementation out of jit/__init__.py ( #41154 )
...
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/41154
Test Plan: Imported from OSS
Reviewed By: ailzhang
Differential Revision: D22445213
Pulled By: suo
fbshipit-source-id: 200545715c5ef13beb1437f49e01efb21498ddb7
2020-07-13 16:59:55 -07:00
Michael Suo
62cee0001e
Move async + serialization implementation out of 'jit/__init__.py' ( #41018 )
...
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/41018
See https://github.com/pytorch/pytorch/pull/40807 for context.
Test Plan: Imported from OSS
Reviewed By: ailzhang
Differential Revision: D22393869
Pulled By: suo
fbshipit-source-id: a71cc571a423ccb81cd148444dc2a18d2ee43464
2020-07-09 10:10:01 -07:00
