Skip to content

update etdump doc for better clearance#16793

Merged
meta-codesync[bot] merged 1 commit intopytorch:mainfrom
Gasoonjia:export-D91245299
Jan 22, 2026
Merged

update etdump doc for better clearance#16793
meta-codesync[bot] merged 1 commit intopytorch:mainfrom
Gasoonjia:export-D91245299

Conversation

@Gasoonjia
Copy link
Copy Markdown
Contributor

@Gasoonjia Gasoonjia commented Jan 22, 2026

Summary:
Try to make etdump doc clearer.

more details can be found in #16571.

Differential Revision: D91245299

@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented Jan 22, 2026 •
edited
Loading

🔗 Helpful Links

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

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

❌ 1 New Failure, 1 Cancelled Job, 1 Unrelated Failure

As of commit b548e3e with merge base 9f6f828 (image):

NEW FAILURE - The following job has failed:

CANCELLED JOB - The following job was cancelled. Please retry:

FLAKY - The following job failed but was likely due to flakiness present on trunk:

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

@meta-codesync
Copy link
Copy Markdown
Contributor

meta-codesync Bot commented Jan 22, 2026

@Gasoonjia has exported this pull request. If you are a Meta employee, you can view the originating Diff in D91245299.

@meta-cla meta-cla 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 Jan 22, 2026
@Gasoonjia Gasoonjia mentioned this pull request Jan 22, 2026
Closed
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jan 22, 2026

This PR needs a release notes: label

If your change should be included in the release notes (i.e. would users of this library care about this change?), please use a label starting with release notes:. This helps us keep track and include your important work in the next release notes.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "release notes: none"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

GregoryComer
GregoryComer approved these changes Jan 22, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@GregoryComer GregoryComer left a comment

Choose a reason for hiding this comment

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

Thanks for adding this! It's very clear.

Comment thread docs/source/etdump.md Outdated

using namespace ::executorch::extension;

Module module("/path/to/model.pte", Module::LoadMode::MmapUseMlock, std::make_unique<ETDumpGen>());
Copy link
Copy Markdown
Member

@GregoryComer GregoryComer Jan 22, 2026

Choose a reason for hiding this comment

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

Tiny nit, feel free to ignore - Mlock mode tends to fail on a lot of hardware, so we should maybe recommend Mmap or File modes. For example, Android limits to 64kb on newer versions.

Copy link
Copy Markdown
Contributor Author

@Gasoonjia Gasoonjia Jan 22, 2026

Choose a reason for hiding this comment

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

thx. Updated to Mmap

@Gasoonjia @facebook-github-bot
update etdump doc for better clearance (pytorch#16793)
b548e3e 
Summary:

Try to make etdump doc clearer.

more details can be found in pytorch#16571.

Reviewed By: lucylq, GregoryComer

Differential Revision: D91245299
@meta-codesync meta-codesync Bot merged commit c0d948a into pytorch:main Jan 22, 2026
143 of 147 checks passed
@Gasoonjia
Copy link
Copy Markdown
Contributor Author

Gasoonjia commented Jan 22, 2026

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

pytorchbot pushed a commit that referenced this pull request Jan 22, 2026
@Gasoonjia @pytorchbot
update etdump doc for better clearance
075e035 
Differential Revision: D91245299

Pull Request resolved: #16793

(cherry picked from commit c0d948a)
@pytorchbot
Copy link
Copy Markdown
Collaborator

pytorchbot commented Jan 22, 2026

Cherry picking #16793

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

Details for Dev Infra team Raised by workflow job

@pytorchbot pytorchbot mentioned this pull request Jan 22, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GregoryComer GregoryComer GregoryComer approved these changes

@lucylq lucylq lucylq approved these changes

@mergennachin mergennachin Awaiting requested review from mergennachin mergennachin is a code owner

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 meta-exported

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Gasoonjia @pytorchbot @GregoryComer @lucylq