From 7d9258dac6be0baf5dcb8a22c0e4f0501ae8ec5e Mon Sep 17 00:00:00 2001 From: Kimish Patel Date: Wed, 9 Apr 2025 20:32:04 -0700 Subject: [PATCH] [pytorch/executorch][diff_train] Typo updates for README and Contributions (#10025) ### Summary Pulling in the non 0.6 changes from: https://github.com/pytorch/executorch/pull/10006 https://github.com/pytorch/executorch/pull/10016 ### Test plan md Internal: << DO NOT EDIT BELOW THIS LINE >> **GitHub Author**: Jack-Khuu (Meta Employee) **GitHub Repo**: [pytorch/executorch](https://github.com/pytorch/executorch) **GitHub Pull Request**: [#10025](https://github.com/pytorch/executorch/pull/10025) Initially generated by: https://www.internalfb.com/intern/sandcastle/job/9007201034847118/ This was imported as part of a Diff Train. Please review this as soon as possible. Since it is a direct copy of a commit on GitHub, there shouldn't be much to do. diff-train-source-id: 4bd7798263fb1c9453c493793c95a0a7cbf424f9 Differential Revision: [D72750049](https://our.internmc.facebook.com/intern/diff/D72750049/) [ghstack-poisoned] --- CONTRIBUTING.md | 16 ++++++---------- README.md | 4 ++-- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82076c2727d..801375b589b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,6 @@ Thank you for your interest in contributing to ExecuTorch! We want to make it easy to contribute to this project. -  ## Dev Install @@ -91,7 +90,7 @@ executorch │ └── platform - Layer between architecture specific code and portable C++. ├── schema - ExecuTorch PTE file format flatbuffer schemas. ├── scripts - Utility scripts for building libs, size management, dependency management, etc. -├── shim - Compatibility layer between OSS and Internal builds. +├── shim_et - Compatibility layer between OSS and Internal builds. ├── test - Broad scoped end-to-end tests. ├── third-party - Third-party dependencies. ├── tools - Tools for building ExecuTorch from source, for different built tools (CMake, Buck). @@ -192,9 +191,6 @@ in the Github repo. ## Coding Style -Goal: Encourage standards that make it easier to read, edit, maintain, and debug -the ExecuTorch code. - ### lintrunner We use [`lintrunner`](https://pypi.org/project/lintrunner/) to help make sure the @@ -259,7 +255,7 @@ toolchains, and having access to relatively modern C++ features. #### C/C++ standard library usage -**Restricted usage of the C++ standard library.** +**Restricted usage of the C++ standard library** Rationale: ExecuTorch is intended to be portable to bare-metal systems that lack certain features, like dynamic memory, threading, and locking, required by parts @@ -280,7 +276,7 @@ careful to also manually destroy objects initialized in this way. #### C++ language features -**Exceptions: Do not use.** +**Exceptions: Do not use** - Rationale: Exceptions are not widely supported on some classes of microcontrollers and DSPs, and they can significantly increase binary size. @@ -289,12 +285,12 @@ must work with threading** - Rationale: The core runtime must work on systems that do not have threading support. -**RTTI, dynamic_cast, and ``: Do not use.** +**RTTI, dynamic_cast, and ``: Do not use** - Rationale: RTTI adds extra data to every virtual class. ExecuTorch doesn't have a strong need for `dynamic_cast` and friends, so it's better to reduce the binary size. -**Templates and template metaprogramming: Be careful and avoid if possible.** +**Templates and template metaprogramming: Be careful and avoid if possible** - Rationale: Most templating results in code generation, and is one of the most common sources of binary bloat. Some use of templates is fine (e.g. an `ArrayRef`, or code that handles multiple `ScalarType` types), but for the @@ -359,7 +355,7 @@ docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/ for basics. 1. Push your branch to your fork of `pytorch/executorch`. Most people do not - have permission to push a branch directoy to the upstream repo. + have permission to push a branch directory to the upstream repo. 1. Create your PR - Use the `main` branch as the base. - Give the PR a clear and descriptive title. It will become the title of the diff --git a/README.md b/README.md index d60220bae85..025a8780739 100644 --- a/README.md +++ b/README.md @@ -49,9 +49,9 @@ Key value propositions of ExecuTorch are: ## Getting Started To get started you can: -- Visit the [Step by Step Tutorial](https://pytorch.org/executorch/main/index.html) on getting things running locally and deploy a model to a device +- Visit the [Step by Step Tutorial](https://pytorch.org/executorch/main/index.html) to get things running locally and deploy a model to a device - Use this [Colab Notebook](https://pytorch.org/executorch/stable/getting-started-setup.html#quick-setup-colab-jupyter-notebook-prototype) to start playing around right away -- Jump straight into LLMs use cases by following specific instructions for [Llama](./examples/models/llama/README.md) and [Llava](./examples/models/llava/README.md) +- Jump straight into LLM use cases by following specific instructions for [Llama](./examples/models/llama/README.md) and [Llava](./examples/models/llava/README.md) ## Feedback and Engagement