==========
Polygraphy
==========

This page includes the Python API reference documentation for Polygraphy. Polygraphy is a toolkit
designed to assist in running and debugging deep learning models in various frameworks.

For installation instructions, examples, and information about the CLI tools,
see `the GitHub repository <https://github.com/NVIDIA/TensorRT/tree/main/tools/Polygraphy>`_ instead.

For a conceptual overview of the Python API,
see `this page <https://github.com/NVIDIA/TensorRT/tree/main/tools/Polygraphy/polygraphy>`_.

.. warning::
    Any APIs not documented here should be considered internal only and do not adhere to the
    deprecation policy for public APIs. Thus, they may be modified or removed at any time without warning.
    Avoid using undocumented APIs!

.. toctree::
    :hidden:

    self

.. toctree::
    :caption: API Reference: Main
    :maxdepth: 4

    backend/toc
    comparator/toc

.. toctree::
    :caption: API Reference: Miscellaneous
    :maxdepth: 4

    common/toc
    config/toc
    constants/toc
    cuda/toc
    datatype/toc
    exception/toc
    func/toc
    json/toc
    logger/toc

.. toctree::
    :caption: API Reference: Development
    :maxdepth: 4

    tool/toc
