Skip to content

Commit

Permalink
docs: [Automated] Regenerating documenation for 4bbc132
Browse files Browse the repository at this point in the history
Signed-off-by: Torch-TensorRT Github Bot <[email protected]>
  • Loading branch information
Torch-TensorRT Github Bot committed May 13, 2022
1 parent 4bbc132 commit b91605b
Show file tree
Hide file tree
Showing 213 changed files with 92,157 additions and 79,292 deletions.
2,387 changes: 795 additions & 1,592 deletions docs/_cpp_api/classtorch__tensorrt_1_1DataType.html

Large diffs are not rendered by default.

2,046 changes: 744 additions & 1,302 deletions docs/_cpp_api/classtorch__tensorrt_1_1Device_1_1DeviceType.html

Large diffs are not rendered by default.

2,295 changes: 776 additions & 1,519 deletions docs/_cpp_api/classtorch__tensorrt_1_1TensorFormat.html

Large diffs are not rendered by default.

2,091 changes: 740 additions & 1,351 deletions docs/_cpp_api/classtorch__tensorrt_1_1ptq_1_1Int8CacheCalibrator.html

Large diffs are not rendered by default.

2,192 changes: 750 additions & 1,442 deletions docs/_cpp_api/classtorch__tensorrt_1_1ptq_1_1Int8Calibrator.html

Large diffs are not rendered by default.

1,215 changes: 635 additions & 580 deletions docs/_cpp_api/define_macros_8h_1a18d295a837ac71add5578860b55e5502.html

Large diffs are not rendered by default.

1,204 changes: 635 additions & 569 deletions docs/_cpp_api/define_macros_8h_1a282fd3c0b1c3a215148ae372070e1268.html

Large diffs are not rendered by default.

1,204 changes: 635 additions & 569 deletions docs/_cpp_api/define_macros_8h_1a31398a6d4d27e28817afb0f0139e909e.html

Large diffs are not rendered by default.

1,204 changes: 635 additions & 569 deletions docs/_cpp_api/define_macros_8h_1a35703561b26b1a9d2738ad7d58b27827.html

Large diffs are not rendered by default.

1,204 changes: 635 additions & 569 deletions docs/_cpp_api/define_macros_8h_1abd1465eb38256d3f22cc1426b23d516b.html

Large diffs are not rendered by default.

1,215 changes: 635 additions & 580 deletions docs/_cpp_api/define_macros_8h_1abe87b341f562fd1cf40b7672e4d759da.html

Large diffs are not rendered by default.

1,204 changes: 635 additions & 569 deletions docs/_cpp_api/define_macros_8h_1ad19939408f7be171a74a89928b36eb59.html

Large diffs are not rendered by default.

1,204 changes: 635 additions & 569 deletions docs/_cpp_api/define_macros_8h_1adad592a7b1b7eed529cdf6acd584c883.html

Large diffs are not rendered by default.

1,142 changes: 618 additions & 524 deletions docs/_cpp_api/dir_cpp.html

Large diffs are not rendered by default.

1,158 changes: 619 additions & 539 deletions docs/_cpp_api/dir_cpp_include.html

Large diffs are not rendered by default.

1,184 changes: 620 additions & 564 deletions docs/_cpp_api/dir_cpp_include_torch_tensorrt.html

Large diffs are not rendered by default.

1,453 changes: 673 additions & 780 deletions docs/_cpp_api/enum_logging_8h_1a130f65408ad8cbaee060f05e8db69558.html

Large diffs are not rendered by default.

1,326 changes: 652 additions & 674 deletions docs/_cpp_api/enum_torch__tensorrt_8h_1a3fbe5d72e4fc624dbd038853079620eb.html

Large diffs are not rendered by default.

1,441 changes: 661 additions & 780 deletions docs/_cpp_api/file_cpp_include_torch_tensorrt_logging.h.html

Large diffs are not rendered by default.

1,370 changes: 648 additions & 722 deletions docs/_cpp_api/file_cpp_include_torch_tensorrt_macros.h.html

Large diffs are not rendered by default.

1,444 changes: 658 additions & 786 deletions docs/_cpp_api/file_cpp_include_torch_tensorrt_ptq.h.html

Large diffs are not rendered by default.

1,541 changes: 671 additions & 870 deletions docs/_cpp_api/file_cpp_include_torch_tensorrt_torch_tensorrt.h.html

Large diffs are not rendered by default.

1,254 changes: 635 additions & 619 deletions docs/_cpp_api/function_logging_8h_1a0593f776f469c20469e2f729fc7861a3.html

