Skip to content

Commit d53a6cb

Browse files
committed
Update top-level README.md to reflect current state
1 parent 50d1da2 commit d53a6cb

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

+27-15
Original file line numberDiff line numberDiff line change
@@ -37,47 +37,59 @@ We recommend using the latest release tag from the
3737
executorch
3838
├── backends # Backend delegate implementations.
3939
├── build # Utilities for managing the build system.
40-
├── bundled_program # Utilities for attaching reference inputs and outputs to models.
4140
├── codegen # Tooling to autogenerate bindings between kernels and the runtime.
4241
├── configurations
43-
├── docs # Static docs tooling
42+
├── docs # Static docs tooling.
4443
├── examples # Examples of various user flows, such as model export, delegates, and runtime execution.
45-
├── exir # Ahead of time library, model capture and lowering apis.
44+
├── exir # Ahead-of-time library: model capture and lowering APIs.
4645
| ├── _serialize # Serialize final export artifact.
4746
| ├── backend # Backend delegate ahead of time APIs
4847
| ├── capture # Program capture.
4948
| ├── dialects # Op sets for various dialects in the export process.
5049
| ├── emit # Conversion from ExportedProgram to ExecuTorch execution instructions.
50+
| ├── operator # Operator node manipulation utilities.
5151
| ├── passes # Built-in compiler passes.
5252
| ├── program # Export artifacts.
53+
| ├── serde # Graph module
54+
serialization/deserialization.
5355
| ├── verification # IR verification.
5456
├── extension # Extensions built on top of the runtime.
55-
| ├── aten_util
57+
| ├── android # ExecuTorch wrappers for Android apps.
58+
| ├── apple # ExecuTorch wrappers for iOS apps.
59+
| ├── aten_util # Converts to and from PyTorch ATen types.
5660
| ├── data_loader # 1st party data loader implementations.
61+
| ├── evalue_util # Helpers for working with EValue objects.
62+
| ├── gguf_util # Tools to convert from the GGUF format.
63+
| ├── kernel_util # Helpers for registering kernels.
5764
| ├── memory_allocator # 1st party memory allocator implementations.
58-
| ├── pybindings # Python api for executorch runtime.
65+
| ├── module # A simplified C++ wrapper for the runtime.
66+
| ├── parallel # C++ threadpool integration.
67+
| ├── pybindings # Python API for executorch runtime.
5968
| ├── pytree # C++ and Python flattening and unflattening lib for pytrees.
60-
| ├── testing_util
69+
| ├── runner_util # Helpers for writing C++ PTE-execution
70+
tools.
71+
| ├── testing_util # Helpers for writing C++ tests.
6172
├── kernels # 1st party kernel implementations.
6273
| ├── aten
6374
| ├── optimized
6475
| ├── portable # Reference implementations of ATen operators.
6576
| ├── prim_ops # Special ops used in executorch runtime for control flow and symbolic primitives.
6677
| ├── quantized
67-
├── profiler # Utilities for profiling.
68-
├── runtime # Core cpp runtime
69-
| ├── backend # Backend delegate runtime APIs
70-
| ├── core # Core structures used across all levels of the runtime
78+
├── profiler # Utilities for profiling runtime execution.
79+
├── runtime # Core C++ runtime.
80+
| ├── backend # Backend delegate runtime APIs.
81+
| ├── core # Core structures used across all levels of the runtime.
7182
| ├── executor # Model loading, initalization, and execution.
7283
| ├── kernel # Kernel registration and management.
73-
| ├── platform # Layer between architecture specific code and user calls.
74-
├── schema # ExecuTorch program definition
84+
| ├── platform # Layer between architecture specific code and portable C++.
85+
├── schema # ExecuTorch PTE file format flatbuffer
86+
schemas.
7587
├── scripts # Utility scripts for size management, dependency management, etc.
7688
├── sdk # Model profiling, debugging, and introspection.
7789
├── shim # Compatibility layer between OSS and Internal builds
78-
├── test # Broad scoped end2end tests
79-
├── third-party # Third-party dependencies
80-
├── util
90+
├── test # Broad scoped end-to-end tests.
91+
├── third-party # Third-party dependencies.
92+
├── util # Various helpers and scripts.
8193
```
8294

8395
## License

0 commit comments

Comments
 (0)