[pybind] Find portable_lib.so in pip package during cmake build #5961

larryliu0820 · 2024-10-07T23:39:31Z

Rename _portable_lib.cpython-3.<distribution info>.so to _portable_lib.so so it can be found by CMake find_library(). This can be achieved by setting SETUPTOOLS_EXT_SUFFIX.
Since executorch-config.cmake is also being used to find installed libraries such as executorch.a, xnnpack_backend.a, add a condition to tell if executorch-config.cmake is being used in cmake-out or site-packages.

* Rename `_portable_lib.cpython-3.<distribution info>.so` to `_portable_lib.so` so it can be found by CMake `find_library()`. This can be achieved by setting `SETUPTOOLS_EXT_SUFFIX`. * Since `executorch-config.cmake` is also being used to find installed libraries such as `executorch.a`, `xnnpack_backend.a`, add a condition to tell if `executorch-config.cmake` is being used in cmake-out or site-packages.

pytorch-bot · 2024-10-07T23:39:34Z

🔗 Helpful Links

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

📄 Preview Python docs built from this PR

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

✅ You can merge normally! (2 Unrelated Failures)

As of commit 701c1b1 with merge base 0a11e99 ():

UNSTABLE - The following jobs failed but were likely due to flakiness present on trunk and has been marked as unstable:

