Skip to content

Commit

Permalink
Remove preview wording and TODOs from README
Browse files Browse the repository at this point in the history 
Refining the README.md to not include preview wording now that we are at alpha and also no TODO in the directory structure.
  • Loading branch information
@orionr @mergennachin
orionr authored and mergennachin committed Apr 26, 2024
1 parent e202eb7 commit 6d9f149
Showing 1 changed file with 12 additions and 17 deletions.
29 changes: 12 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,26 @@ Key value propositions of ExecuTorch are:
For a comprehensive technical overview of ExecuTorch and step-by-step tutorials,
please visit our [documentation website](https://pytorch.org/executorch).

## Important: This is a preview release
## Feedback

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

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

## Directory Structure

```
executorch
├── backends # Backend delegate implementations.
├── build # Utilities for managing the build system.
├── bundled_program # Utilities for attaching reference inputs and outputs to models. TODO move to extension
├── codegen # Tooling to autogenerate bindings between kernels and the runtime. TODO move to tool
├── configurations # TODO delete this
├── bundled_program # Utilities for attaching reference inputs and outputs to models.
├── codegen # Tooling to autogenerate bindings between kernels and the runtime.
├── configurations
├── docs # Static docs tooling
├── examples # Examples of various user flows, such as model export, delegates, and runtime execution.
├── exir # Ahead of time library, model capture and lowering apis.
Expand All @@ -69,20 +64,20 @@ executorch
| ├── portable # Reference implementations of ATen operators.
| ├── prim_ops # Special ops used in executorch runtime for control flow and symbolic primitives.
| ├── quantized
├── profiler # Utilities for profiling. TODO delete in favor of ETDump in sdk/
├── runtime # core cpp runtime of executorch
├── profiler # Utilities for profiling.
├── runtime # Core cpp runtime
| ├── backend # Backend delegate runtime APIs
| ├── core # Core structures used across all levels of the runtime
| ├── executor # Model loading, initalization, and execution.
| ├── kernel # Kernel registration and management.
| ├── platform # Layer between architecture specific code and user calls.
├── schema # ExecuTorch program definition, TODO move under serialization/
├── schema # ExecuTorch program definition
├── scripts # Utility scripts for size management, dependency management, etc.
├── sdk # Model profiling, debugging, and introspection.
├── shim # Compatibility layer between OSS and Internal builds
├── test # Broad scoped end2end tests
├── third-party # third-party dependencies
├── util # TODO delete this
├── third-party # Third-party dependencies
├── util
```

## License
Expand Down

0 comments on commit 6d9f149

Please sign in to comment.