You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
├── <ahref="tools">tools</a> - Tools for building ExecuTorch from source, for different built tools (CMake, Buck).
@@ -103,6 +102,8 @@ executorch
103
102
## Contributing workflow
104
103
We actively welcome your pull requests (PRs).
105
104
105
+
If you're completely new to open-source projects, GitHub, or ExecuTorch, please see our [New Contributor Guide](./docs/source/new-contributor-guide.md) for a step-by-step walkthrough on making your first contribution. Otherwise, read on.
106
+
106
107
1.[Claim an issue](#claiming-issues), if present, before starting work. If an
107
108
issue doesn't cover the work you plan to do, consider creating one to provide
108
109
context about it, and to build consensus about the scope and solution.
@@ -192,9 +193,6 @@ in the Github repo.
192
193
193
194
## Coding Style
194
195
195
-
Goal: Encourage standards that make it easier to read, edit, maintain, and debug
196
-
the ExecuTorch code.
197
-
198
196
### lintrunner
199
197
200
198
We use [`lintrunner`](https://pypi.org/project/lintrunner/) to help make sure the
@@ -259,7 +257,7 @@ toolchains, and having access to relatively modern C++ features.
259
257
260
258
#### C/C++ standard library usage
261
259
262
-
**Restricted usage of the C++ standard library.**
260
+
**Restricted usage of the C++ standard library**
263
261
264
262
Rationale: ExecuTorch is intended to be portable to bare-metal systems that lack
265
263
certain features, like dynamic memory, threading, and locking, required by parts
@@ -280,7 +278,7 @@ careful to also manually destroy objects initialized in this way.
280
278
281
279
#### C++ language features
282
280
283
-
**Exceptions: Do not use.**
281
+
**Exceptions: Do not use**
284
282
- Rationale: Exceptions are not widely supported on some classes of
285
283
microcontrollers and DSPs, and they can significantly increase binary size.
286
284
@@ -289,12 +287,12 @@ must work with threading**
289
287
- Rationale: The core runtime must work on systems that do not have threading
290
288
support.
291
289
292
-
**RTTI, dynamic_cast, and `<typeid>`: Do not use.**
290
+
**RTTI, dynamic_cast, and `<typeid>`: Do not use**
293
291
- Rationale: RTTI adds extra data to every virtual class. ExecuTorch doesn't
294
292
have a strong need for `dynamic_cast` and friends, so it's better to reduce
295
293
the binary size.
296
294
297
-
**Templates and template metaprogramming: Be careful and avoid if possible.**
295
+
**Templates and template metaprogramming: Be careful and avoid if possible**
298
296
- Rationale: Most templating results in code generation, and is one of the most
299
297
common sources of binary bloat. Some use of templates is fine (e.g. an
300
298
`ArrayRef<T>`, or code that handles multiple `ScalarType` types), but for the
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,9 +49,9 @@ Key value propositions of ExecuTorch are:
49
49
## Getting Started
50
50
To get started you can:
51
51
52
-
- 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
52
+
- 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
53
53
- 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
54
-
- Jump straight into LLMs use cases by following specific instructions for [Llama](./examples/models/llama/README.md) and [Llava](./examples/models/llava/README.md)
54
+
- Jump straight into LLM use cases by following specific instructions for [Llama](./examples/models/llama/README.md) and [Llava](./examples/models/llava/README.md)
0 commit comments