2.0 docs overhaul #2420
Merged
2.0 docs overhaul #2420
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
component: api [Python]
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
There are some changes that do not conform to Python style guidelines:
--- /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 07:40:46.334258+00:00
+++ /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 07:43:30.556347+00:00
@@ -173,17 +173,17 @@
cpp_id_attributes = ["TORCHTRT_API"]
# Tell sphinx what the pygments highlight language should be.
highlight_language = "cpp"
-autodoc_typehints_format = 'short'
+autodoc_typehints_format = "short"
python_use_unqualified_type_names = True
autodoc_type_aliases = {
- 'LegacyConverterImplSignature': 'LegacyConverterImplSignature',
- 'DynamoConverterImplSignature': 'DynamoConverterImplSignature',
- 'ConverterImplSignature': 'ConverterImplSignature',
+ "LegacyConverterImplSignature": "LegacyConverterImplSignature",
+ "DynamoConverterImplSignature": "DynamoConverterImplSignature",
+ "ConverterImplSignature": "ConverterImplSignature",
}
# -- A patch that prevents Sphinx from cross-referencing ivar tags -------
# See http://stackoverflow.com/a/41184353/3343043
There was a problem hiding this comment.
There are some changes that do not conform to Python style guidelines:
--- /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 07:40:45.781026+00:00
+++ /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 07:43:35.157682+00:00
@@ -173,17 +173,17 @@
cpp_id_attributes = ["TORCHTRT_API"]
# Tell sphinx what the pygments highlight language should be.
highlight_language = "cpp"
-autodoc_typehints_format = 'short'
+autodoc_typehints_format = "short"
python_use_unqualified_type_names = True
autodoc_type_aliases = {
- 'LegacyConverterImplSignature': 'LegacyConverterImplSignature',
- 'DynamoConverterImplSignature': 'DynamoConverterImplSignature',
- 'ConverterImplSignature': 'ConverterImplSignature',
+ "LegacyConverterImplSignature": "LegacyConverterImplSignature",
+ "DynamoConverterImplSignature": "DynamoConverterImplSignature",
+ "ConverterImplSignature": "ConverterImplSignature",
}
# -- A patch that prevents Sphinx from cross-referencing ivar tags -------
# See http://stackoverflow.com/a/41184353/3343043
narendasan
force-pushed
the
2.0_docs_overhaul
branch
from
a398b24
to
ce9400c
Compare
github-actions
bot
added
the
component: converters
There was a problem hiding this comment.
There are some changes that do not conform to Python style guidelines:
--- /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 16:01:58.869498+00:00
+++ /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 16:04:31.338494+00:00
@@ -173,17 +173,17 @@
cpp_id_attributes = ["TORCHTRT_API"]
# Tell sphinx what the pygments highlight language should be.
highlight_language = "cpp"
-autodoc_typehints_format = 'short'
+autodoc_typehints_format = "short"
python_use_unqualified_type_names = True
autodoc_type_aliases = {
- 'LegacyConverterImplSignature': 'LegacyConverterImplSignature',
- 'DynamoConverterImplSignature': 'DynamoConverterImplSignature',
- 'ConverterImplSignature': 'ConverterImplSignature',
+ "LegacyConverterImplSignature": "LegacyConverterImplSignature",
+ "DynamoConverterImplSignature": "DynamoConverterImplSignature",
+ "ConverterImplSignature": "ConverterImplSignature",
}
# -- A patch that prevents Sphinx from cross-referencing ivar tags -------
# See http://stackoverflow.com/a/41184353/3343043
gs-olive
reviewed
Oct 30, 2023
docsrc/dynamo/dynamo_export.rst
Outdated
| @@ -1,22 +1,22 @@ | |||
| .. _dynamo_export: | |||
|
|
|||
| Torch-TensorRT Dynamo Backend | |||
| Torch-TensorRT Dynamo Frontend | |||
There was a problem hiding this comment.
Maybe this should be renamed "AOT Path". Otherwise, the section (currently) looks like:
Dynamo Frontend
|
--- Torch-TensorRT torch.compile Backend
--- Torch-TensorRT Dynamo Frontend
Additionally, the words "backend" and "frontend" are used often in both articles, so the real meaning becomes more challenging to discern.
docsrc/dynamo/torch_compile.rst
Outdated
There was a problem hiding this comment.
In line with the above, could this be "Torch-TensorRT torch.compile JIT Path"?
There was a problem hiding this comment.
I think it makes sense to call it
- "TensorRT backend for
torch.compile" - "Torch-TensorRT Dynamo Frontend" or even "Compiling torch.export.ExportedPrograms"
narendasan
force-pushed
the
2.0_docs_overhaul
branch
from
ce9400c
to
14dbbfd
Compare
There was a problem hiding this comment.
There are some changes that do not conform to Python style guidelines:
--- /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 19:21:51.287971+00:00
+++ /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 19:24:50.213758+00:00
@@ -173,17 +173,17 @@
cpp_id_attributes = ["TORCHTRT_API"]
# Tell sphinx what the pygments highlight language should be.
highlight_language = "cpp"
-autodoc_typehints_format = 'short'
+autodoc_typehints_format = "short"
python_use_unqualified_type_names = True
autodoc_type_aliases = {
- 'LegacyConverterImplSignature': 'LegacyConverterImplSignature',
- 'DynamoConverterImplSignature': 'DynamoConverterImplSignature',
- 'ConverterImplSignature': 'ConverterImplSignature',
+ "LegacyConverterImplSignature": "LegacyConverterImplSignature",
+ "DynamoConverterImplSignature": "DynamoConverterImplSignature",
+ "ConverterImplSignature": "ConverterImplSignature",
}
# -- A patch that prevents Sphinx from cross-referencing ivar tags -------
# See http://stackoverflow.com/a/41184353/3343043
There was a problem hiding this comment.
There are some changes that do not conform to Python style guidelines:
--- /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 22:33:08.829725+00:00
+++ /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 22:35:59.936332+00:00
@@ -173,17 +173,17 @@
cpp_id_attributes = ["TORCHTRT_API"]
# Tell sphinx what the pygments highlight language should be.
highlight_language = "cpp"
-autodoc_typehints_format = 'short'
+autodoc_typehints_format = "short"
python_use_unqualified_type_names = True
autodoc_type_aliases = {
- 'LegacyConverterImplSignature': 'LegacyConverterImplSignature',
- 'DynamoConverterImplSignature': 'DynamoConverterImplSignature',
- 'ConverterImplSignature': 'ConverterImplSignature',
+ "LegacyConverterImplSignature": "LegacyConverterImplSignature",
+ "DynamoConverterImplSignature": "DynamoConverterImplSignature",
+ "ConverterImplSignature": "ConverterImplSignature",
}
# -- A patch that prevents Sphinx from cross-referencing ivar tags -------
# See http://stackoverflow.com/a/41184353/3343043
peri044
force-pushed
the
2.0_docs_overhaul
branch
from
8f4ff5d
to
3c86bc2
Compare
There was a problem hiding this comment.
There are some changes that do not conform to Python style guidelines:
--- /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 22:40:26.395976+00:00
+++ /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-30 22:43:23.047029+00:00
@@ -173,17 +173,17 @@
cpp_id_attributes = ["TORCHTRT_API"]
# Tell sphinx what the pygments highlight language should be.
highlight_language = "cpp"
-autodoc_typehints_format = 'short'
+autodoc_typehints_format = "short"
python_use_unqualified_type_names = True
autodoc_type_aliases = {
- 'LegacyConverterImplSignature': 'LegacyConverterImplSignature',
- 'DynamoConverterImplSignature': 'DynamoConverterImplSignature',
- 'ConverterImplSignature': 'ConverterImplSignature',
+ "LegacyConverterImplSignature": "LegacyConverterImplSignature",
+ "DynamoConverterImplSignature": "DynamoConverterImplSignature",
+ "ConverterImplSignature": "ConverterImplSignature",
}
# -- A patch that prevents Sphinx from cross-referencing ivar tags -------
# See http://stackoverflow.com/a/41184353/3343043
Signed-off-by: Naren Dasan <[email protected]> Signed-off-by: Naren Dasan <[email protected]>
Signed-off-by: Naren Dasan <[email protected]> Signed-off-by: Naren Dasan <[email protected]>
Signed-off-by: Dheeraj Peri <[email protected]> chore: updates to export API Signed-off-by: Dheeraj Peri <[email protected]>
narendasan
force-pushed
the
2.0_docs_overhaul
branch
from
df934d5
to
29f894c
Compare
There was a problem hiding this comment.
There are some changes that do not conform to Python style guidelines:
--- /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-31 21:11:38.487313+00:00
+++ /home/runner/work/TensorRT/TensorRT/docsrc/conf.py 2023-10-31 21:14:11.483794+00:00
@@ -173,11 +173,11 @@
cpp_id_attributes = ["TORCHTRT_API"]
# Tell sphinx what the pygments highlight language should be.
highlight_language = "cpp"
-autodoc_typehints_format = 'short'
+autodoc_typehints_format = "short"
python_use_unqualified_type_names = True
autodoc_type_aliases = {
"LegacyConverterImplSignature": "LegacyConverterImplSignature",
"DynamoConverterImplSignature": "DynamoConverterImplSignature",Signed-off-by: Naren Dasan <[email protected]> Signed-off-by: Naren Dasan <[email protected]>
narendasan
force-pushed
the
2.0_docs_overhaul
branch
from
29f894c
to
ec1d5ac
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Restructures the documentation for 2.x.
@peri044: You need to implement the export function we discussed and make sure the docs match. Please just commit directly to this branch if there isnt another branch for it already. If there is let me know so I can adjust the docs.
N.b. This adjusts some imports to make more sense from a user prespective (cc: @gs-olive)
Fixes: #1924
Type of change
Please delete options that are not relevant and/or add your own.
Checklist: