summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Riazati <davidriazati@fb.com>2018-12-14 14:14:13 -0800
committerFacebook Github Bot <facebook-github-bot@users.noreply.github.com>2018-12-14 14:27:56 -0800
commite9fb4d1f11465ef0a2f88caa9fec2311bf53591d (patch)
treebbe0fd2eda053a6718e565b93c57f30a44585000 /docs
parentb316e44a46c97eca10c71932f607106e9ff2a2e3 (diff)
downloadpytorch-e9fb4d1f11465ef0a2f88caa9fec2311bf53591d.tar.gz
pytorch-e9fb4d1f11465ef0a2f88caa9fec2311bf53591d.tar.bz2
pytorch-e9fb4d1f11465ef0a2f88caa9fec2311bf53591d.zip
Fix jit doc codeblocks and tables (#15227)
Summary: Some of the codeblocks were showing up as normal text and the "unsupported modules" table was formatted incorrectly Pull Request resolved: https://github.com/pytorch/pytorch/pull/15227 Differential Revision: D13468847 Pulled By: driazati fbshipit-source-id: eb7375710d4f6eca1d0f44dfc43c7c506300cb1e
Diffstat (limited to 'docs')
-rw-r--r--docs/source/jit.rst31
1 files changed, 15 insertions, 16 deletions
diff --git a/docs/source/jit.rst b/docs/source/jit.rst
index 70c79faec4..ae216803c3 100644
--- a/docs/source/jit.rst
+++ b/docs/source/jit.rst
@@ -596,6 +596,7 @@ Interpreting Graphs
graph of a method named ``bar`` on a ScriptModule by accessing ``.bar.graph``.
The example script above produces the graph::
+
graph(%len : int) {
%15 : int = prim::Constant[value=1]()
%9 : bool = prim::Constant[value=1]()
@@ -675,7 +676,8 @@ Automatic Trace Checking
Gives us the following diagnostic information::
ERROR: Graphs differed across invocations!
- Graph diff:
+ Graph diff::
+
graph(%x : Tensor) {
%1 : int = prim::Constant[value=0]()
%2 : int = prim::Constant[value=0]()
@@ -793,21 +795,18 @@ the ``torch`` namespace, all functions in ``torch.nn.functional`` and all
modules from ``torch.nn`` are supported in Torch Script, excluding those in the
table below. For unsupported modules, we suggest using :meth:`torch.jit.trace`.
-=====
-Unsupported ``torch.nn`` Modules
-=====
-``torch.nn.modules.adaptive.AdaptiveLogSoftmaxWithLoss``
-``torch.nn.modules.normalization.CrossMapLRN2d``
-``torch.nn.modules.fold.Fold``
-``torch.nn.modules.fold.Unfold``
-``torch.nn.modules.rnn.GRU``
-``torch.nn.modules.rnn.LSTM``
-``torch.nn.modules.rnn.RNN``
-``torch.nn.modules.rnn.GRUCell``
-``torch.nn.modules.rnn.LSTMCell``
-``torch.nn.modules.rnn.RNNCell``
-=====
-
+Unsupported ``torch.nn`` Modules ::
+
+ torch.nn.modules.adaptive.AdaptiveLogSoftmaxWithLoss
+ torch.nn.modules.normalization.CrossMapLRN2d
+ torch.nn.modules.fold.Fold
+ torch.nn.modules.fold.Unfold
+ torch.nn.modules.rnn.GRU
+ torch.nn.modules.rnn.LSTM
+ torch.nn.modules.rnn.RNN
+ torch.nn.modules.rnn.GRUCell
+ torch.nn.modules.rnn.LSTMCell
+ torch.nn.modules.rnn.RNNCell
.. automodule:: torch.jit.supported_ops