Skip to content

chore: Add documentation for dynamo.compile backend #2389

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Oct 26, 2023
Merged

chore: Add documentation for dynamo.compile backend #2389

merged 4 commits into from
Oct 26, 2023

Conversation

peri044
Copy link
Collaborator

@peri044 peri044 commented Oct 11, 2023 •
edited by narendasan
Loading

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #2378

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 Oct 11, 2023
github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 11, 2023
View reviewed changes
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 reviewed Oct 11, 2023
View reviewed changes
github-actions[bot]
github-actions bot approved these changes Oct 13, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 13, 2023
View reviewed changes
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

@peri044
chore: update dynamo export doc
2d68dbd 
Signed-off-by: Dheeraj Peri <[email protected]>

chore: fix bulleting

Signed-off-by: Dheeraj Peri <[email protected]>

chore: Fix formatting

chore: fix formatting

Signed-off-by: Dheeraj Peri <[email protected]>

chore: fix formatting

Signed-off-by: Dheeraj Peri <[email protected]>

chore: fix reference

Signed-off-by: Dheeraj Peri <[email protected]>
github-actions[bot]
github-actions bot approved these changes Oct 13, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 13, 2023
View reviewed changes
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 added the cherry-pick To cherry-pick to a release branch label Oct 24, 2023
gs-olive
gs-olive requested changes Oct 24, 2023
View reviewed changes
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.

Added a few comments on documentation improvements for this PR.

As part of this PR, could you also fix the .rst linking in index.rst for the saving_models file (see here in User Guide for current rendering: https://pytorch.org/TensorRT/)

@peri044
chore: update formatting
0848562 
Signed-off-by: Dheeraj Peri <[email protected]>
github-actions[bot]
github-actions bot approved these changes Oct 25, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 25, 2023
View reviewed changes
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

@peri044
chore: minor updates
c502a79 
Signed-off-by: Dheeraj Peri <[email protected]>
github-actions[bot]
github-actions bot approved these changes Oct 25, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 25, 2023
View reviewed changes
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

@peri044
chore: fix indexing
cee625d 
Signed-off-by: Dheeraj Peri <[email protected]>
github-actions[bot]
github-actions bot approved these changes Oct 26, 2023
View reviewed changes
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

github-actions[bot]
github-actions bot approved these changes Oct 26, 2023
View reviewed changes
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

@peri044 peri044 merged commit 9d87f82 into main Oct 26, 2023
peri044 added a commit that referenced this pull request Oct 26, 2023
@peri044
chore: Add documentation for dynamo.compile backend (#2389)
400dc39 
Signed-off-by: Dheeraj Peri <[email protected]>
peri044 added a commit that referenced this pull request Oct 28, 2023
@peri044
Cherry-pick : Add documentation for dynamo.compile backend (#2389) (#…
32a8626 
…2416)

Signed-off-by: Dheeraj Peri <[email protected]>
@peri044 peri044 deleted the export_doc branch November 15, 2023 07:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gs-olive gs-olive gs-olive requested changes

@github-actions github-actions[bot] github-actions[bot] approved these changes

@narendasan narendasan Awaiting requested review from narendasan

Assignees
No one assigned
Labels
cherry-pick To cherry-pick to a release branch cla signed documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation on dynamo.compile frontend usage
3 participants
@peri044 @gs-olive @facebook-github-bot