Skip to content

Commit e8cfee8

Browse files
committed
Address comments
Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:
1 parent 35f9e28 commit e8cfee8

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/source/runtime-pybind-api-reference.rst renamed to docs/source/runtime-python-api-reference.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
Runtime Pybind API Reference
1+
ExecuTorch Runtime Python API Reference
22
----------------------------------
3-
Pybind APIs can load a serialized .pte file (see `Export to ExecuTorch Tutorial <tutorials/export-to-executorch-tutorial.html>`__ for how to get .pte file from a PyTorch `nn.Module`) and execute it using `torch.Tensor` as inputs, in a Python environment. The result also comes back as `torch.Tensor` so it can be used as a quick way to validate the correctness of the program.
4-
3+
The Python ``executorch.runtime`` module wraps the C++ ExecuTorch runtime. It can load and execute serialized ``.pte`` program files: see the `Export to ExecuTorch Tutorial <tutorials/export-to-executorch-tutorial.html>`__ for how to convert a PyTorch ``nn.Module`` to an ExecuTorch ``.pte`` program file. Execution accepts and returns ``torch.Tensor`` values, making it a quick way to validate the correctness of the program.
54
For detailed information on how APIs evolve and the deprecation process, please refer to the `ExecuTorch API Life Cycle and Deprecation Policy <api-life-cycle.html>`__.
65

76
.. automodule:: executorch.runtime

runtime/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
"""Interface to the native C++ ExecuTorch runtime.
88
99
Example usage:
10+
1011
.. code-block:: text
1112
1213
from pathlib import Path
@@ -28,6 +29,7 @@
2829
print(f" outputs: {outputs}")
2930
3031
Example output:
32+
3133
.. code-block:: text
3234
3335
Program methods: ('forward', 'forward2')

0 commit comments

Comments
 (0)