pytorch/docs/source/torch.compiler_api.rst
Yidi Wu 1e201422ed [export] add is_exporting flag (#142425)
We added an is_export flag under torch.compiler.is_exporting. This comes handy when we try to do some special logic in user-level and system-level (e.g. in upper of the stack).

In increasing-scope:
- `_is_fx_tracing` is set to True when we use under symbolic_trace or make_fx.
- `is_exporting` is set to True when we're doing strict or non-strict export, which internally has a step that calls make_fx and set _is_fx_tracing to be True.
- `is_compiling` is set to True when we're either doing strict, non-strict export or torch.compile.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/142425
Approved by: https://github.com/avikchaudhuri
2024-12-18 21:36:28 +00:00

28 lines
530 B
ReStructuredText

.. currentmodule:: torch.compiler
.. automodule:: torch.compiler
.. _torch.compiler_api:
torch.compiler API reference
============================
For a quick overview of ``torch.compiler``, see :ref:`torch.compiler_overview`.
.. autosummary::
:toctree: generated
:nosignatures:
compile
reset
allow_in_graph
substitute_in_graph
assume_constant_result
list_backends
disable
set_stance
cudagraph_mark_step_begin
is_compiling
is_dynamo_compiling
is_exporting