pytorch/docs/source/miscellaneous_environment_variables.rst
drisspg 744898b311 Add doc page for environment variables that effect PyTorch Runtime (#119087)
# Summary

The goal of this PR is to add a doc page to list a number of environment that effect the PyTorch runtime. It will likely not be exhaustive but hopefully will be added and updated to stay relevant.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/119087
Approved by: https://github.com/janeyx99, https://github.com/eqy
2024-02-15 21:41:38 +00:00

13 lines
674 B
ReStructuredText

.. _miscellaneous_environment_variables:
Miscellaneous Environment Variables
===================================
.. list-table::
:header-rows: 1
* - Variable
- Description
* - ``TORCH_FORCE_WEIGHTS_ONLY_LOAD``
- If set to [``1``, ``y``, ``yes``, ``true``], the torch.load will use ``weight_only=True``. For more documentation on this, see :func:`torch.load`.
* - ``TORCH_AUTOGRAD_SHUTDOWN_WAIT_LIMIT``
- Under some conditions, autograd threads can hang on shutdown, therefore we do not wait for them to shutdown indefinitely but rely on timeout that is default set to ``10`` seconds. This environment variable can be used to set the timeout in seconds.