Skip to content

Commit 0ac9f53

Browse files
JacobSzwejbkafacebook-github-bot
authored andcommitted
add exir-api-reference.rst (#457)
Summary: Pull Request resolved: #457 Reviewed By: svekars, angelayi Differential Revision: D49551799
1 parent 141fcf6 commit 0ac9f53

File tree

3 files changed

+47
-7
lines changed

3 files changed

+47
-7
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Export to ExecuTorch API Reference
2+
-------------
3+
4+
.. automodule:: exir
5+
.. autofunction:: to_edge
6+
7+
.. autoclass:: EdgeProgramManager
8+
9+
.. automethod:: methods
10+
.. automethod:: config_methods
11+
.. automethod:: exported_program
12+
.. automethod:: transform
13+
.. automethod:: to_backend
14+
.. automethod:: to_executorch
15+
16+
.. autoclass:: ExecutorchProgramManager
17+
18+
.. automethod:: methods
19+
.. automethod:: config_methods
20+
.. automethod:: exported_program
21+
.. automethod:: buffer
22+
.. automethod:: debug_handle_map
23+
.. automethod:: dump_executorch_program
24+
25+
26+
.. automodule:: exir.backend.backend_api
27+
.. autofunction:: to_backend
28+
29+
.. autoclass:: LoweredBackendModule
30+
31+
.. automethod:: backend_id
32+
.. automethod:: processed_bytes
33+
.. automethod:: compile_specs
34+
.. automethod:: original_module
35+
.. automethod:: buffer
36+
.. automethod:: program

docs/source/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,14 @@ Topics in this section will help you get started with ExecuTorch.
9393

9494
export-overview
9595

96+
.. toctree::
97+
:glob:
98+
:maxdepth: 1
99+
:caption: API Reference
100+
:hidden:
101+
102+
export-to-executorch-api-reference
103+
96104
.. toctree::
97105
:glob:
98106
:maxdepth: 1

exir/program/_program.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -571,15 +571,11 @@ def to_edge(
571571
aten dialect. Upon construction those programs are transformed into edge dialect.
572572
573573
Args:
574-
Can be a single ExportedProgram or a dictionary mapping function names
575-
to their corresponding ExportedPrograms. If only a single ExportedProgram is provided
576-
it will be assigned the name "forward".
574+
programs: Can be a single ExportedProgram or a dictionary mapping function names to their corresponding ExportedPrograms. If only a single ExportedProgram is provided it will be assigned the name "forward".
577575
578-
constant_methods: An optional dictionary of method name to the constant value returned
579-
by that method in eager mode. Often used to store config information on Edge models.
576+
constant_methods: An optional dictionary of method name to the constant value returned by that method in eager mode. Often used to store config information on Edge models.
580577
581-
compile_config: An optional argument used to provide greater control over
582-
the transformation to edge dialect process.
578+
compile_config: An optional argument used to provide greater control over the transformation to edge dialect process.
583579
"""
584580
config = compile_config or EdgeCompileConfig()
585581
if not isinstance(programs, dict):

0 commit comments

Comments
 (0)