[docs] Add starter content for new TorchScript language reference #52494

SplitInfinity · 2021-02-19T08:52:22Z

Summary
This commit adds a new .rst file to use for updating the language specification and prepopulates it with the updated content for the expressions section.

Test Plan
https://user-images.githubusercontent.com/4392003/110441235-638ee880-806e-11eb-83ae-3b908bf00d5b.mov

facebook-github-bot · 2021-02-19T08:52:31Z

💊 CI failures summary and remediations

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

1/1 failures introduced in this PR

🕵️ 1 new failure recognized by patterns

The following CI failures do not appear to be due to upstream breakages:

pytorch_doc_test (1/1)

Step: "Doc test" (full log | diagnosis details | 🔁 rerun)

Mar 09 23:13:49 sccache: error: couldn't connect to server

Mar 09 23:13:49 ++++ eval 'extract_trap_cmd '
Mar 09 23:13:49 +++++ extract_trap_cmd
Mar 09 23:13:49 +++++ printf '%s\n' ''
Mar 09 23:13:49 ++++ printf '%s\n' cleanup
Mar 09 23:13:49 +++ trap -- '
Mar 09 23:13:49 cleanup' EXIT
Mar 09 23:13:49 +++ [[ pytorch-linux-xenial-py3.6-gcc5.4-build != *pytorch-win-* ]]
Mar 09 23:13:49 +++ which sccache
Mar 09 23:13:49 +++ sccache --stop-server
Mar 09 23:13:49 Stopping sccache server...
Mar 09 23:13:49 sccache: error: couldn't connect to server
Mar 09 23:13:49 sccache: caused by: Connection refused (os error 111)
Mar 09 23:13:49 +++ true
Mar 09 23:13:49 +++ rm /var/lib/jenkins/sccache_error.log
Mar 09 23:13:49 +++ [[ pytorch-linux-xenial-py3.6-gcc5.4-build == *rocm* ]]
Mar 09 23:13:49 +++ SCCACHE_ERROR_LOG=/var/lib/jenkins/sccache_error.log
Mar 09 23:13:49 +++ SCCACHE_IDLE_TIMEOUT=1200
Mar 09 23:13:49 +++ RUST_LOG=sccache::server=error
Mar 09 23:13:49 +++ sccache --start-server
Mar 09 23:13:49 sccache: Starting the server...
Mar 09 23:13:49 +++ sccache --zero-stats

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 to the (internal) Dr. CI Users group.

docs/source/jit_language_reference_v2.rst

gmagogsfm · 2021-03-04T18:37:45Z

docs/source/jit_language_reference_v2.rst

+The primary must evaluate to an object that supports subscription. If it is a ``List`` , ``Tuple``, or ``str``,
+the expression list must evaluate to an integer or slice. If it is a ``Dict``, the expression list must evaluate
+to an object of the same type as the key type of the ``Dict``. If the primary is a ``ModuleList``, the expression
+list must be an ``integer`` literal. If the primary is a ``ModuleDict``, the expression must be a ``stringliteral``.


Do indices on ModuleList and ModuleDict still need to be literals?

I would say yes; subscriptions can appear in other contexts in addition to the RHS of an assignment. Using non-literal subscripts is allowed for annotated assignment, but not for any subscription in which the primary is a ModuleList or ModuleDict.

docs/source/jit_language_reference_v2.rst

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:

**Summary** This commit adds information about type annotation and inference to the updated language specification. It will be rebased on top of #52494 after it lands. **Test Plan** Continuous integration.

brianjo · 2021-03-10T17:14:49Z

Here's a preview of the file. https://11416809-65600975-gh.circle-artifacts.com/0/docs/jit_language_reference_v2.html (You can find these in the artifacts for pytorch_python_doc_build.)

facebook-github-bot

@SplitInfinity has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

facebook-github-bot

@SplitInfinity has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

facebook-github-bot · 2021-03-11T03:39:11Z

@SplitInfinity merged this pull request in d49c5c7.

mattip · 2021-03-11T14:23:52Z

docs/source/jit_language_reference_v2.rst

+
+    torch.jit.trace = trace_wrapper
+
+.. _language-reference:


This is causing sphinx to choke with

source/jit_language_reference_v2.rst:30: WARNING: duplicate label \ language-reference, other instance in \ ... docs/source/jit_language_reference.rst

One of them should be renamed
@brianjo

facebook-github-bot · 2021-03-11T15:27:56Z

This pull request has been reverted by ffac9b2.

SplitInfinity · 2021-03-11T19:31:05Z

