Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorg docs and fix css for sphix-gallery examples #1967

Merged
merged 2 commits into from
Jul 25, 2023

Conversation

narendasan
Copy link
Collaborator

Description

Reorgs some files and fixes the CSS for the gallery

Fixes # (issue)

Type of change

Please delete options that are not relevant and/or add your own.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project (You can use the linters)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas and hacks
  • I have made corresponding changes to the documentation
  • I have added tests to verify my fix or my feature
  • New and existing unit tests pass locally with my changes
  • I have added the relevant labels to my PR in so that relevant reviewers are notified

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 31, 2023
@narendasan narendasan force-pushed the dynamo_examples_gallery branch from 33e63e0 to e3bb744 Compare May 31, 2023 23:20
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to Python style guidelines

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to C++ style guidelines

Copy link
Collaborator

@gs-olive gs-olive left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes improve the organization and look of the Tutorials greatly. I wonder if the thumbnails could be adapted to include some sort of download/other data instead of linking to the same hyperlinked pages as above. See the bottom of this scikit-learn examples page, for instance.

- `dynamo_compile_resnet_example.py <./dynamo_compile_resnet_example.html>`_: Example showcasing compilation of ResNet model
- `dynamo_compile_transformers_example.py <./dynamo_compile_transformers_example.html>`_: Example showcasing compilation of transformer-based model
- `dynamo_compile_advanced_usage.py <./dynamo_compile_advanced_usage.html>`_: Advanced usage including making a custom backend to use directly with the `torch.compile` API
* :ref:`dynamo_compile_resnet`: Compiling a ResNet model using the Dyanmo Compile Frontend for ``torch_tensorrt.compile``
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor typo (replace "Dyanmo" with "Dynamo"). Also should torch_tensorrt.compile be torch.compile? For example:

Compiling a ResNet model using the Dynamo Compile Frontend for torch.compile

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example uses torch_tensorrt.compile right?

- `dynamo_compile_transformers_example.py <./dynamo_compile_transformers_example.html>`_: Example showcasing compilation of transformer-based model
- `dynamo_compile_advanced_usage.py <./dynamo_compile_advanced_usage.html>`_: Advanced usage including making a custom backend to use directly with the `torch.compile` API
* :ref:`dynamo_compile_resnet`: Compiling a ResNet model using the Dyanmo Compile Frontend for ``torch_tensorrt.compile``
* :ref:`torch_compile_transformer`: Compiling a Transformer model using ``torch.compile``
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the transformers script is nearly the same as the Resnet script, except for the model, this could instead be:

Compiling a Transformer model using the Dynamo Compile Frontend for torch.compile

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Id like for the Transformer script to use the torch.compile interface

=========================
.. _dynamo_compile_resnet:

Compiling ResNet using the Torch-TensorRT Dyanmo Frontend
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment in examples/dynamo/README.rst

=========================
.. _torch_compile_transformer:

Compiling a Transformer using torch.compile and TensorRT
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment in examples/dynamo/README.rst

docsrc/_static/css/custom.css Outdated Show resolved Hide resolved
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to Python style guidelines

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to C++ style guidelines

@gs-olive gs-olive force-pushed the dynamo_torch_compile_examples branch 6 times, most recently from c10c4ec to 0f712bd Compare June 2, 2023 20:00
@narendasan narendasan force-pushed the dynamo_examples_gallery branch from 3a4840f to 966d9fc Compare June 7, 2023 20:18
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to C++ style guidelines

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to Python style guidelines

@gs-olive gs-olive force-pushed the dynamo_torch_compile_examples branch 4 times, most recently from d333291 to 9588d68 Compare June 14, 2023 00:36
@gs-olive gs-olive force-pushed the dynamo_torch_compile_examples branch 3 times, most recently from ace988f to 764a469 Compare June 21, 2023 00:52
@gs-olive gs-olive force-pushed the dynamo_torch_compile_examples branch 3 times, most recently from f5af0a1 to 9c026a6 Compare June 29, 2023 00:51
@gs-olive gs-olive force-pushed the dynamo_torch_compile_examples branch 2 times, most recently from 1410206 to 94a7942 Compare July 12, 2023 17:21
@gs-olive gs-olive force-pushed the dynamo_torch_compile_examples branch from 94a7942 to 7e5f96c Compare July 12, 2023 17:29
@gs-olive gs-olive force-pushed the dynamo_examples_gallery branch from 966d9fc to 2684dd9 Compare July 12, 2023 17:30
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to C++ style guidelines

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to Python style guidelines

@gs-olive gs-olive force-pushed the dynamo_torch_compile_examples branch from 407c299 to c64566a Compare July 21, 2023 21:40
render properly

Signed-off-by: Naren Dasan <naren@narendasan.com>
Signed-off-by: Naren Dasan <narens@nvidia.com>
Signed-off-by: Naren Dasan <naren@narendasan.com>
Signed-off-by: Naren Dasan <narens@nvidia.com>
@gs-olive gs-olive force-pushed the dynamo_examples_gallery branch from 2684dd9 to ec35106 Compare July 25, 2023 17:35
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to C++ style guidelines

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code conforms to Python style guidelines

- `dynamo_compile_resnet_example.py <./dynamo_compile_resnet_example.html>`_: Example showcasing compilation of ResNet model
- `dynamo_compile_transformers_example.py <./dynamo_compile_transformers_example.html>`_: Example showcasing compilation of transformer-based model
- `dynamo_compile_advanced_usage.py <./dynamo_compile_advanced_usage.html>`_: Advanced usage including making a custom backend to use directly with the `torch.compile` API
* :ref:`dynamo_compile_resnet`: Compiling a ResNet model using the Dynamo Compile Frontend for ``torch_tensorrt.compile``
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs rename, Dynamo Compile now means something else in the torch_tensorrt context

@gs-olive gs-olive merged commit 9a91fb8 into dynamo_torch_compile_examples Jul 25, 2023
gs-olive pushed a commit that referenced this pull request Jul 25, 2023
Signed-off-by: Naren Dasan <naren@narendasan.com>
Signed-off-by: Naren Dasan <narens@nvidia.com>
gs-olive pushed a commit that referenced this pull request Aug 1, 2023
Signed-off-by: Naren Dasan <naren@narendasan.com>
Signed-off-by: Naren Dasan <narens@nvidia.com>
gs-olive pushed a commit that referenced this pull request Aug 2, 2023
Signed-off-by: Naren Dasan <naren@narendasan.com>
Signed-off-by: Naren Dasan <narens@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla signed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants