Skip to content

[executorch][runtime] Add get_named_data_map to Program #8961

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

Merged
merged 3 commits into from
Mar 5, 2025

Conversation

pytorchbot
Copy link
Collaborator

This PR was created by the merge bot to help merge the original PR into the main branch.
ghstack PR number: #8853 by @lucylq
^ Please use this as the source of truth for the PR details, comments, and reviews
ghstack PR base: https://github.com/pytorch/executorch/tree/gh/lucylq/52/base
ghstack PR head: https://github.com/pytorch/executorch/tree/gh/lucylq/52/head
Merge bot PR base: https://github.com/pytorch/executorch/tree/gh/lucylq/53/orig
Merge bot PR head: https://github.com/pytorch/executorch/tree/gh/lucylq/52/orig
@diff-train-skip-merge

lucylq added 2 commits March 4, 2025 14:24
Pull Request resolved: #8887

PteDataMap is the NamedDataMap that will live in the runtime. It is used to give delegates access to opaque named data stored in the PTE file. Open to alternative naming suggestions, maybe 'PTEDataMap' or 'ProgramDataMap'?

**Usage**
The PteDataMap is owned by the program, and instantiated at program load time if named_data exists in the PTE file. We introduce usage of 'std::optional' here. I think we can also use executorch::aten::optional to avoid adding standard lib ?

When initializing delegates, the PteDataMap is given to delegate_init. Delegates can retrieve opaque delegate data by key using 'get_data'. This gives them a FreeableBuffer that they can free later.

**Testing**
This test uses the C++ flatbuffer API to build a fake program containing named data. We also creates a temp file with sample data that the data loader can wrap around.

TODO: e2e test once delegate aot is ready and we can generate a file with named data.

**Note**
As the PteDataMap wraps around flatbuffer constructs, the Program must outlive the PteDataMap.

PteDataMap does not implement
- get_metadata; currently, all data stored is opaque. Later, we can implement get_metadata if a backend stores plain tensor data.
- load_into; this is mostly used for the training case, and isn't used by delegates, at least not at the moment

Differential Revision: [D70213646](https://our.internmc.facebook.com/intern/diff/D70213646/)
ghstack-source-id: 269691307
Pull Request resolved: #8853

Add to the program interface, to allow users to retrieve the NDM.

Differential Revision: [D70276106](https://our.internmc.facebook.com/intern/diff/D70276106/)
ghstack-source-id: 269693108
Copy link

pytorch-bot bot commented Mar 5, 2025

🔗 Helpful Links

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

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

✅ No Failures

As of commit 5f1818e with merge base cca6917 (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 Mar 5, 2025
Base automatically changed from gh/lucylq/53/orig to main March 5, 2025 07:53
@lucylq lucylq added the release notes: runtime Changes related to the core runtime which loads the program methods, initializes delegates, and runs label Mar 5, 2025
@lucylq lucylq merged commit bb5d21c into main Mar 5, 2025
50 of 51 checks passed
@lucylq lucylq deleted the gh/lucylq/52/orig branch March 5, 2025 20:32
zonglinpeng pushed a commit that referenced this pull request Mar 6, 2025
* [executorch][runtime] Introduce PteDataMap for weight sharing

Pull Request resolved: #8887

PteDataMap is the NamedDataMap that will live in the runtime. It is used to give delegates access to opaque named data stored in the PTE file. Open to alternative naming suggestions, maybe 'PTEDataMap' or 'ProgramDataMap'?

**Usage**
The PteDataMap is owned by the program, and instantiated at program load time if named_data exists in the PTE file. We introduce usage of 'std::optional' here. I think we can also use executorch::aten::optional to avoid adding standard lib ?

When initializing delegates, the PteDataMap is given to delegate_init. Delegates can retrieve opaque delegate data by key using 'get_data'. This gives them a FreeableBuffer that they can free later.

**Testing**
This test uses the C++ flatbuffer API to build a fake program containing named data. We also creates a temp file with sample data that the data loader can wrap around.

TODO: e2e test once delegate aot is ready and we can generate a file with named data.

**Note**
As the PteDataMap wraps around flatbuffer constructs, the Program must outlive the PteDataMap.

PteDataMap does not implement
- get_metadata; currently, all data stored is opaque. Later, we can implement get_metadata if a backend stores plain tensor data.
- load_into; this is mostly used for the training case, and isn't used by delegates, at least not at the moment

Differential Revision: [D70213646](https://our.internmc.facebook.com/intern/diff/D70213646/)
ghstack-source-id: 269691307

* [executorch][runtime] Add get_named_data_map to Program

Pull Request resolved: #8853

Add to the program interface, to allow users to retrieve the NDM.

Differential Revision: [D70276106](https://our.internmc.facebook.com/intern/diff/D70276106/)
ghstack-source-id: 269693108

---------

Co-authored-by: lucylq <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. release notes: runtime Changes related to the core runtime which loads the program methods, initializes delegates, and runs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants