Skip to content

Commit f3c5695

Browse files
orionrfacebook-github-bot
authored andcommitted
Remove preview wording and TODOs from README (#3374)
Summary: Refining the README.md to not include preview wording now that we are at alpha and also no TODO in the directory structure. Pull Request resolved: #3374 Reviewed By: dbort Differential Revision: D56646127 Pulled By: orionr fbshipit-source-id: 49516e545bc5292d8fbf17060660a88f68c52c6e
1 parent f9b2415 commit f3c5695

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,26 @@ Key value propositions of ExecuTorch are:
2020
For a comprehensive technical overview of ExecuTorch and step-by-step tutorials,
2121
please visit our documentation website [for the latest release](https://pytorch.org/executorch/stable/index.html) (or the [main branch](https://pytorch.org/executorch/main/index.html)).
2222

23-
## Important: This is a preview release
23+
## Feedback
2424

25-
This is a preview version of ExecuTorch and should be used for testing and
26-
evaluation purposes only. It is not recommended for use in production settings.
2725
We welcome any feedback, suggestions, and bug reports from the community to help
28-
us improve the technology. Please use the [PyTorch
26+
us improve our technology. Please use the [PyTorch
2927
Forums](https://discuss.pytorch.org/c/executorch) for discussion and feedback
3028
about ExecuTorch using the **ExecuTorch** category, and our [GitHub
3129
repository](https://github.com/pytorch/executorch/issues) for bug reporting.
3230

33-
The ExecuTorch code and APIs are still changing quickly, and there are not yet
34-
any guarantees about forward/backward source compatibility. We recommend using
35-
the latest `v#.#.#` release tag from the
36-
[Releases](https://github.com/pytorch/executorch/releases) page when
37-
experimenting with this preview release.
31+
We recommend using the latest release tag from the
32+
[Releases](https://github.com/pytorch/executorch/releases) page when developing.
3833

3934
## Directory Structure
4035

4136
```
4237
executorch
4338
├── backends # Backend delegate implementations.
4439
├── build # Utilities for managing the build system.
45-
├── bundled_program # Utilities for attaching reference inputs and outputs to models. TODO move to extension
46-
├── codegen # Tooling to autogenerate bindings between kernels and the runtime. TODO move to tool
47-
├── configurations # TODO delete this
40+
├── bundled_program # Utilities for attaching reference inputs and outputs to models.
41+
├── codegen # Tooling to autogenerate bindings between kernels and the runtime.
42+
├── configurations
4843
├── docs # Static docs tooling
4944
├── examples # Examples of various user flows, such as model export, delegates, and runtime execution.
5045
├── exir # Ahead of time library, model capture and lowering apis.
@@ -69,20 +64,20 @@ executorch
6964
| ├── portable # Reference implementations of ATen operators.
7065
| ├── prim_ops # Special ops used in executorch runtime for control flow and symbolic primitives.
7166
| ├── quantized
72-
├── profiler # Utilities for profiling. TODO delete in favor of ETDump in sdk/
73-
├── runtime # core cpp runtime of executorch
67+
├── profiler # Utilities for profiling.
68+
├── runtime # Core cpp runtime
7469
| ├── backend # Backend delegate runtime APIs
7570
| ├── core # Core structures used across all levels of the runtime
7671
| ├── executor # Model loading, initalization, and execution.
7772
| ├── kernel # Kernel registration and management.
7873
| ├── platform # Layer between architecture specific code and user calls.
79-
├── schema # ExecuTorch program definition, TODO move under serialization/
74+
├── schema # ExecuTorch program definition
8075
├── scripts # Utility scripts for size management, dependency management, etc.
8176
├── sdk # Model profiling, debugging, and introspection.
8277
├── shim # Compatibility layer between OSS and Internal builds
8378
├── test # Broad scoped end2end tests
84-
├── third-party # third-party dependencies
85-
├── util # TODO delete this
79+
├── third-party # Third-party dependencies
80+
├── util
8681
```
8782

8883
## License

0 commit comments

Comments
 (0)