Skip to content

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

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 2 commits into from
Mar 5, 2025

Conversation

lucylq
Copy link
Contributor

@lucylq lucylq commented Feb 28, 2025

Stack from ghstack (oldest at bottom):

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

Differential Revision: D70276106

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

Differential Revision: [D70276106](https://our.internmc.facebook.com/intern/diff/D70276106/)

[ghstack-poisoned]
lucylq added a commit that referenced this pull request Feb 28, 2025
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: 269083551
Pull Request resolved: #8853
Copy link

pytorch-bot bot commented Feb 28, 2025

🔗 Helpful Links

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

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

✅ No Failures

As of commit 813a1ff with merge base 2ee3ffa (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 Feb 28, 2025
@facebook-github-bot
Copy link
Contributor

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

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

Differential Revision: [D70276106](https://our.internmc.facebook.com/intern/diff/D70276106/)

[ghstack-poisoned]
@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 1ae93b4 into gh/lucylq/52/base Mar 5, 2025
48 of 49 checks passed
@lucylq lucylq deleted the gh/lucylq/52/head branch March 5, 2025 07:38
@lucylq lucylq temporarily deployed to cherry-pick-bot March 5, 2025 07:38 — with GitHub Actions Inactive
lucylq added a commit that referenced this pull request Mar 5, 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 <lfq@meta.com>
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 <lfq@meta.com>
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.

None yet

3 participants