Large diffs are not rendered by default.

1,265 changes: 641 additions & 624 deletions docs/_cpp_api/function_logging_8h_1a0c012cb374addd90eb1f42eaec570650.html

Large diffs are not rendered by default.

1,263 changes: 641 additions & 622 deletions docs/_cpp_api/function_logging_8h_1a56e110feaaba2c3fd44bd201fd21a76a.html

Large diffs are not rendered by default.

1,280 changes: 641 additions & 639 deletions docs/_cpp_api/function_logging_8h_1a7cb50492421ea9de4e3db895819df6f2.html

Large diffs are not rendered by default.

1,318 changes: 644 additions & 674 deletions docs/_cpp_api/function_logging_8h_1ac46ac0901cb97e3ae6e93b45f24e90b8.html

Large diffs are not rendered by default.

1,278 changes: 641 additions & 637 deletions docs/_cpp_api/function_logging_8h_1ad2efd47b6c3689e58ccc595680579ae5.html

Large diffs are not rendered by default.

1,266 changes: 635 additions & 631 deletions docs/_cpp_api/function_logging_8h_1af8f3443813315af7901903d25dd495cc.html

Large diffs are not rendered by default.

1,526 changes: 656 additions & 870 deletions docs/_cpp_api/function_ptq_8h_1a83ff2be7e0b80bc7434de415861dc039.html

Large diffs are not rendered by default.

1,417 changes: 650 additions & 767 deletions docs/_cpp_api/function_ptq_8h_1a9835f6e605dce1abf442a55b64d6dffa.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,419 changes: 657 additions & 762 deletions docs/_cpp_api/namespace_torch_tensorrt.html

Large diffs are not rendered by default.

1,317 changes: 642 additions & 675 deletions docs/_cpp_api/namespace_torch_tensorrt__logging.html

Large diffs are not rendered by default.

1,285 changes: 642 additions & 643 deletions docs/_cpp_api/namespace_torch_tensorrt__ptq.html

Large diffs are not rendered by default.

1,291 changes: 641 additions & 650 deletions docs/_cpp_api/namespace_torch_tensorrt__torchscript.html

Large diffs are not rendered by default.

1,125 changes: 619 additions & 506 deletions docs/_cpp_api/program_listing_file_cpp_include_torch_tensorrt_logging.h.html

Large diffs are not rendered by default.

1,129 changes: 621 additions & 508 deletions docs/_cpp_api/program_listing_file_cpp_include_torch_tensorrt_macros.h.html

Large diffs are not rendered by default.

1,141 changes: 627 additions & 514 deletions docs/_cpp_api/program_listing_file_cpp_include_torch_tensorrt_ptq.h.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2,260 changes: 792 additions & 1,468 deletions docs/_cpp_api/structtorch__tensorrt_1_1Device.html

Large diffs are not rendered by default.

3,370 changes: 815 additions & 2,555 deletions docs/_cpp_api/structtorch__tensorrt_1_1Input.html

Large diffs are not rendered by default.

2,574 changes: 782 additions & 1,792 deletions docs/_cpp_api/structtorch__tensorrt_1_1torchscript_1_1CompileSpec.html

Large diffs are not rendered by default.

2,512 changes: 990 additions & 1,522 deletions docs/_cpp_api/torch_tensort_cpp.html

Large diffs are not rendered by default.

1,470 changes: 707 additions & 763 deletions docs/_cpp_api/unabridged_orphan.html

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/yi_jing_01_chien.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
632 changes: 632 additions & 0 deletions docs/_modules/index.html

Large diffs are not rendered by default.

749 changes: 749 additions & 0 deletions docs/_modules/torch_tensorrt/_Device.html

Large diffs are not rendered by default.

865 changes: 865 additions & 0 deletions docs/_modules/torch_tensorrt/_Input.html

Large diffs are not rendered by default.

801 changes: 801 additions & 0 deletions docs/_modules/torch_tensorrt/_compile.html

Large diffs are not rendered by default.

648 changes: 648 additions & 0 deletions docs/_modules/torch_tensorrt/_util.html

Large diffs are not rendered by default.

833 changes: 833 additions & 0 deletions docs/_modules/torch_tensorrt/logging.html

Large diffs are not rendered by default.

791 changes: 791 additions & 0 deletions docs/_modules/torch_tensorrt/ptq.html

Large diffs are not rendered by default.

969 changes: 969 additions & 0 deletions docs/_modules/torch_tensorrt/ts/_compile_spec.html

Large diffs are not rendered by default.

