Skip to content

Commit

Permalink
docs: [Automated] Regenerating documenation from
Browse files Browse the repository at this point in the history
Signed-off-by: TRTorch Github Bot <trtorch.github.bot@nvidia.com>
  • Loading branch information
TRTorch Github Bot committed Oct 23, 2020
1 parent 1a50192 commit 7c7c23c
Show file tree
Hide file tree
Showing 22 changed files with 594 additions and 889 deletions.
20 changes: 10 additions & 10 deletions docs/_cpp_api/classtrtorch_1_1CompileSpec_1_1DataType.html
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ <h2 id="nested-relationships">
</h2>
<p>
This class is a nested type of
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#exhale-struct-structtrtorch-1-1compilespec">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#exhale-struct-structtrtorch-1-1compilespec">
<span class="std std-ref">
Struct CompileSpec
</span>
Expand Down Expand Up @@ -458,7 +458,7 @@ <h2 id="class-documentation">
<dd>
<p>
Underlying enum class to support the
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType">
<span class="std std-ref">
DataType
</span>
Expand All @@ -467,7 +467,7 @@ <h2 id="class-documentation">
</p>
<p>
In the case that you need to use the
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType">
<span class="std std-ref">
DataType
</span>
Expand All @@ -476,7 +476,7 @@ <h2 id="class-documentation">
</p>
<p>
ex. trtorch::DataType type =
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType_1ac08f05731101a2949ebbe6c04ca32e88ac090aa40e966ee3966c8d64f841c92a3">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType_1ac08f05731101a2949ebbe6c04ca32e88ac090aa40e966ee3966c8d64f841c92a3">
<span class="std std-ref">
DataType::kFloat
</span>
Expand Down Expand Up @@ -612,7 +612,7 @@ <h2 id="class-documentation">
</dt>
<dd>
<p>
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType">
<span class="std std-ref">
DataType
</span>
Expand Down Expand Up @@ -696,7 +696,7 @@ <h2 id="class-documentation">
<dd>
<p>
Get the enum value of the
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType">
<span class="std std-ref">
DataType
</span>
Expand Down Expand Up @@ -775,7 +775,7 @@ <h2 id="class-documentation">
<dd>
<p>
Comparision operator for
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType">
<span class="std std-ref">
DataType
</span>
Expand Down Expand Up @@ -865,7 +865,7 @@ <h2 id="class-documentation">
<dd>
<p>
Comparision operator for
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType">
<span class="std std-ref">
DataType
</span>
Expand Down Expand Up @@ -951,7 +951,7 @@ <h2 id="class-documentation">
<dd>
<p>
Comparision operator for
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType">
<span class="std std-ref">
DataType
</span>
Expand Down Expand Up @@ -1041,7 +1041,7 @@ <h2 id="class-documentation">
<dd>
<p>
Comparision operator for
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType">
<span class="std std-ref">
DataType
</span>
Expand Down
18 changes: 9 additions & 9 deletions docs/_cpp_api/classtrtorch_1_1CompileSpec_1_1DeviceType.html
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ <h2 id="nested-relationships">
</h2>
<p>
This class is a nested type of
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#exhale-struct-structtrtorch-1-1compilespec">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#exhale-struct-structtrtorch-1-1compilespec">
<span class="std std-ref">
Struct CompileSpec
</span>
Expand Down Expand Up @@ -435,15 +435,15 @@ <h2 id="class-documentation">
</p>
<p>
This class is compatable with c10::DeviceTypes (but will check for TRT support) but the only applicable value is at::kCUDA, which maps to
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DeviceType_1aedfe193d27d2328f51aec7c0c3d8b802ae1ee87c402a5e67c5ef90c1037128d3c">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DeviceType_1aedfe193d27d2328f51aec7c0c3d8b802ae1ee87c402a5e67c5ef90c1037128d3c">
<span class="std std-ref">
DeviceType::kGPU
</span>
</a>
</p>
<p>
To use the
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DataType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DataType">
<span class="std std-ref">
DataType
</span>
Expand All @@ -452,7 +452,7 @@ <h2 id="class-documentation">
</p>
<p>
ex. trtorch::DeviceType type =
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DeviceType_1aedfe193d27d2328f51aec7c0c3d8b802ae1ee87c402a5e67c5ef90c1037128d3c">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DeviceType_1aedfe193d27d2328f51aec7c0c3d8b802ae1ee87c402a5e67c5ef90c1037128d3c">
<span class="std std-ref">
DeviceType::kGPU
</span>
Expand Down Expand Up @@ -481,7 +481,7 @@ <h2 id="class-documentation">
<dd>
<p>
Underlying enum class to support the
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DeviceType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DeviceType">
<span class="std std-ref">
DeviceType
</span>
Expand All @@ -490,7 +490,7 @@ <h2 id="class-documentation">
</p>
<p>
In the case that you need to use the
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DeviceType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DeviceType">
<span class="std std-ref">
DeviceType
</span>
Expand All @@ -499,7 +499,7 @@ <h2 id="class-documentation">
</p>
<p>
ex. trtorch::DeviceType type =
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DeviceType_1aedfe193d27d2328f51aec7c0c3d8b802ae1ee87c402a5e67c5ef90c1037128d3c">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DeviceType_1aedfe193d27d2328f51aec7c0c3d8b802ae1ee87c402a5e67c5ef90c1037128d3c">
<span class="std std-ref">
DeviceType::kGPU
</span>
Expand Down Expand Up @@ -766,7 +766,7 @@ <h2 id="class-documentation">
<dd>
<p>
Comparison operator for
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DeviceType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DeviceType">
<span class="std std-ref">
DeviceType
</span>
Expand Down Expand Up @@ -852,7 +852,7 @@ <h2 id="class-documentation">
<dd>
<p>
Comparison operator for
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#classtrtorch_1_1CompileSpec_1_1DeviceType">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#classtrtorch_1_1CompileSpec_1_1DeviceType">
<span class="std std-ref">
DeviceType
</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ <h2 id="class-documentation">
</p>
<p>
Convience function to convert to a IInt8Calibrator* to easily be assigned to the ptq_calibrator field in
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#structtrtorch_1_1CompileSpec">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#structtrtorch_1_1CompileSpec">
<span class="std std-ref">
CompileSpec
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_cpp_api/classtrtorch_1_1ptq_1_1Int8Calibrator.html
Original file line number Diff line number Diff line change
Expand Up @@ -926,7 +926,7 @@ <h2 id="class-documentation">
</p>
<p>
Convience function to convert to a IInt8Calibrator* to easily be assigned to the ptq_calibrator field in
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#structtrtorch_1_1CompileSpec">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#structtrtorch_1_1CompileSpec">
<span class="std std-ref">
CompileSpec
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_cpp_api/file_cpp_api_include_trtorch_logging.h.html
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ <h1 id="cpp-api-file-cpp-api-include-trtorch-logging-h--page-root">
)
</p>
<div class="contents local topic" id="contents">
<p class="topic-title first">
<p class="topic-title">
Contents
</p>
<ul class="simple">
Expand Down
2 changes: 1 addition & 1 deletion docs/_cpp_api/file_cpp_api_include_trtorch_macros.h.html
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ <h1 id="cpp-api-file-cpp-api-include-trtorch-macros-h--page-root">
)
</p>
<div class="contents local topic" id="contents">
<p class="topic-title first">
<p class="topic-title">
Contents
</p>
<ul class="simple">
Expand Down
2 changes: 1 addition & 1 deletion docs/_cpp_api/file_cpp_api_include_trtorch_ptq.h.html
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ <h1 id="cpp-api-file-cpp-api-include-trtorch-ptq-h--page-root">
)
</p>
<div class="contents local topic" id="contents">
<p class="topic-title first">
<p class="topic-title">
Contents
</p>
<ul class="simple">
Expand Down
10 changes: 5 additions & 5 deletions docs/_cpp_api/file_cpp_api_include_trtorch_trtorch.h.html
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ <h1 id="cpp-api-file-cpp-api-include-trtorch-trtorch-h--page-root">
)
</p>
<div class="contents local topic" id="contents">
<p class="topic-title first">
<p class="topic-title">
Contents
</p>
<ul class="simple">
Expand Down Expand Up @@ -547,7 +547,7 @@ <h2 id="classes">
<ul class="simple">
<li>
<p>
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#exhale-struct-structtrtorch-1-1compilespec">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#exhale-struct-structtrtorch-1-1compilespec">
<span class="std std-ref">
Struct CompileSpec
</span>
Expand All @@ -556,7 +556,7 @@ <h2 id="classes">
</li>
<li>
<p>
<a class="reference internal" href="structtrtorch_1_1ExtraInfo_1_1InputRange.html#exhale-struct-structtrtorch-1-1compilespec-1-1inputrange">
<a class="reference internal" href="structtrtorch_1_1CompileSpec_1_1InputRange.html#exhale-struct-structtrtorch-1-1compilespec-1-1inputrange">
<span class="std std-ref">
Struct CompileSpec::InputRange
</span>
Expand All @@ -565,7 +565,7 @@ <h2 id="classes">
</li>
<li>
<p>
<a class="reference internal" href="classtrtorch_1_1ExtraInfo_1_1DataType.html#exhale-class-classtrtorch-1-1compilespec-1-1datatype">
<a class="reference internal" href="classtrtorch_1_1CompileSpec_1_1DataType.html#exhale-class-classtrtorch-1-1compilespec-1-1datatype">
<span class="std std-ref">
Class CompileSpec::DataType
</span>
Expand All @@ -574,7 +574,7 @@ <h2 id="classes">
</li>
<li>
<p>
<a class="reference internal" href="classtrtorch_1_1ExtraInfo_1_1DeviceType.html#exhale-class-classtrtorch-1-1compilespec-1-1devicetype">
<a class="reference internal" href="classtrtorch_1_1CompileSpec_1_1DeviceType.html#exhale-class-classtrtorch-1-1compilespec-1-1devicetype">
<span class="std std-ref">
Class CompileSpec::DeviceType
</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ <h2 id="function-documentation">
</span>
</code>
:
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#structtrtorch_1_1CompileSpec">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#structtrtorch_1_1CompileSpec">
<span class="std std-ref">
trtorch::CompileSpec
</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,9 @@ <h2 id="function-documentation">
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#_CPPv4N7trtorch23ConvertGraphToTRTEngineERKN5torch3jit6ModuleENSt6stringE11CompileSpec" title="Permalink to this definition">
</a>
<br/>
</dt>
<dd>
Expand Down Expand Up @@ -470,7 +473,7 @@ <h2 id="function-documentation">
</span>
</code>
:
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#structtrtorch_1_1CompileSpec">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#structtrtorch_1_1CompileSpec">
<span class="std std-ref">
trtorch::CompileSpec
</span>
Expand Down
10 changes: 5 additions & 5 deletions docs/_cpp_api/namespace_trtorch.html
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ <h1 id="cpp-api-namespace-trtorch--page-root">
</a>
</h1>
<div class="contents local topic" id="contents">
<p class="topic-title first">
<p class="topic-title">
Contents
</p>
<ul class="simple">
Expand Down Expand Up @@ -440,7 +440,7 @@ <h2 id="classes">
<ul class="simple">
<li>
<p>
<a class="reference internal" href="structtrtorch_1_1ExtraInfo.html#exhale-struct-structtrtorch-1-1compilespec">
<a class="reference internal" href="structtrtorch_1_1CompileSpec.html#exhale-struct-structtrtorch-1-1compilespec">
<span class="std std-ref">
Struct CompileSpec
</span>
Expand All @@ -449,7 +449,7 @@ <h2 id="classes">
</li>
<li>
<p>
<a class="reference internal" href="structtrtorch_1_1ExtraInfo_1_1InputRange.html#exhale-struct-structtrtorch-1-1compilespec-1-1inputrange">
<a class="reference internal" href="structtrtorch_1_1CompileSpec_1_1InputRange.html#exhale-struct-structtrtorch-1-1compilespec-1-1inputrange">
<span class="std std-ref">
Struct CompileSpec::InputRange
</span>
Expand All @@ -458,7 +458,7 @@ <h2 id="classes">
</li>
<li>
<p>
<a class="reference internal" href="classtrtorch_1_1ExtraInfo_1_1DataType.html#exhale-class-classtrtorch-1-1compilespec-1-1datatype">
<a class="reference internal" href="classtrtorch_1_1CompileSpec_1_1DataType.html#exhale-class-classtrtorch-1-1compilespec-1-1datatype">
<span class="std std-ref">
Class CompileSpec::DataType
</span>
Expand All @@ -467,7 +467,7 @@ <h2 id="classes">
</li>
<li>
<p>
<a class="reference internal" href="classtrtorch_1_1ExtraInfo_1_1DeviceType.html#exhale-class-classtrtorch-1-1compilespec-1-1devicetype">
<a class="reference internal" href="classtrtorch_1_1CompileSpec_1_1DeviceType.html#exhale-class-classtrtorch-1-1compilespec-1-1devicetype">
<span class="std std-ref">
Class CompileSpec::DeviceType
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_cpp_api/namespace_trtorch__logging.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ <h1 id="cpp-api-namespace-trtorch-logging--page-root">
</a>
</h1>
<div class="contents local topic" id="contents">
<p class="topic-title first">
<p class="topic-title">
Contents
</p>
<ul class="simple">
Expand Down
2 changes: 1 addition & 1 deletion docs/_cpp_api/namespace_trtorch__ptq.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ <h1 id="cpp-api-namespace-trtorch-ptq--page-root">
</a>
</h1>
<div class="contents local topic" id="contents">
<p class="topic-title first">
<p class="topic-title">
Contents
</p>
<ul class="simple">
Expand Down
Loading

0 comments on commit 7c7c23c

Please sign in to comment.