Skip to content

docs: Add documentation of torch.compile backend usage #2363

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 1 commit into from
Oct 10, 2023
Merged

docs: Add documentation of torch.compile backend usage #2363

merged 1 commit into from
Oct 10, 2023

Conversation

@gs-olive
Copy link
Contributor

@gs-olive gs-olive commented Oct 5, 2023 •
edited
Loading

Description

  • Add detailed descriptions of pre, during, and post compilation processes
  • Add descriptions of valuable compile-time arguments
  • Write about thress specific use cases of the tool

Fixes #2359

Type of change

-Documentation

Checklist:

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

@gs-olive gs-olive requested review from narendasan and peri044 October 5, 2023 18:39
@gs-olive gs-olive self-assigned this Oct 5, 2023
@gs-olive gs-olive changed the title docs: Add documentation of torch.compile usage docs: Add documentation of torch.compile backend usage Oct 5, 2023
@github-actions github-actions bot added component: api [Python] Issues re: Python API component: dynamo Issues relating to the `torch.compile` or `torch._dynamo.export` paths documentation Improvements or additions to documentation labels Oct 5, 2023
github-actions[bot]
github-actions bot approved these changes Oct 5, 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 5, 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 5, 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 5, 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 5, 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 5, 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

@gs-olive
docs: Add documentation of torch.compile usage
a837cba 
- Add detailed descriptions of pre, during, and post compilation
processes
- Add descriptions of valuable compile-time arguments
- Write about thress specific use cases of the tool
@gs-olive gs-olive force-pushed the torch_compile_additional_documentation branch from 861d1a2 to a837cba Compare October 10, 2023 04:34
github-actions[bot]
github-actions bot approved these changes Oct 10, 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 10, 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

narendasan
narendasan approved these changes Oct 10, 2023
View reviewed changes
Copy link
Collaborator

@narendasan narendasan left a comment

Choose a reason for hiding this comment

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

LGTM

@gs-olive gs-olive merged commit 4a920a1 into main Oct 10, 2023
@gs-olive gs-olive deleted the torch_compile_additional_documentation branch October 10, 2023 22:22
gs-olive added a commit that referenced this pull request Oct 10, 2023
@gs-olive
docs: Add documentation of torch.compile backend usage (#2363)
69fbf6e
@gs-olive gs-olive mentioned this pull request Oct 10, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@narendasan narendasan narendasan approved these changes

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

@peri044 peri044 Awaiting requested review from peri044

Assignees

@gs-olive gs-olive

Labels

cla signed component: api [Python] Issues re: Python API component: dynamo Issues relating to the `torch.compile` or `torch._dynamo.export` paths documentation Improvements or additions to documentation priority: high

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add documentation in user guide on torch.compile usage

4 participants

@gs-olive @narendasan @facebook-github-bot