869 changes: 869 additions & 0 deletions docs/_modules/torch_tensorrt/ts/_compiler.html

Large diffs are not rendered by default.

2,053 changes: 897 additions & 1,156 deletions docs/_notebooks/CitriNet-example.html

Large diffs are not rendered by default.

2,191 changes: 910 additions & 1,281 deletions docs/_notebooks/EfficientNet-example.html

Large diffs are not rendered by default.

2,284 changes: 951 additions & 1,333 deletions docs/_notebooks/Hugging-Face-BERT.html

Large diffs are not rendered by default.

2,218 changes: 925 additions & 1,293 deletions docs/_notebooks/Resnet50-example.html

Large diffs are not rendered by default.

2,082 changes: 923 additions & 1,159 deletions docs/_notebooks/dynamic-shapes.html

Large diffs are not rendered by default.

2,137 changes: 921 additions & 1,216 deletions docs/_notebooks/lenet-getting-started.html

Large diffs are not rendered by default.

2,645 changes: 1,083 additions & 1,562 deletions docs/_notebooks/ssd-object-detection-demo.html

Large diffs are not rendered by default.

2,667 changes: 1,115 additions & 1,552 deletions docs/_notebooks/vgg-qat.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Class Documentation


.. doxygenclass:: torch_tensorrt::DataType
:project: Torch-TensorRT
:members:
:protected-members:
:undoc-members:
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Class Documentation


.. doxygenclass:: torch_tensorrt::Device::DeviceType
:project: Torch-TensorRT
:members:
:protected-members:
:undoc-members:
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Class Documentation


.. doxygenclass:: torch_tensorrt::TensorFormat
:project: Torch-TensorRT
:members:
:protected-members:
:undoc-members:
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Class Documentation


.. doxygenclass:: torch_tensorrt::ptq::Int8CacheCalibrator
:project: Torch-TensorRT
:members:
:protected-members:
:undoc-members:
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Class Documentation


.. doxygenclass:: torch_tensorrt::ptq::Int8Calibrator
:project: Torch-TensorRT
:members:
:protected-members:
:undoc-members:
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Define Documentation


.. doxygendefine:: STR
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Define Documentation


.. doxygendefine:: TORCH_TENSORRT_PATCH_VERSION
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Define Documentation


.. doxygendefine:: TORCH_TENSORRT_MAJOR_VERSION
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Define Documentation


.. doxygendefine:: TORCH_TENSORRT_MINOR_VERSION
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Define Documentation


.. doxygendefine:: TORCHTRT_API
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Define Documentation


.. doxygendefine:: XSTR
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Define Documentation


.. doxygendefine:: TORCHTRT_HIDDEN
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Define Documentation


.. doxygendefine:: TORCH_TENSORRT_VERSION
:project: Torch-TensorRT
4 changes: 2 additions & 2 deletions docs/_sources/_cpp_api/dir_cpp_include_torch_tensorrt.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _dir_cpp_include_torch_tensorrt:


Directory tensorrt
==================
Directory torch_tensorrt
========================


|exhale_lsh| :ref:`Parent directory <dir_cpp_include>` (``cpp/include``)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Enum Documentation


.. doxygenenum:: torch_tensorrt::logging::Level
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Enum Documentation


.. doxygenenum:: torch_tensorrt::EngineCapability
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::logging::get_logging_prefix()
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::logging::get_reportable_log_level()
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::logging::get_is_colored_output_on()
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::logging::set_reportable_log_level(Level)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::logging::log(Level, std::string)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::logging::set_is_colored_output_on(bool)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::logging::set_logging_prefix(std::string)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::ptq::make_int8_calibrator(DataLoader, const std::string&, bool)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::ptq::make_int8_cache_calibrator(const std::string&)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::torchscript::check_method_operator_support(const torch::jit::Module&, std::string)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::torchscript::compile(const torch::jit::Module&, CompileSpec)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::torchscript::embed_engine_in_new_module(const std::string&, Device)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::get_build_info()
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::set_device(const int)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::dump_build_info()
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Function Documentation


.. doxygenfunction:: torch_tensorrt::torchscript::convert_method_to_trt_engine(const torch::jit::Module&, std::string, CompileSpec)
:project: Torch-TensorRT
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Struct Documentation


.. doxygenstruct:: torch_tensorrt::Device
:project: Torch-TensorRT
:members:
:protected-members:
:undoc-members:
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Struct Documentation


.. doxygenstruct:: torch_tensorrt::Input
:project: Torch-TensorRT
:members:
:protected-members:
:undoc-members:
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Struct Documentation


