Skip to content

Add pybindings for bpte and ptd file #14678

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

Merged
facebook-github-bot merged 1 commit into from
Oct 1, 2025
Merged

Add pybindings for bpte and ptd file #14678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 85 additions & 42 deletions extension/pybindings/pybindings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,24 @@ void setup_output_storage(
}
}

inline std::unique_ptr<DataLoader> loader_from_buffer(
const void* ptr,
size_t ptr_len) {
return std::make_unique<BufferDataLoader>(ptr, ptr_len);
}

inline std::unique_ptr<DataLoader> loader_from_file(const std::string& path) {
Result<MmapDataLoader> res = MmapDataLoader::from(
path.c_str(), MmapDataLoader::MlockConfig::UseMlockIgnoreErrors);
THROW_IF_ERROR(
res.error(),
"Failed to create MmapDataLoader from file %s, error: 0x:%" PRIx32,
path.c_str(),
static_cast<uint32_t>(res.error()));

return std::make_unique<MmapDataLoader>(std::move(res.get()));
}

inline std::unique_ptr<Module> load_module_from_buffer(
const void* ptr,
size_t ptr_len,
Expand All @@ -166,11 +184,11 @@ inline std::unique_ptr<Module> load_module_from_buffer(
std::unique_ptr<runtime::EventTracer> event_tracer,
Program::Verification program_verification) {
EXECUTORCH_SCOPE_PROF("load_module_from_buffer");
auto loader = std::make_unique<BufferDataLoader>(ptr, ptr_len);
auto loader = loader_from_buffer(ptr, ptr_len);

if (data_map_ptr.has_value() && data_map_len.has_value()) {
auto data_map_loader = std::make_unique<BufferDataLoader>(
data_map_ptr.value(), data_map_len.value());
auto data_map_loader =
loader_from_buffer(data_map_ptr.value(), data_map_len.value());
return std::make_unique<Module>(
std::move(loader),
nullptr, // memory_allocator
Expand All @@ -194,27 +212,9 @@ inline std::unique_ptr<Module> load_module_from_file(
Program::Verification program_verification) {
EXECUTORCH_SCOPE_PROF("load_module_from_file");

Result<MmapDataLoader> program_loader_res = MmapDataLoader::from(
program_path.c_str(), MmapDataLoader::MlockConfig::UseMlockIgnoreErrors);
THROW_IF_ERROR(
program_loader_res.error(),
"Failed to create MmapDataLoader from file %s, error: 0x:%" PRIx32,
program_path.c_str(),
static_cast<uint32_t>(program_loader_res.error()));
auto program_loader =
std::make_unique<MmapDataLoader>(std::move(program_loader_res.get()));

auto program_loader = loader_from_file(program_path);
if (data_map_path.has_value()) {
Result<MmapDataLoader> data_map_loader_res = MmapDataLoader::from(
data_map_path->c_str(),
MmapDataLoader::MlockConfig::UseMlockIgnoreErrors);
THROW_IF_ERROR(
data_map_loader_res.error(),
"Failed to create MmapDataLoader from file %s, error: 0x:%" PRIx32,
data_map_path->c_str(),
static_cast<uint32_t>(data_map_loader_res.error()));
auto data_map_loader =
std::make_unique<MmapDataLoader>(std::move(data_map_loader_res.get()));
auto data_map_loader = loader_from_file(data_map_path.value());
return std::make_unique<Module>(
std::move(program_loader),
nullptr, // memory_allocator
Expand All @@ -230,6 +230,22 @@ inline std::unique_ptr<Module> load_module_from_file(
nullptr); // data_map_loader
}

inline std::unique_ptr<Module> load_module_from_buffer_with_data_file(
const void* ptr,
size_t ptr_len,
const std::string& data_map_path,
std::unique_ptr<runtime::EventTracer> event_tracer,
Program::Verification program_verification) {
auto program_loader = loader_from_buffer(ptr, ptr_len);
auto data_loader = loader_from_file(data_map_path);
return std::make_unique<Module>(
std::move(program_loader),
nullptr, // memory_allocator
nullptr, // temp_allocator
std::move(event_tracer), // event_tracer
std::move(data_loader));
}

inline py::list get_outputs_as_py_list(
const std::vector<EValue>& outputs,
bool clone_outputs = true) {
Expand Down Expand Up @@ -555,6 +571,22 @@ struct PyModule final {
setup_event_tracer(enable_etdump, debug_buffer_size),
program_verification)) {}

explicit PyModule(
const void* ptr,
size_t ptr_len,
const std::string& data_path,
bool enable_etdump,
size_t debug_buffer_size = 0,
Program::Verification program_verification =
Program::Verification::InternalConsistency)
: debug_buffer_size_(debug_buffer_size),
module_(load_module_from_buffer_with_data_file(
ptr,
ptr_len,
data_path,
setup_event_tracer(enable_etdump, debug_buffer_size),
program_verification)) {}

explicit PyModule(
const std::string& program_path,
std::optional<const std::string>& data_path,
Expand Down Expand Up @@ -605,6 +637,7 @@ struct PyModule final {
program_verification);
}

// Load with data as a buffer.
static std::unique_ptr<PyModule> load_from_bundled_program(
PyBundledModule& m,
std::optional<const py::bytes> data_map_buffer,
Expand All @@ -628,6 +661,21 @@ struct PyModule final {
Program::Verification::InternalConsistency);
}

// Load with data as a file.
static std::unique_ptr<PyModule> load_from_bundled_program(
PyBundledModule& m,
const std::string& data_path,
bool enable_etdump,
size_t debug_buffer_size = 0) {
return std::make_unique<PyModule>(
m.get_program_ptr(),
m.get_program_len(),
data_path,
enable_etdump,
debug_buffer_size,
Program::Verification::InternalConsistency);
}

py::list run_method(
const std::string& method_name,
const py::sequence& inputs,
Expand Down Expand Up @@ -900,24 +948,6 @@ struct PyModule final {
}
};

inline std::unique_ptr<DataLoader> loader_from_buffer(
const void* ptr,
size_t ptr_len) {
return std::make_unique<BufferDataLoader>(ptr, ptr_len);
}

inline std::unique_ptr<DataLoader> loader_from_file(const std::string& path) {
Result<MmapDataLoader> res = MmapDataLoader::from(
path.c_str(), MmapDataLoader::MlockConfig::UseMlockIgnoreErrors);
THROW_IF_ERROR(
res.error(),
"Failed to create MmapDataLoader from file %s, error: 0x:%" PRIx32,
path.c_str(),
static_cast<uint32_t>(res.error()));

return std::make_unique<MmapDataLoader>(std::move(res.get()));
}

inline std::shared_ptr<ProgramState> load_program(
std::unique_ptr<DataLoader> loader,
Program::Verification program_verification) {
Expand Down Expand Up @@ -1474,12 +1504,25 @@ PYBIND11_MODULE(EXECUTORCH_PYTHON_MODULE_NAME, m) {
call_guard);
m.def(
"_load_for_executorch_from_bundled_program",
&PyModule::load_from_bundled_program,
py::overload_cast<
PyBundledModule&,
std::optional<const py::bytes>,
bool,
size_t>(&PyModule::load_from_bundled_program),
py::arg("ptr"),
py::arg("data_map_buffer") = std::nullopt,
py::arg("enable_etdump") = false,
py::arg("debug_buffer_size") = 0,
call_guard);
m.def(
"_load_for_executorch_from_bundled_program",
py::overload_cast<PyBundledModule&, const std::string&, bool, size_t>(
&PyModule::load_from_bundled_program),
py::arg("ptr"),
py::arg("data_path"),
py::arg("enable_etdump") = false,
py::arg("debug_buffer_size") = 0,
call_guard);
m.def(
"_load_bundled_program_from_buffer",
&PyBundledModule::load_from_buffer,
Expand Down
19 changes: 18 additions & 1 deletion extension/pybindings/test/test_pybindings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,7 +701,7 @@ def test_program_data_separation(self) -> None:
bundled_buffer = serialize_from_bundled_program_to_flatbuffer(bundled_program)
bundled_module = self.runtime._load_bundled_program_from_buffer(bundled_buffer)

# Load module from bundled program with external data
# Load module from bundled program with external data buffer
executorch_module_bundled = (
self.runtime._load_for_executorch_from_bundled_program(
bundled_module, data_buffer
Expand All @@ -710,6 +710,23 @@ def test_program_data_separation(self) -> None:
executorch_output_bundled = executorch_module_bundled.forward(inputs)[0]
self.assertTrue(torch.allclose(expected, executorch_output_bundled))

# Load module from bundled program with external data file
with tempfile.TemporaryDirectory() as tmpdir:
ptd_file = os.path.join(tmpdir, "linear.ptd")
with open(ptd_file, "wb") as ptd:
ptd.write(data_buffer)
executorch_module_bundled_data_file = (
self.runtime._load_for_executorch_from_bundled_program(
bundled_module, ptd_file
)
)
executorch_output_bundled_data_file = (
executorch_module_bundled_data_file.forward(inputs)[0]
)
self.assertTrue(
torch.allclose(expected, executorch_output_bundled_data_file)
)

# Test 6: Bundled program without external data should fail
executorch_module_bundled_no_data = (
self.runtime._load_for_executorch_from_bundled_program(bundled_module)
Expand Down
Loading