Thanks @mattip! The doc_test job did indeed fail on this PR, but the output was extremely cryptic. How does one debug docs CI job failures?

mattip · 2021-03-11T19:49:45Z

:(. I recently added the message on the failing build:

Docs build failed. If the failure is not clear, scan back in the log
for any WARNINGS or for the line build finished with problems
(tried to echo the WARNINGS above the ==== line)

So that is what I did. Maybe facebook-github-bot could be extended to recognize this failure mode and give more guidance?

SplitInfinity · 2021-03-11T21:24:17Z

I saw that, but I couldn't find anything incriminating in the logs. Although, I am much more used to seeing compiler and test output, and as you said, the facebook-github-bot does a better job of displaying the specific errors related to compilation and test errors.

…53673) Summary: **Summary** This commit adds information about type annotation and inference to the updated language specification. It will be rebased on top of #52494 after it lands. **Test Plan** Continuous integration. Screen capture: https://user-images.githubusercontent.com/4392003/110560184-66371f80-80fa-11eb-803a-923cf8de25ff.mov Pull Request resolved: #53673 Reviewed By: gmagogsfm Differential Revision: D27413001 Pulled By: SplitInfinity fbshipit-source-id: b54b300b4b1f10537ec06e2ee9eeb6d2b1f1810b

…torch#52494) Summary: **Summary** This commit adds a new .rst file to use for updating the language specification and prepopulates it with the updated content for the expressions section. **Test Plan** https://user-images.githubusercontent.com/4392003/110441235-638ee880-806e-11eb-83ae-3b908bf00d5b.mov Pull Request resolved: pytorch#52494 Reviewed By: nikithamalgifb Differential Revision: D26965463 Pulled By: SplitInfinity fbshipit-source-id: 246c76a56d911a8061e720abd200a44d7dfa1f35

facebook-github-bot added the cla signed label Feb 19, 2021

SplitInfinity requested review from gmagogsfm, nikithamalgifb and penguinwu February 19, 2021 08:53

gmagogsfm reviewed Mar 4, 2021

View reviewed changes

SplitInfinity force-pushed the jit-language-spec branch from 9dc3579 to 9890fc0 Compare March 9, 2021 08:27

[WIP][docs] Add updated TorchScript language reference

7f15e04

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:

SplitInfinity force-pushed the jit-language-spec branch from 9890fc0 to 7f15e04 Compare March 9, 2021 22:33

gmagogsfm approved these changes Mar 9, 2021

View reviewed changes

SplitInfinity marked this pull request as ready for review March 9, 2021 22:39

SplitInfinity mentioned this pull request Mar 10, 2021

[docs] Add updated TorchScript language reference section for types #53673

Closed

SplitInfinity changed the title ~~[WIP][docs] Add updated TorchScript language reference~~ [docs] Add starter content for new TorchScript language reference Mar 11, 2021

facebook-github-bot reviewed Mar 11, 2021

View reviewed changes

facebook-github-bot closed this in d49c5c7 Mar 11, 2021

facebook-github-bot added the Merged label Mar 11, 2021

mattip reviewed Mar 11, 2021

View reviewed changes

facebook-github-bot added the Reverted label Mar 11, 2021

brianjo mentioned this pull request Mar 11, 2021

Update jit_language_reference_v2.rst #53814

Closed

[docs] Add starter content for new TorchScript language reference #52494

[docs] Add starter content for new TorchScript language reference #52494

Uh oh!

Conversation

SplitInfinity commented Feb 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

facebook-github-bot commented Feb 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💊 CI failures summary and remediations

🕵️ 1 new failure recognized by patterns

pytorch_doc_test (1/1)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gmagogsfm Mar 4, 2021

Choose a reason for hiding this comment

Uh oh!

SplitInfinity Mar 9, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brianjo commented Mar 10, 2021

Uh oh!

facebook-github-bot left a comment

Choose a reason for hiding this comment

Uh oh!

facebook-github-bot left a comment

Choose a reason for hiding this comment

Uh oh!

facebook-github-bot commented Mar 11, 2021

Uh oh!

mattip Mar 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

facebook-github-bot commented Mar 11, 2021

Uh oh!

SplitInfinity commented Mar 11, 2021

Uh oh!

mattip commented Mar 11, 2021

Uh oh!

SplitInfinity commented Mar 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

SplitInfinity commented Feb 19, 2021 •

edited

Loading

facebook-github-bot commented Feb 19, 2021 •

edited

Loading

mattip Mar 11, 2021 •

edited

Loading