.. doxygenstruct:: torch_tensorrt::torchscript::CompileSpec
:project: Torch-TensorRT
:members:
:protected-members:
:undoc-members:
8 changes: 4 additions & 4 deletions docs/_sources/_cpp_api/torch_tensort_cpp.rst.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

======================
Torch-TensorRT C++ API
======================

.. include:: class_view_hierarchy.rst
.. include:: class_view_hierarchy.rst.include

.. include:: file_view_hierarchy.rst
.. include:: file_view_hierarchy.rst.include

.. include:: unabridged_api.rst
.. include:: unabridged_api.rst.include

6 changes: 6 additions & 0 deletions docs/_sources/src/pytorch-sphinx-theme/docs/changelog.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

*********
Changelog
*********

v0.0.1
108 changes: 108 additions & 0 deletions docs/_sources/src/pytorch-sphinx-theme/docs/configuring.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@

*************
Configuration
*************

You can configure different parts of the theme.

Project-wide Configuration
==========================

HTML Theme Options
------------------

The theme's project-wide options are defined in the ``pytorch_sphinx_theme/theme.conf``
file of this repository, and can be defined in your project's ``conf.py`` via
``html_theme_options``. For example:

.. code:: python
html_theme_options = {
'canonical_url': '',
'analytics_id': '',
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False
}
The following options are available:

Base options
~~~~~~~~~~~~

* ``canonical_url`` String. This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__
to let search engines know they should give higher ranking to latest version of the docs.
The url points to the root of the documentation and requires a trailing slash.
* ``analytics_id`` String. Change the Google Analytics ID that is included on pages.
* ``display_version`` Bool. With this disabled, the version number isn't shown at the top of the sidebar.
* ``prev_next_buttons_location`` String. can take the value ``bottom``, ``top``, ``both`` , or ``None``
and will display the "Next" and "Previous" buttons accordingly.
* ``style_external_links`` Bool. Add an icon next to external links. Defaults to ``False``.
* ``vcs_pageview_mode`` String. Changes how to view files when using `display_github`, `display_gitlab`, etc.
When using Github or Gitlab this can be: `blob` (default), `edit`, or `raw`,
on Bitbucket, this can be either: `view` (default) or `edit`.

TOC Options
~~~~~~~~~~~

These effect how we display the Table of Contents in the side bar. You can read more about them here: http://www.sphinx-doc.org/en/stable/templating.html#toctree

* ``collapse_navigation`` Bool. With this enabled, you will lose the ``[+]`` drop downs next to each section in the sidebar.
* ``sticky_navigation`` Bool. This causes the sidebar to scroll with the main page content as you scroll the page.
* ``navigation_depth`` Int. Indicate the max depth of the tree; by default, 4 levels are included;
set it to -1 to allow unlimited depth.
* ``includehidden`` Bool. Specifies if the sidebar includes toctrees marked with the ``:hidden:`` option
* ``titles_only`` Bool. If True, removes headers within a page from the sidebar.

.. note::

Setting ``collapse_navigation`` to False and using a high ``navigation_depth``
can cause projects with many files and a deep file structure to generate HTML files
that are significantly larger in file size and much longer compilation times.


HTML Context Options
--------------------

TODO.


Page-level Configuration
========================

Pages support metadata that changes how the theme renders.
You can currently add the following:

* ``:github_url:`` This will force the "Edit on GitHub" to the configured URL
* ``:bitbucket_url:`` This will force the "Edit on Bitbucket" to the configured URL
* ``:gitlab_url:`` This will force the "Edit on GitLab" to the configured URL


How the Table of Contents builds
================================

Currently the left menu will build based upon any ``toctree(s)`` defined in your ``index.rst`` file.
It outputs 2 levels of depth, which should give your visitors a high level of access to your
docs. If no toctrees are set the theme reverts to sphinx's usual local toctree.

It's important to note that if you don't follow the same styling for your rST headers across
your documents, the toctree will misbuild, and the resulting menu might not show the correct
depth when it renders.

Also note that by default the table of contents is set with ``includehidden=True``. This allows you
to set a hidden toc in your index file with the `:hidden: <hidden_>`_ property that will allow you
to build a toc without it rendering in your index.

By default, the navigation will "stick" to the screen as you scroll. However if your toc
is vertically too large, it will revert to static positioning. To disable the sticky nav
altogether change the setting in ``conf.py``.

.. _hidden: http://sphinx-doc.org/markup/toctree.html
Loading

0 comments on commit b91605b

Please sign in to comment.