Document `torch.jit.is_tracing()` (#67326)
Summary:
This PR adds `torch.jit.is_tracing()` to the JIT API reference.
This function is widely used but left undocumented: https://github.com/search?q=torch.jit.is_tracing&type=code
Pull Request resolved: https://github.com/pytorch/pytorch/pull/67326
Reviewed By: tugsbayasgalan
Differential Revision: D31985251
Pulled By: Krovatkin
fbshipit-source-id: 852b432b08d63df8bd7a7a02c9555e61f5f37978
diff --git a/docs/source/jit_language_reference.rst b/docs/source/jit_language_reference.rst
index d52c00e..e7b689c 100644
--- a/docs/source/jit_language_reference.rst
+++ b/docs/source/jit_language_reference.rst
@@ -812,6 +812,8 @@
.. autofunction:: torch.jit.is_scripting
+.. autofunction:: torch.jit.is_tracing
+
Attribute Lookup On Python Modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/source/jit_language_reference_v2.rst b/docs/source/jit_language_reference_v2.rst
index 642ebc6..7bad43a 100644
--- a/docs/source/jit_language_reference_v2.rst
+++ b/docs/source/jit_language_reference_v2.rst
@@ -1883,6 +1883,9 @@
- When used in an ``assert`` or an ``if`` statement, the scope or branch where ``torch.jit.is_scripting()`` evaluates to ``False`` is not compiled.
- Its value can be evaluated statically at compile time, thus commonly used in ``if`` statements to stop TorchScript from compiling one of the branches.
- More details and examples can be found in :meth:`~torch.jit.is_scripting`
+- ``torch.jit.is_tracing()``
+ - Returns a boolean value indicating whether the current program is traced by ``torch.jit.trace`` / ``torch.jit.trace_module`` or not.
+ - More details can be found in :meth:`~torch.jit.is_tracing`
- ``@torch.jit.ignore``
- This decorator indicates to the compiler that a function or method should be ignored and left as a Python function.
- This allows you to leave code in your model that is not yet TorchScript compatible.
