Source code for torch.compiler

import torch
from typing import List

__all__ = [

[docs]def compile(*args, **kwargs): """ See :func:`torch.compile` for details on the arguments for this function. """ return torch.compile(*args, **kwargs)
[docs]def reset() -> None: """ This function clears all compilation caches and restores the system to its initial state. It is recommended to call this function, especially after using operations like `torch.compile(...)` to ensure a clean state before another unrelated compilation """ import torch._dynamo torch._dynamo.reset()
[docs]def allow_in_graph(fn): """ Customize which functions compilation will include in the generated graph. It bypasses all introspection of the symbolic python code in favor of directly writing it to the graph. If fn is a list or tuple of callables it recursively applies :func:`allow_in_graph()` to each function and returns a new list or tuple containing the modified functions Args: fn: A callable representing the function to be included in the graph. .. warning:: :func:`allow_in_graph` skips TorchDynamo completely on the decorated function skipping all TorchDynamo safety checks (graph breaks, handling closures, etc). Therefore, one has to be very careful with :func:`allow_in_graph` since subsystems like AOT Autograd rely on torchdynamo If not careful, this could lead to soundness and really hard-to-debug issues. """ import torch._dynamo return torch._dynamo.allow_in_graph(fn)
[docs]def list_backends(exclude_tags=("debug", "experimental")) -> List[str]: """ Return valid strings that can be passed to `torch.compile(..., backend="name")`. Args: exclude_tags(optional): A tuple of strings representing tags to exclude. """ import torch._dynamo return torch._dynamo.list_backends(exclude_tags)
[docs]def assume_constant_result(fn): """ This function is used to mark a function `fn` as having a constant result. This allows the compiler to optimize away your function Returns The same function `fn` Args: fn: The function to be marked as having a constant result. .. warning:: `assume_constant_result` can if invalid cause safety and soundness issues, :func:`torch.compile` will not attempt to validate whether the constant assumption is true or not """ import torch._dynamo return torch._dynamo.assume_constant_result(fn)
[docs]def disable(fn=None, recursive=True): """ This function provides both a decorator and a context manager to disable compilation on a function It also provides the option of recursively disabling called functions Args: fn (optional): The function to disable recursive (optional): A boolean value indicating whether the disabling should be recursive. """ import torch._dynamo return torch._dynamo.disable(fn, recursive)


Access comprehensive developer documentation for PyTorch

View Docs


Get in-depth tutorials for beginners and advanced developers

View Tutorials


Find development resources and get your questions answered

View Resources