chore: import upstream snapshot with attribution

2026-07-13 13:36:55 +08:00
commit c8a779b1bb
1887 changed files with 3245738 additions and 0 deletions
@@ -0,0 +1,3 @@
+.wy-nav-content {
+    max-width: 1100px !important;
+}
@@ -0,0 +1,37 @@
+{% extends '!page.html' %}
+
+{% block extrahead %}
+<script src="//assets.adobedtm.com/5d4962a43b79/c1061d2c5e7b/launch-191c2462b890.min.js"></script>
+{% endblock %}
+
+{% block footer %}
+{{ super() }}
+
+<div class="footer">
+    <p>
+        Copyright © 2025 NVIDIA Corporation
+    </p>
+    <p>
+        <a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/privacy-policy/" target="_blank" rel="noopener"
+            data-cms-ai="0">Privacy Policy</a> |
+        <a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/privacy-center/" target="_blank" rel="noopener"
+            data-cms-ai="0">Manage My Privacy</a> |
+        <a class="Link" href="https://www.nvidia.com/en-us/preferences/start/" target="_blank" rel="noopener"
+            data-cms-ai="0">Do Not Sell or Share My Data</a> |
+        <a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/terms-of-service/" target="_blank"
+            rel="noopener" data-cms-ai="0">Terms of Service</a> |
+        <a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/accessibility/" target="_blank" rel="noopener"
+            data-cms-ai="0">Accessibility</a> |
+        <a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/company-policies/" target="_blank"
+            rel="noopener" data-cms-ai="0">Corporate Policies</a> |
+        <a class="Link" href="https://www.nvidia.com/en-us/product-security/" target="_blank" rel="noopener"
+            data-cms-ai="0">Product Security</a> |
+        <a class="Link" href="https://www.nvidia.com/en-us/contact/" target="_blank" rel="noopener"
+            data-cms-ai="0">Contact</a>
+    </p>
+</div>
+
+<script type="text/javascript">_satellite.pageBottom();</script>
+<script type="text/javascript">document.getElementsByClassName("bottom-of-page")[0].innerHTML = "";</script>
+
+{% endblock %}
@@ -0,0 +1,7 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.backend.base``
+
+.. automodule:: polygraphy.backend.base.loader
@@ -0,0 +1,7 @@
+============
+Runners
+============
+
+Module: ``polygraphy.backend.base``
+
+.. automodule:: polygraphy.backend.base.runner
@@ -0,0 +1,11 @@
+===============
+Base Interface
+===============
+
+The base interface for all loaders and runners.
+
+Module: ``polygraphy.backend.base``
+
+.. toctree::
+    loader
+    runner
@@ -0,0 +1,8 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.backend.common``
+
+.. automodule:: polygraphy.backend.common.loader
+    :inherited-members:
@@ -0,0 +1,8 @@
+==========
+Common
+==========
+
+Module: ``polygraphy.backend.common``
+
+.. toctree::
+    loader
@@ -0,0 +1,8 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.backend.onnx``
+
+.. automodule:: polygraphy.backend.onnx.loader
+    :inherited-members:
@@ -0,0 +1,8 @@
+====
+ONNX
+====
+
+Module: ``polygraphy.backend.onnx``
+
+.. toctree::
+    loader
@@ -0,0 +1,8 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.backend.onnxrt``
+
+.. automodule:: polygraphy.backend.onnxrt.loader
+    :inherited-members:
@@ -0,0 +1,8 @@
+============
+Runners
+============
+
+Module: ``polygraphy.backend.onnxrt``
+
+.. automodule:: polygraphy.backend.onnxrt.runner
+    :inherited-members:
@@ -0,0 +1,9 @@
+============
+ONNX-Runtime
+============
+
+Module: ``polygraphy.backend.onnxrt``
+
+.. toctree::
+    loader
+    runner
@@ -0,0 +1,8 @@
+============
+Runners
+============
+
+Module: ``polygraphy.backend.pluginref``
+
+.. automodule:: polygraphy.backend.pluginref.runner
+    :inherited-members:
@@ -0,0 +1,8 @@
+================
+Plugin Reference
+================
+
+Module: ``polygraphy.backend.pluginref``
+
+.. toctree::
+    runner
@@ -0,0 +1,8 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.backend.tf``
+
+.. automodule:: polygraphy.backend.tf.loader
+    :inherited-members:
@@ -0,0 +1,8 @@
+============
+Runners
+============
+
+Module: ``polygraphy.backend.tf``
+
+.. automodule:: polygraphy.backend.tf.runner
+    :inherited-members:
@@ -0,0 +1,9 @@
+==============
+TensorFlow 1.X
+==============
+
+Module: ``polygraphy.backend.tf``
+
+.. toctree::
+    loader
+    runner
@@ -0,0 +1,14 @@
+========
+Backends
+========
+
+Module: ``polygraphy.backend``
+
+.. toctree::
+    base/toc
+    common/toc
+    onnx/toc
+    onnxrt/toc
+    pluginref/toc
+    tf/toc
+    trt/toc
@@ -0,0 +1,11 @@
+==================
+Algorithm Selector
+==================
+
+Module: ``polygraphy.backend.trt``
+
+.. warning::
+   Algorithm Selector is deprecated in TensorRT 10.8. Please use editable mode in ITimingCache instead.
+   See https://github.com/NVIDIA/TensorRT/tree/release/10.8/samples/sampleEditableTimingCache.
+
+.. automodule:: polygraphy.backend.trt.algorithm_selector
@@ -0,0 +1,7 @@
+============
+Calibrator
+============
+
+Module: ``polygraphy.backend.trt``
+
+.. automodule:: polygraphy.backend.trt.calibrator
@@ -0,0 +1,8 @@
+============
+Config
+============
+
+Module: ``polygraphy.backend.trt``
+
+.. automodule:: polygraphy.backend.trt.config
+    :inherited-members:
@@ -0,0 +1,9 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.backend.trt``
+
+.. automodule:: polygraphy.backend.trt.loader
+    :inherited-members:
+    :exclude-members: polygraphy.backend.trt.loader.BaseNetworkFromOnnx
@@ -0,0 +1,7 @@
+====================
+Optimization Profile
+====================
+
+Module: ``polygraphy.backend.trt``
+
+.. automodule:: polygraphy.backend.trt.profile
@@ -0,0 +1,8 @@
+============
+Runners
+============
+
+Module: ``polygraphy.backend.trt``
+
+.. automodule:: polygraphy.backend.trt.runner
+    :inherited-members:
@@ -0,0 +1,14 @@
+=========
+TensorRT
+=========
+
+Module: ``polygraphy.backend.trt``
+
+.. toctree::
+    algorithm_selector
+    calibrator
+    config
+    loader
+    profile
+    runner
+    util
@@ -0,0 +1,7 @@
+============
+Utilities
+============
+
+Module: ``polygraphy.backend.trt``
+
+.. automodule:: polygraphy.backend.trt.util
@@ -0,0 +1,7 @@
+===============
+Data Structures
+===============
+
+Module: ``polygraphy.common``
+
+.. automodule:: polygraphy.common.struct
@@ -0,0 +1,8 @@
+============
+Common
+============
+
+Module: ``polygraphy.common``
+
+.. toctree::
+    data_structures
@@ -0,0 +1,7 @@
+==========
+Comparator
+==========
+
+Module: ``polygraphy.comparator``
+
+.. automodule:: polygraphy.comparator.comparator
@@ -0,0 +1,7 @@
+====================
+Comparison Functions
+====================
+
+Module: ``polygraphy.comparator``
+
+.. automodule:: polygraphy.comparator.compare
@@ -0,0 +1,7 @@
+===========
+Data Loader
+===========
+
+Module: ``polygraphy.comparator``
+
+.. automodule:: polygraphy.comparator.data_loader
@@ -0,0 +1,7 @@
+================
+Data Structures
+================
+
+Module: ``polygraphy.comparator``
+
+.. automodule:: polygraphy.comparator.struct
@@ -0,0 +1,7 @@
+=========================
+Postprocessing Functions
+=========================
+
+Module: ``polygraphy.comparator``
+
+.. automodule:: polygraphy.comparator.postprocess
@@ -0,0 +1,12 @@
+==================
+Comparing Results
+==================
+
+Module: ``polygraphy.comparator``
+
+.. toctree::
+    comparator
+    data_structures
+    compare_func
+    postprocess_func
+    data_loader
@@ -0,0 +1,128 @@
+#
+# SPDX-FileCopyrightText: Copyright (c) 1993-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import sys
+import os
+
+ROOT_DIR = os.path.join(os.path.abspath(os.path.dirname(__file__)), os.path.pardir)
+sys.path.insert(0, ROOT_DIR)
+import polygraphy
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.viewcode",
+    "myst_parser",
+]
+
+# Want to be able to generate docs with no dependencies installed
+autodoc_mock_imports = [
+    "tensorrt",
+    "onnx",
+    "numpy",
+    "tensorflow",
+    "onnx_graphsurgeon",
+    "onnxruntime",
+    "tf2onnx",
+]
+
+
+autodoc_default_options = {
+    "members": True,
+    "show-inheritance": True,
+    "exclude-members": "activate_impl, deactivate_impl, get_input_metadata_impl, BaseNetworkFromOnnx, Encoder, Decoder, add_json_methods, constantmethod",
+    "special-members": "__call__, __getitem__, __bool__, __enter__, __exit__",
+}
+
+autodoc_member_order = "bysource"
+
+autodoc_inherit_docstrings = True
+
+add_module_names = False
+
+autosummary_generate = True
+
+source_suffix = [".rst"]
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "Polygraphy"
+copyright = "2024 NVIDIA Corporation"
+author = "NVIDIA"
+
+version = polygraphy.__version__
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# Style
+pygments_style = "colorful"
+
+html_theme = "furo"
+
+html_title = f"{project}<br>{version}"
+
+# Use the TRT theme and NVIDIA logo
+html_static_path = ["_static"]
+
+# Hide source link
+html_show_sourcelink = False
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "PolygraphyDoc"
+
+# Template files to extend default Sphinx templates.
+# See https://www.sphinx-doc.org/en/master/templating.html for details.
+templates_path = ["_templates"]
+
+# For constructor arguments to show up in Sphinx generated doc
+autoclass_content = "both"
+
+html_theme_options = {
+    "light_logo": os.path.join("img", "nvlogo_black.png"),
+    "dark_logo": os.path.join("img", "nvlogo_white.png"),
+    "light_css_variables": {
+        "color-api-pre-name": "#4e9a06",
+        "color-api-name": "#4e9a06",
+        "color-api-background": "#e8e8e8",
+    },
+    "dark_css_variables": {
+        "color-api-background": "#303030",
+    },
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/NVIDIA/TensorRT",
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
+}
+
+# Allows us to override the default page width in the Sphinx theme.
+def setup(app):
+    app.add_css_file("style.css")
+    LATEX_BUILDER = "sphinx.builders.latex"
+    if LATEX_BUILDER in app.config.extensions:
+        app.config.extensions.remove(LATEX_BUILDER)
@@ -0,0 +1,7 @@
+=====================
+Global Configuration
+=====================
+
+Module: ``polygraphy.config``
+
+.. automodule:: polygraphy.config
@@ -0,0 +1,7 @@
+================
+Constants
+================
+
+Module: ``polygraphy.constants``
+
+.. automodule:: polygraphy.constants
@@ -0,0 +1,8 @@
+==============
+CUDA Wrapper
+==============
+
+Module: ``polygraphy.cuda``
+
+.. automodule:: polygraphy.cuda.cuda
+    :inherited-members:
@@ -0,0 +1,7 @@
+================
+Data Types
+================
+
+Module: ``polygraphy.datatype``
+
+.. automodule:: polygraphy.datatype.datatype
@@ -0,0 +1,7 @@
+==========
+Exceptions
+==========
+
+Module: ``polygraphy.exception``
+
+.. automodule:: polygraphy.exception.exception
@@ -0,0 +1,7 @@
+================
+Function Helpers
+================
+
+Module: ``polygraphy.func``
+
+.. automodule:: polygraphy.func.func
@@ -0,0 +1,49 @@
+==========
+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
@@ -0,0 +1,7 @@
+================
+JSON Utilities
+================
+
+Module: ``polygraphy.json``
+
+.. automodule:: polygraphy.json.serde
@@ -0,0 +1,7 @@
+================
+Logger
+================
+
+Module: ``polygraphy.logger``
+
+.. automodule:: polygraphy.logger.logger
@@ -0,0 +1,8 @@
+docutils==0.16; python_version<"3.7"
+docutils==0.18.1; python_version>="3.7"
+sphinx==4.4.0; python_version<"3.7"
+sphinx==7.1.2; python_version>="3.7"
+furo==2022.4.7; python_version<"3.7"
+furo==2024.8.6; python_version>="3.7"
+myst-parser==0.16.1; python_version<"3.7"
+myst-parser==3.0.1; python_version>="3.7"
@@ -0,0 +1,7 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.backend.onnx.loader
@@ -0,0 +1,8 @@
+==========
+ONNX
+==========
+
+Module: ``polygraphy.tools.args``
+
+.. toctree::
+    loader
@@ -0,0 +1,7 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.backend.onnxrt.loader
@@ -0,0 +1,7 @@
+============
+Runners
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.backend.onnxrt.runner
@@ -0,0 +1,9 @@
+=============
+ONNX-Runtime
+=============
+
+Module: ``polygraphy.tools.args``
+
+.. toctree::
+    loader
+    runner
@@ -0,0 +1,7 @@
+============
+Runners
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.backend.pluginref.runner
@@ -0,0 +1,8 @@
+================
+Plugin Reference
+================
+
+Module: ``polygraphy.tools.args``
+
+.. toctree::
+    runner
@@ -0,0 +1,9 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.backend.tf.loader
+
+.. automodule:: polygraphy.tools.args.backend.tf.config
@@ -0,0 +1,7 @@
+============
+Runners
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.backend.tf.runner
@@ -0,0 +1,9 @@
+==========
+TensorFlow
+==========
+
+Module: ``polygraphy.tools.args``
+
+.. toctree::
+    loader
+    runner
@@ -0,0 +1,12 @@
+========
+Backends
+========
+
+Module: ``polygraphy.tools.args``
+
+.. toctree::
+    onnx/toc
+    onnxrt/toc
+    pluginref/toc
+    tf/toc
+    trt/toc
@@ -0,0 +1,9 @@
+============
+Loaders
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.backend.trt.loader
+
+.. automodule:: polygraphy.tools.args.backend.trt.config
@@ -0,0 +1,7 @@
+============
+Runners
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.backend.trt.runner
@@ -0,0 +1,9 @@
+=========
+TensorRT
+=========
+
+Module: ``polygraphy.tools.args``
+
+.. toctree::
+    loader
+    runner
@@ -0,0 +1,9 @@
+=========================
+Base Interface
+=========================
+
+The base interface for all argument groups.
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.base
@@ -0,0 +1,7 @@
+============
+Comparator
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.comparator.comparator
@@ -0,0 +1,7 @@
+====================
+Comparison Functions
+====================
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.comparator.compare
@@ -0,0 +1,7 @@
+============
+Data Loader
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.comparator.data_loader
@@ -0,0 +1,7 @@
+=========================
+Postprocessing Functions
+=========================
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.comparator.postprocess
@@ -0,0 +1,11 @@
+=============
+Comparator
+=============
+
+Module: ``polygraphy.tools.args``
+
+.. toctree::
+    comparator
+    compare
+    data_loader
+    postprocess
@@ -0,0 +1,7 @@
+============
+Logger
+============
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.logger.logger
@@ -0,0 +1,7 @@
+=========================
+Model
+=========================
+
+Module: ``polygraphy.tools.args``
+
+.. automodule:: polygraphy.tools.args.model
@@ -0,0 +1,17 @@
+============================
+Command-line Argument Groups
+============================
+
+Command-line argument groups bundle arguments and related functionality together into reusable components
+and are used throughout the Polygraphy command-line toolkit.
+
+Argument groups are used to add new command-line tools to Polygraphy or extend existing tools with new functionality.
+
+Module: ``polygraphy.tools.args``
+
+.. toctree::
+    base
+    backend/toc
+    comparator/toc
+    logger/toc
+    model
@@ -0,0 +1,7 @@
+=========================
+Script Interface
+=========================
+
+Module: ``polygraphy.tools.script``
+
+.. automodule:: polygraphy.tools.script
@@ -0,0 +1,9 @@
+============================
+Command-line Tool APIs
+============================
+
+Module: ``polygraphy.tools``
+
+.. toctree::
+    args/toc
+    script