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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,10 @@ it easy to contribute to this project.
5
5
## Dev Install
6
6
7
7
Set up your environment by following the instructions at
8
-
https://pytorch.org/executorch/stable/getting-started-setup.html to clone
8
+
https://pytorch.org/executorch/main/getting-started-setup to clone
9
9
the repo and install the necessary requirements.
10
10
11
-
Refer to this [document](https://pytorch.org/executorch/main/using-executorch-building-from-source.html) to build ExecuTorch from source.
11
+
Refer to this [document](docs/source/using-executorch-building-from-source.md) to build ExecuTorch from source.
12
12
13
13
### Dev Setup for Android
14
14
For Android, please refer to the [Android documentation](docs/source/using-executorch-android.md).
@@ -40,8 +40,8 @@ executorch
40
40
├── <ahref="devtools">devtools</a> - Model profiling, debugging, and inspection. Please refer to the <ahref="docs/source/devtools-overview.md">tools documentation</a> for more information.
41
41
│ ├── <ahref="devtools/bundled_program">bundled_program</a> - a tool for validating ExecuTorch model. See <ahref="docs/source/bundled-io.md">doc</a>.
42
42
│ ├── <ahref="devtools/etdump">etdump</a> - ETDump - a format for saving profiling and debugging data from runtime. See <ahref="docs/source/etdump.md">doc</a>.
43
-
│ ├── <ahref="devtools/etrecord">etrecord</a> - ETRecord - AOT debug artifact for ExecuTorch. See <ahref="https://pytorch.org/executorch/main/etrecord.html">doc</a>.
44
-
│ ├── <ahref="devtools/inspector">inspector</a> - Python API to inspect ETDump and ETRecord. See <ahref="https://pytorch.org/executorch/main/model-inspector.html">doc</a>.
43
+
│ ├── <ahref="devtools/etrecord">etrecord</a> - ETRecord - AOT debug artifact for ExecuTorch. See <ahref="https://pytorch.org/executorch/main/etrecord">doc</a>.
44
+
│ ├── <ahref="devtools/inspector">inspector</a> - Python API to inspect ETDump and ETRecord. See <ahref="https://pytorch.org/executorch/main/model-inspector">doc</a>.
45
45
│ └── <ahref="devtools/visualization">visualization</a> - Visualization tools for representing model structure and performance metrics.
46
46
├── <ahref="docs">docs</a> - Static docs tooling and documentation source files.
47
47
├── <ahref="examples">examples</a> - Examples of various user flows, such as model export, delegates, and runtime execution.
│ ├── <ahref="exir/verification">verification</a> - IR verification.
59
59
├── <ahref="extension">extension</a> - Extensions built on top of the runtime.
60
-
│ ├── <ahref="extension/android">android</a> - ExecuTorch wrappers for Android apps. Please refer to the <ahref="docs/source/using-executorch-android.md">Android documentation</a> and <ahref="https://pytorch.org/executorch/main/javadoc/">Javadoc</a> for more information.
61
-
│ ├── <ahref="extension/apple">apple</a> - ExecuTorch wrappers for iOS apps. Please refer to the <ahref="docs/source/using-executorch-ios.md">iOS documentation</a> and <ahref="https://pytorch.org/executorch/main/using-executorch-ios.html">how to integrate into Apple platform</a> for more information.
60
+
│ ├── <ahref="extension/android">android</a> - ExecuTorch wrappers for Android apps. Please refer to the <ahref="docs/source/using-executorch-android.md">Android documentation</a> and <ahref="https://pytorch.org/executorch/main/javadoc">Javadoc</a> for more information.
61
+
│ ├── <ahref="extension/apple">apple</a> - ExecuTorch wrappers for iOS apps. Please refer to the <ahref="docs/source/using-executorch-ios.md">iOS documentation</a> on how to integrate into Apple platform</a> for more information.
62
62
│ ├── <ahref="extension/aten_util">aten_util</a> - Converts to and from PyTorch ATen types.
63
63
│ ├── <ahref="extension/data_loader">data_loader</a> - 1st party data loader implementations.
64
64
│ ├── <ahref="extension/evalue_util">evalue_util</a> - Helpers for working with EValue objects.
@@ -68,10 +68,10 @@ executorch
68
68
│ ├── <ahref="extension/memory_allocator">memory_allocator</a> - 1st party memory allocator implementations.
69
69
│ ├── <ahref="extension/module">module</a> - A simplified C++ wrapper for the runtime. An abstraction that deserializes and executes an ExecuTorch artifact (.pte file). Refer to the <ahref="docs/source/extension-module.md">module documentation</a> for more information.
70
70
│ ├── <ahref="extension/parallel">parallel</a> - C++ threadpool integration.
71
-
│ ├── <ahref="extension/pybindings">pybindings</a> - Python API for executorch runtime. This is powering up the <ahref="https://pytorch.org/executorch/main/runtime-python-api-reference.html">runtime Python API</a> for ExecuTorch.
71
+
│ ├── <ahref="extension/pybindings">pybindings</a> - Python API for executorch runtime. This is powering up the <ahref="docs/source/runtime-python-api-reference.md">runtime Python API</a> for ExecuTorch.
72
72
│ ├── <ahref="extension/pytree">pytree</a> - C++ and Python flattening and unflattening lib for pytrees.
73
73
│ ├── <ahref="extension/runner_util">runner_util</a> - Helpers for writing C++ PTE-execution tools.
74
-
│ ├── <ahref="extension/tensor">tensor</a> - Tensor maker and <code>TensorPtr</code>, details in <ahref="/docs/source/extension-tensor.md">this documentation</a>. For how to use <code>TensorPtr</code> and <code>Module</code>, please refer to the <ahref="/docs/source/using-executorch-cpp.md">"Using ExecuTorch with C++"</a> doc.
74
+
│ ├── <ahref="extension/tensor">tensor</a> - Tensor maker and <code>TensorPtr</code>, details in <ahref="docs/source/extension-tensor.md">this documentation</a>. For how to use <code>TensorPtr</code> and <code>Module</code>, please refer to the <ahref="docs/source/using-executorch-cpp.md">"Using ExecuTorch with C++"</a> doc.
75
75
│ ├── <ahref="extension/testing_util">testing_util</a> - Helpers for writing C++ tests.
│ └── <ahref="extension/training">training</a> - Experimental libraries for on-device training.
@@ -85,7 +85,7 @@ executorch
85
85
├── <ahref="runtime">runtime</a> - Core C++ runtime. These components are used to execute the ExecuTorch program. Please refer to the <ahref="docs/source/runtime-overview.md">runtime documentation</a> for more information.
│ ├── <ahref="runtime/core">core</a> - Core structures used across all levels of the runtime. Basic components such as <code>Tensor</code>, <code>EValue</code>, <code>Error</code> and <code>Result</code> etc.
88
-
│ ├── <ahref="runtime/executor">executor</a> - Model loading, initialization, and execution. Runtime components that execute the ExecuTorch program, such as <code>Program</code>, <code>Method</code>. Refer to the <ahref="https://pytorch.org/executorch/main/executorch-runtime-api-reference.html">runtime API documentation</a> for more information.
88
+
│ ├── <ahref="runtime/executor">executor</a> - Model loading, initialization, and execution. Runtime components that execute the ExecuTorch program, such as <code>Program</code>, <code>Method</code>. Refer to the <ahref="https://pytorch.org/executorch/main/executorch-runtime-api-reference">runtime API documentation</a> for more information.
89
89
│ ├── <ahref="runtime/kernel">kernel</a> - Kernel registration and management.
90
90
│ └── <ahref="runtime/platform">platform</a> - Layer between architecture specific code and portable C++.
91
91
├── <ahref="schema">schema</a> - ExecuTorch PTE file format flatbuffer schemas.
@@ -102,7 +102,7 @@ executorch
102
102
## Contributing workflow
103
103
We actively welcome your pull requests (PRs).
104
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.
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
107
1.[Claim an issue](#claiming-issues), if present, before starting work. If an
108
108
issue doesn't cover the work you plan to do, consider creating one to provide
@@ -245,7 +245,7 @@ modifications to the Google C++ style guide.
245
245
246
246
### C++ Portability Guidelines
247
247
248
-
See also [Portable C++ Programming](/docs/source/portable-cpp-programming.md)
248
+
See also [Portable C++ Programming](docs/source/portable-cpp-programming.md)
249
249
for detailed advice.
250
250
251
251
#### C++ language version
@@ -417,9 +417,9 @@ for basics.
417
417
418
418
## For Backend Delegate Authors
419
419
420
-
- Use [this](/docs/source/backend-delegates-integration.md) guide when
420
+
- Use [this](docs/source/backend-delegates-integration.md) guide when
421
421
integrating your delegate with ExecuTorch.
422
-
- Refer to [this](/docs/source/backend-delegates-dependencies.md) set of
422
+
- Refer to [this](docs/source/backend-delegates-dependencies.md) set of
423
423
guidelines when including a third-party depenency for your delegate.
<ahref="https://pytorch.org/executorch/stable/index.html"><imgsrc="https://img.shields.io/badge/Documentation-000?logo=googledocs&logoColor=FFE165&style=for-the-badge"alt="Check out the documentation"></a>
11
+
<ahref="https://pytorch.org/executorch/main/index"><imgsrc="https://img.shields.io/badge/Documentation-000?logo=googledocs&logoColor=FFE165&style=for-the-badge"alt="Check out the documentation"></a>
12
12
<hr>
13
13
</div>
14
14
@@ -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) to get things running locally and deploy a model to a device
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 LLM use cases by following specific instructions for [Llama](./examples/models/llama/README.md) and [Llava](./examples/models/llava/README.md)
52
+
- Visit the [Step by Step Tutorial](https://pytorch.org/executorch/main/index) to get things running locally and deploy a model to a device
53
+
- Use this [Colab Notebook](https://pytorch.org/executorch/main/getting-started-setup#quick-setup-colab-jupyter-notebook-prototype) to start playing around right away
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)
Follow the steps below to setup your build environment:
45
45
46
-
1.**Setup ExecuTorch Environment**: Refer to the [Setting up ExecuTorch](https://pytorch.org/executorch/stable/getting-started-setup) guide for detailed instructions on setting up the ExecuTorch environment.
46
+
1.**Setup ExecuTorch Environment**: Refer to the [Setting up ExecuTorch](https://pytorch.org/executorch/main/getting-started-setup) guide for detailed instructions on setting up the ExecuTorch environment.
47
47
48
48
2.**Setup MediaTek Backend Environment**
49
49
- Install the dependent libs. Ensure that you are inside backends/mediatek/ directory
Copy file name to clipboardExpand all lines: backends/openvino/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,7 @@ For more information about OpenVINO build, refer to the [OpenVINO Build Instruct
63
63
64
64
Follow the steps below to setup your build environment:
65
65
66
-
1.**Setup ExecuTorch Environment**: Refer to the [Environment Setup](https://pytorch.org/executorch/stable/getting-started-setup#environment-setup) guide for detailed instructions on setting up the ExecuTorch environment.
66
+
1.**Setup ExecuTorch Environment**: Refer to the [Environment Setup](https://pytorch.org/executorch/main/getting-started-setup#environment-setup) guide for detailed instructions on setting up the ExecuTorch environment.
67
67
68
68
2.**Setup OpenVINO Backend Environment**
69
69
- Install the dependent libs. Ensure that you are inside `executorch/backends/openvino/` directory
Copy file name to clipboardExpand all lines: backends/qualcomm/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This backend is implemented on the top of
8
8
[Qualcomm AI Engine Direct SDK](https://developer.qualcomm.com/software/qualcomm-ai-engine-direct-sdk).
9
9
Please follow [tutorial](../../docs/source/build-run-qualcomm-ai-engine-direct-backend.md) to setup environment, build, and run executorch models by this backend (Qualcomm AI Engine Direct is also referred to as QNN in the source and documentation).
10
10
11
-
A website version of the tutorial is [here](https://pytorch.org/executorch/stable/build-run-qualcomm-ai-engine-direct-backend.html).
11
+
A website version of the tutorial is [here](https://pytorch.org/executorch/main/build-run-qualcomm-ai-engine-direct-backend).
Copy file name to clipboardExpand all lines: examples/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
@@ -9,7 +9,7 @@ ExecuTorch's extensive support spans from simple modules like "Add" to comprehen
9
9
## Directory structure
10
10
```
11
11
examples
12
-
├── llm_manual # A storage place for the files that [LLM Maunal](https://pytorch.org/executorch/main/llm/getting-started.html) needs
12
+
├── llm_manual # A storage place for the files that [LLM Maunal](https://pytorch.org/executorch/main/llm/getting-started) needs
13
13
├── models # Contains a set of popular and representative PyTorch models
14
14
├── portable # Contains end-to-end demos for ExecuTorch in portable mode
15
15
├── selective_build # Contains demos of selective build for optimizing the binary size of the ExecuTorch runtime
@@ -75,7 +75,7 @@ The [`Cadence/`](./cadence) directory hosts a demo that showcases the process of
75
75
76
76
## Dependencies
77
77
78
-
Various models and workflows listed in this directory have dependencies on some other packages. You need to follow the setup guide in [Setting up ExecuTorch from GitHub](https://pytorch.org/executorch/stable/getting-started-setup) to have appropriate packages installed.
78
+
Various models and workflows listed in this directory have dependencies on some other packages. You need to follow the setup guide in [Setting up ExecuTorch from GitHub](https://pytorch.org/executorch/main/getting-started-setup) to have appropriate packages installed.
0 commit comments