Build Linux Wheels / pytorch/executorch / upload / manywheel-py3_9-cpu (gh) (#4308)
##[error]Unable to find any artifacts for the associated workflow
Build M1 Wheels / pytorch/executorch / upload / wheel-py3_9-cpu (gh) (#4309)
##[error]Unable to find any artifacts for the associated workflow

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

facebook-github-bot · 2024-10-07T23:41:08Z

@larryliu0820 has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

build/packaging/env_var_script_m1.sh

setup.py

build/executorch-config.cmake

dbort · 2024-10-07T23:56:56Z

build/executorch-config.cmake

+set(EXECUTORCH_LIBRARIES)
+if(_portable_lib_LIBRARY)
+  # Assuming current file is <site-packages>/executorch/executorch-config.cmake
+  message(WARNING "portable library is found")


Most of these should use STATUS instead of WARNING since they're just informational

build/executorch-config.cmake

facebook-github-bot · 2024-10-08T00:40:31Z

@larryliu0820 merged this pull request in 7337f8e.

Addressing comments in #5961. * Separate out `executorch-wheel-config.cmake` from `executorch-config.cmake`. * Hardcode the envrionment variable `SETUPTOOLS_EXT_SUFFIX` in `setup.py`.

Summary: Addressing comments in #5961. * Separate out `executorch-wheel-config.cmake` from `executorch-config.cmake`. * Hardcode the envrionment variable `SETUPTOOLS_EXT_SUFFIX` in `setup.py`. Pull Request resolved: #5965 Reviewed By: dbort Differential Revision: D64017947 Pulled By: larryliu0820 fbshipit-source-id: 0bdff5e2d2ec5873540d1b701595c7a316e84e80

larryliu0820 · 2024-10-10T21:59:01Z

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

Summary: * Rename `_portable_lib.cpython-3.<distribution info>.so` to `_portable_lib.so` so it can be found by CMake `find_library()`. This can be achieved by setting `SETUPTOOLS_EXT_SUFFIX`. * Since `executorch-config.cmake` is also being used to find installed libraries such as `executorch.a`, `xnnpack_backend.a`, add a condition to tell if `executorch-config.cmake` is being used in cmake-out or site-packages. Pull Request resolved: #5961 Reviewed By: metascroy Differential Revision: D64014291 Pulled By: larryliu0820 fbshipit-source-id: 2757f2883d3f836e9efd45676f792c12f742e63d (cherry picked from commit 7337f8e)

pytorchbot · 2024-10-10T22:00:45Z

Cherry picking #5961

The cherry pick PR is at #6141 and it is recommended to link a critical cherry pick PR with an issue. The following tracker issues are updated:

[v0.4.0] Release Tracker #5366 (comment)

Details for Dev Infra team

Raised by workflow job

Summary: Addressing comments in #5961. * Separate out `executorch-wheel-config.cmake` from `executorch-config.cmake`. * Hardcode the envrionment variable `SETUPTOOLS_EXT_SUFFIX` in `setup.py`. Pull Request resolved: #5965 Reviewed By: dbort Differential Revision: D64017947 Pulled By: larryliu0820 fbshipit-source-id: 0bdff5e2d2ec5873540d1b701595c7a316e84e80 (cherry picked from commit 1327090)

Summary: * Rename `_portable_lib.cpython-3.<distribution info>.so` to `_portable_lib.so` so it can be found by CMake `find_library()`. This can be achieved by setting `SETUPTOOLS_EXT_SUFFIX`. * Since `executorch-config.cmake` is also being used to find installed libraries such as `executorch.a`, `xnnpack_backend.a`, add a condition to tell if `executorch-config.cmake` is being used in cmake-out or site-packages. Pull Request resolved: #5961 Reviewed By: metascroy Differential Revision: D64014291 Pulled By: larryliu0820 fbshipit-source-id: 2757f2883d3f836e9efd45676f792c12f742e63d

Summary: Addressing comments in #5961. * Separate out `executorch-wheel-config.cmake` from `executorch-config.cmake`. * Hardcode the envrionment variable `SETUPTOOLS_EXT_SUFFIX` in `setup.py`. Pull Request resolved: #5965 Reviewed By: dbort Differential Revision: D64017947 Pulled By: larryliu0820 fbshipit-source-id: 0bdff5e2d2ec5873540d1b701595c7a316e84e80

Summary: * Rename `_portable_lib.cpython-3.<distribution info>.so` to `_portable_lib.so` so it can be found by CMake `find_library()`. This can be achieved by setting `SETUPTOOLS_EXT_SUFFIX`. * Since `executorch-config.cmake` is also being used to find installed libraries such as `executorch.a`, `xnnpack_backend.a`, add a condition to tell if `executorch-config.cmake` is being used in cmake-out or site-packages. Pull Request resolved: #5961 Reviewed By: metascroy Differential Revision: D64014291 Pulled By: larryliu0820 fbshipit-source-id: 2757f2883d3f836e9efd45676f792c12f742e63d

Summary: Addressing comments in #5961. * Separate out `executorch-wheel-config.cmake` from `executorch-config.cmake`. * Hardcode the envrionment variable `SETUPTOOLS_EXT_SUFFIX` in `setup.py`. Pull Request resolved: #5965 Reviewed By: dbort Differential Revision: D64017947 Pulled By: larryliu0820 fbshipit-source-id: 0bdff5e2d2ec5873540d1b701595c7a316e84e80

Summary: * Rename `_portable_lib.cpython-3.<distribution info>.so` to `_portable_lib.so` so it can be found by CMake `find_library()`. This can be achieved by setting `SETUPTOOLS_EXT_SUFFIX`. * Since `executorch-config.cmake` is also being used to find installed libraries such as `executorch.a`, `xnnpack_backend.a`, add a condition to tell if `executorch-config.cmake` is being used in cmake-out or site-packages. Pull Request resolved: #5961 Reviewed By: metascroy Differential Revision: D64014291 Pulled By: larryliu0820 fbshipit-source-id: 2757f2883d3f836e9efd45676f792c12f742e63d

Summary: Addressing comments in #5961. * Separate out `executorch-wheel-config.cmake` from `executorch-config.cmake`. * Hardcode the envrionment variable `SETUPTOOLS_EXT_SUFFIX` in `setup.py`. Pull Request resolved: #5965 Reviewed By: dbort Differential Revision: D64017947 Pulled By: larryliu0820 fbshipit-source-id: 0bdff5e2d2ec5873540d1b701595c7a316e84e80

* Add MethodMeta object for python visibility (#5571) Summary: Pull Request resolved: #5571 Some clients and consumers of the Executorch program files (.pte) were requesting ways to access metadata like the sizes of tensors and the number of bytes they needed. When I told them how to access them in C++, they requested Python wrappers since they had processing scripts written in Python. Add some implementations of MethodMeta and TensorInfo methods. Note that these become more expensive than in C++ because they need to allocate python objects, but I doubt these are used in performance-sensitive applications anyway. And dealing with lifetimes of mixed C++/Python objects is complex, so I favored simple lifetimes. Reviewed By: dbort Differential Revision: D63288433 fbshipit-source-id: af775120a8ebd9bf455671a8ce1f158259aa50e6 * Add mapping from C++ program::verification to Python (#5915) Summary: As titled. This enables `portable_lib._load_for_executorch[_from_buffer]` to accept `Program::Verification` argument. See added test, now we can do something like: ``` from executorch.extension.pybindings.portable_lib import Verification module = load_fn( exported_program.buffer, enable_etdump=False, debug_buffer_size=0, program_verification=Verification.Minimal, ) ``` Pull Request resolved: #5915 Test Plan: See unit test Reviewed By: dbort Differential Revision: D63987538 Pulled By: larryliu0820 fbshipit-source-id: b68d8d1149e2d46b90544679707f420179e72b19 * Find portable_lib.so in pip package during cmake build (#5961) Summary: * Rename `_portable_lib.cpython-3.<distribution info>.so` to `_portable_lib.so` so it can be found by CMake `find_library()`. This can be achieved by setting `SETUPTOOLS_EXT_SUFFIX`. * Since `executorch-config.cmake` is also being used to find installed libraries such as `executorch.a`, `xnnpack_backend.a`, add a condition to tell if `executorch-config.cmake` is being used in cmake-out or site-packages. Pull Request resolved: #5961 Reviewed By: metascroy Differential Revision: D64014291 Pulled By: larryliu0820 fbshipit-source-id: 2757f2883d3f836e9efd45676f792c12f742e63d * Improve pip package build (#5965) Summary: Addressing comments in #5961. * Separate out `executorch-wheel-config.cmake` from `executorch-config.cmake`. * Hardcode the envrionment variable `SETUPTOOLS_EXT_SUFFIX` in `setup.py`. Pull Request resolved: #5965 Reviewed By: dbort Differential Revision: D64017947 Pulled By: larryliu0820 fbshipit-source-id: 0bdff5e2d2ec5873540d1b701595c7a316e84e80 * Let find_package(executorch) find the correct include directory (#6102) Summary: There's a typo in `executorch-wheel-config.cmake` that points to the wrong `include` path: ``` <site-packages>/executorch/share/cmake/include ``` Where it actually should be ``` <site-packages>/executorch/include ``` Fixing this issue. Verified it on [build_torchao_ops.sh](https://github.com/pytorch/ao/blob/main/torchao/experimental/build_torchao_ops.sh) Pull Request resolved: #6102 Reviewed By: lucylq Differential Revision: D64189337 Pulled By: larryliu0820 fbshipit-source-id: 13033587f5499537623995b8f9457fb47d780340 * New Runtime pybind API (#6063) Summary: Based on this proposal: https://docs.google.com/document/d/10Q4-pt97inQQtFf-FjjwhMaDXXCfk1zGy6V6EkygNUY/edit#heading=h.fcrpnrtb6cud Historically our pybinding APIs are not following the same C++ modeling (Program, Method etc) and hence it's hard to use and easy to hit footguns - for example, if we load the program and return it from a python method, it goes out of the scope and releases the memory. This effort is to create Pybind APIs that resembles C++ objects so it's less confusing to the users. Add the following python classes: * `Runtime`: a singleton object hosting methods like `load_program`. Returns a `Program` object when calling `load_program`. Also exposes the operator registry * `Program`: each pte file should have one `Program` object. Most important method is `load_method` which returns a `Method` object. It has a property `method_names` where we can inspect what methods are inside this .pte file. * `Method`: one object per method name in a given `Program`. Exposes `execute` which takes in pytree flattened torch tensors as input and return pytree flattened output. It also exposes `MethodMeta` for users to inspect more information regarding input/output of this method. Pull Request resolved: #6063 Reviewed By: dbort Differential Revision: D64132360 Pulled By: larryliu0820 fbshipit-source-id: a2f35edc5fd8c200df0812a693e454d66d6a907e * Lint * Fix test_pybindings.py --------- Co-authored-by: Riley Dulin <[email protected]>

…wheel Summary: Initially our portable lib prebuilt library is named as: ``` _portable_lib.cpython-310-x86_64-linux-gnu.so ``` Where it includes an `EXT_SUFFIX` `cpython-310-x86_64-linux-gnu` consists of architecture and build OS information. This is enforced by `setuptools` following PEP 3149 and there's no good way to change this behavior. which is easier to be found by `find_package()` macro in CMake. However #5961 is breaking the other prebuilt libraries such as `libcustom_ops_aot_lib.so` which depends on the original `_portable_lib.cpython-310-x86_64-linux-gnu.so` name in its RPATH. This PR is a fix that reverts #5961 and restore the full name during packaging, but try to match the `EXT_SUFFIX` in CMake to be able to find the .so file. Test Plan: ```bash python -c "from executorch.extension.llm.custom_ops import sdpa_with_kv_cache" ``` Does not throw `_portable_lib.cpython-310-x86_64-linux-gnu.so` not found error. Reviewers: Subscribers: Tasks: Tags:

…#6363) Summary: Initially our portable lib prebuilt library is named as: ``` _portable_lib.cpython-310-x86_64-linux-gnu.so ``` Where it includes an `EXT_SUFFIX` `cpython-310-x86_64-linux-gnu` consists of architecture and build OS information. This is enforced by `setuptools` following PEP 3149 and there's no good way to change this behavior. #5961 was an attempt to rename the .so filename at **packaging** stage to `_portable_lib.so`, so that it is easier to be found by `find_package()` macro in CMake. However #5961 is breaking the other prebuilt libraries such as `libcustom_ops_aot_lib.so` which depends on the original `_portable_lib.cpython-310-x86_64-linux-gnu.so` name in its RPATH. This PR is a fix that reverts #5961 and restore the full name during packaging, but try to match the `EXT_SUFFIX` in CMake to be able to find the .so file. Pull Request resolved: #6363 Test Plan: ```bash EXECUTORCH_BUILD_PYBIND=ON python setup.py bdist_wheel # build wheel including _portable_lib.*.so pip install dist/executorch-0.5.0a0+7510f8c-cp310-cp310-linux_x86_64.whl python -c "from executorch.extension.llm.custom_ops import sdpa_with_kv_cache" # Run torchao script to make sure find_package() works push ao/torchao/experimental bash build_torchao_ops.sh executorch ``` Does not throw `_portable_lib.cpython-310-x86_64-linux-gnu.so` not found error. Reviewed By: kirklandsign Differential Revision: D64635137 Pulled By: larryliu0820 fbshipit-source-id: 7e54ea15361ae63acb8324538ea4982e95d6f07a

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 7, 2024

larryliu0820 requested review from dbort and metascroy October 7, 2024 23:39

metascroy approved these changes Oct 7, 2024

View reviewed changes

dbort requested changes Oct 8, 2024

View reviewed changes

facebook-github-bot closed this in 7337f8e Oct 8, 2024

facebook-github-bot added the Merged label Oct 8, 2024

larryliu0820 mentioned this pull request Oct 8, 2024

[pybind] Improve pip package build #5965

Closed

pytorchbot mentioned this pull request Oct 10, 2024

[v0.4.0] Release Tracker #5366

Closed

pytorchbot mentioned this pull request Oct 10, 2024

[pybind] Improve pip package build #6142

Closed

larryliu0820 mentioned this pull request Oct 11, 2024

Pick pybind #6151

Merged

larryliu0820 mentioned this pull request Oct 18, 2024

[pybind] Add back extension suffix for portable lib shared object in pip wheel #6363

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[pybind] Find portable_lib.so in pip package during cmake build #5961

[pybind] Find portable_lib.so in pip package during cmake build #5961

Uh oh!

larryliu0820 commented Oct 7, 2024

Uh oh!

pytorch-bot bot commented Oct 7, 2024 •

edited

Loading

Uh oh!

facebook-github-bot commented Oct 7, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dbort Oct 7, 2024

Uh oh!

Uh oh!

facebook-github-bot commented Oct 8, 2024

Uh oh!

larryliu0820 commented Oct 10, 2024

Uh oh!

pytorchbot commented Oct 10, 2024

Uh oh!

Uh oh!

[pybind] Find portable_lib.so in pip package during cmake build #5961

[pybind] Find portable_lib.so in pip package during cmake build #5961

Uh oh!

Conversation

larryliu0820 commented Oct 7, 2024

Uh oh!

pytorch-bot bot commented Oct 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

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

✅ You can merge normally! (2 Unrelated Failures)

Uh oh!

facebook-github-bot commented Oct 7, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dbort Oct 7, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

facebook-github-bot commented Oct 8, 2024

Uh oh!

larryliu0820 commented Oct 10, 2024

Uh oh!

pytorchbot commented Oct 10, 2024

Cherry picking #5961

Uh oh!

Uh oh!

pytorch-bot bot commented Oct 7, 2024 •

edited

Loading