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.

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

Update and fix docs (namespaces, consistency) #6084

Closed
wants to merge 1 commit into from
Closed

Update and fix docs (namespaces, consistency) #6084

wants to merge 1 commit into from
+167 −160

Conversation

dbort
Copy link
Contributor

@dbort dbort commented Oct 10, 2024 •
edited
Loading

Summary:
Audit all instances of \bexec_aten:: and \btorch:: under docs/, updating where appropriate.

The only remaining torch:: instances are for kernels, which I didn't get a chance to migrate before v0.4.0.

Also:

  • Update the LLM Manual code to be consistent between the doc and main.cpp
  • Fix some LLM Manual issues: point to the latest release, and "main.cpp" instead of "main.h"

Differential Revision: D64152344

@pytorch-bot PyTorch Bot
Copy link

pytorch-bot bot commented Oct 10, 2024 •
edited
Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/6084

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 42a4d55 with merge base 61c501c (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 10, 2024
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D64152344

@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D64152344

dbort added a commit to dbort/executorch that referenced this pull request Oct 10, 2024
@dbort @facebook-github-bot
Update docs to stop referring to old namespaces (pytorch#6084)
560872c 
Summary:

Audit all instances of `\bexec_aten::` and `\btorch::` under `docs/`, updating where appropriate.

The only remaining `torch::` instances are for kernels, which I didn't get a chance to migrate before v0.4.0.

Also update the LLM Manual code to be consistent between the doc and main.cpp.

Differential Revision: D64152344
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D64152344

malfet
malfet approved these changes Oct 10, 2024
View reviewed changes
Copy link
Contributor

@malfet malfet left a comment

Choose a reason for hiding this comment

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

This PR contains a lots of changes unrelated to the title. If they must be landed together, please update the description

examples/llm_manual/main.cpp Show resolved Hide resolved
docs/source/running-a-model-cpp-tutorial.md Show resolved Hide resolved
docs/source/running-a-model-cpp-tutorial.md Show resolved Hide resolved
docs/source/running-a-model-cpp-tutorial.md Show resolved Hide resolved
docs/source/running-a-model-cpp-tutorial.md Show resolved Hide resolved
docs/source/llm/getting-started.md Show resolved Hide resolved
@dbort
Copy link
Contributor Author

dbort commented Oct 11, 2024

@malfet I mention it in the summary as "Also update the LLM Manual code to be consistent between the doc and main.cpp." Basically I had to update the namespaces in both main.cpp and in the doc that includes snippets of main.cpp, but noticed that they're different. I reformatted them and made them consistent as part of this.

dbort added a commit to dbort/executorch that referenced this pull request Oct 11, 2024
@dbort @facebook-github-bot
Update docs to stop referring to old namespaces (pytorch#6084)
0bcf75f 
Summary:

Audit all instances of `\bexec_aten::` and `\btorch::` under `docs/`, updating where appropriate.

The only remaining `torch::` instances are for kernels, which I didn't get a chance to migrate before v0.4.0.

Also update the LLM Manual code to be consistent between the doc and main.cpp.

Reviewed By: mergennachin

Differential Revision: D64152344
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D64152344

dbort added a commit to dbort/executorch that referenced this pull request Oct 11, 2024
@dbort @facebook-github-bot
Update docs to stop referring to old namespaces (pytorch#6084)
1e7be61 
Summary:

Audit all instances of `\bexec_aten::` and `\btorch::` under `docs/`, updating where appropriate.

The only remaining `torch::` instances are for kernels, which I didn't get a chance to migrate before v0.4.0.

Also update the LLM Manual code to be consistent between the doc and main.cpp.

Reviewed By: mergennachin

Differential Revision: D64152344
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D64152344

dbort added a commit to dbort/executorch that referenced this pull request Oct 11, 2024
@dbort @facebook-github-bot
Update and fix docs (namespaces, consistency) (pytorch#6084)
97a5da0 
Summary:

Audit all instances of `\bexec_aten::` and `\btorch::` under `docs/`, updating where appropriate.

The only remaining `torch::` instances are for kernels, which I didn't get a chance to migrate before v0.4.0.

Also:
- Update the LLM Manual code to be consistent between the doc and main.cpp
- Fix some LLM Manual issues: point to the latest release, and "main.cpp" instead of "main.h"

Reviewed By: mergennachin

Differential Revision: D64152344
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D64152344

@dbort dbort changed the title Update docs to stop referring to old namespaces Update and fix docs (namespaces, consistency) Oct 11, 2024
@dbort
Copy link
Contributor Author

dbort commented Oct 11, 2024

Updated title/description because the scope of this creeped further

@dbort @facebook-github-bot
Update and fix docs (namespaces, consistency) (pytorch#6084)
42a4d55 
Summary:

Audit all instances of `\bexec_aten::` and `\btorch::` under `docs/`, updating where appropriate.

The only remaining `torch::` instances are for kernels, which I didn't get a chance to migrate before v0.4.0.

Also:
- Update the LLM Manual code to be consistent between the doc and main.cpp
- Fix some LLM Manual issues: point to the latest release, and "main.cpp" instead of "main.h"

Reviewed By: mergennachin

Differential Revision: D64152344
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D64152344

@Olivia-liu Olivia-liu self-requested a review October 11, 2024 20:34
@facebook-github-bot
Copy link
Contributor

This pull request has been merged in 5512fe0.

@dbort dbort deleted the export-D64152344 branch October 12, 2024 00:18
@dbort
Copy link
Contributor Author

dbort commented Oct 12, 2024

@pytorchbot cherry-pick --onto release/0.4 -c docs

pytorchbot pushed a commit that referenced this pull request Oct 12, 2024
@dbort @pytorchbot
Update and fix docs (namespaces, consistency) (#6084)
bcb9cca 
Summary:
Pull Request resolved: #6084

Audit all instances of `\bexec_aten::` and `\btorch::` under `docs/`, updating where appropriate.

The only remaining `torch::` instances are for kernels, which I didn't get a chance to migrate before v0.4.0.

Also:
- Update the LLM Manual code to be consistent between the doc and main.cpp
- Fix some LLM Manual issues: point to the latest release, and "main.cpp" instead of "main.h"

Reviewed By: mergennachin, Gasoonjia, Olivia-liu

Differential Revision: D64152344

fbshipit-source-id: 2f6582429d5e3ef285b728350f937247996bb454
(cherry picked from commit 5512fe0)
@pytorchbot
Copy link
Collaborator

Cherry picking #6084

The cherry pick PR is at #6185 The following tracker issues are updated:

Details for Dev Infra team Raised by workflow job

@pytorchbot pytorchbot mentioned this pull request Oct 12, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@malfet malfet malfet approved these changes

@Olivia-liu Olivia-liu Olivia-liu approved these changes

Assignees
No one assigned
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. fb-exported Merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@dbort @facebook-github-bot @pytorchbot @malfet @Olivia-liu