Skip to content

[pytorch/executorch][diff_train] Typo updates for README and Contributions (#10025) #10052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[pytorch/executorch][diff_train] Typo updates for README and Contributions (#10025) #10052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -91,7 +90,7 @@ executorch
│ └── <a href="runtime/platform">platform</a> - Layer between architecture specific code and portable C++.
├── <a href="schema">schema</a> - ExecuTorch PTE file format flatbuffer schemas.
├── <a href="scripts">scripts</a> - Utility scripts for building libs, size management, dependency management, etc.
├── <a href="shim">shim</a> - Compatibility layer between OSS and Internal builds.
├── <a href="shim_et">shim_et</a> - Compatibility layer between OSS and Internal builds.
├── <a href="test">test</a> - Broad scoped end-to-end tests.
├── <a href="third-party">third-party</a> - Third-party dependencies.
├── <a href="tools">tools</a> - Tools for building ExecuTorch from source, for different built tools (CMake, Buck).
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -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 `<typeid>`: Do not use.**
**RTTI, dynamic_cast, and `<typeid>`: 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<T>`, or code that handles multiple `ScalarType` types), but for the
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading