Skip to content

Commit 51029c6

Browse files
committed
Fix 'getting started' links in examples folder (#979)
Summary: Pull Request resolved: #979 Some of them are referring to the old deprecated doc. Some of them are referring to the md file by doing '../../'. Let's use the website link directly. Reviewed By: shoumikhin, dbort Differential Revision: D50309082 fbshipit-source-id: ecac525db2e14f21f6ab1c964ea5fce205b0b5f3
1 parent 9e84584 commit 51029c6

File tree

12 files changed

+20
-13
lines changed

12 files changed

+20
-13
lines changed

backends/apple/mps/setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ In order to be able to successfully build and run a model using the MPS backend
6060

6161
## Setting up Developer Environment
6262

63-
***Step 1.*** Please finish tutorial [Setting up executorch](getting-started-setup.md).
63+
***Step 1.*** Please finish tutorial [Setting up ExecuTorch](https://pytorch.org/executorch/stable/getting-started-setup).
6464

6565
***Step 2.*** Install dependencies needed to lower MPS delegate:
6666

examples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ You will find demos of [ExecuTorch SDK](./sdk/) in the [`sdk/`](./sdk/) director
7070

7171
## Dependencies
7272

73-
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](../docs/source/getting-started-setup.md) to have appropriate packages installed.
73+
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.

examples/apple/coreml/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ coreml
1515

1616
We will walk through an example model to generate a **CoreML** delegated binary file from a python `torch.nn.module` then we will use the `coreml/executor_runner` to run the exported binary file.
1717

18-
1. Following the setup guide in [Setting Up ExecuTorch](/docs/source/getting-started-setup.md)
18+
1. Following the setup guide in [Setting Up ExecuTorch](https://pytorch.org/executorch/stable/getting-started-setup)
1919
you should be able to get the basic development environment for ExecuTorch working.
2020

2121
2. Run `install_requirements.sh` to install dependencies required by the **CoreML** backend.

examples/apple/mps/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This README gives some examples on backend-specific model workflow.
88
## Prerequisite
99

1010
Please finish the following tutorials:
11-
- [Setting up executorch](../../../docs/website/docs/tutorials/00_setting_up_executorch.md).
11+
- [Setting up ExecuTorch](https://pytorch.org/executorch/stable/getting-started-setup).
1212
- [Setting up MPS backend](../../../backends/apple/mps/setup.md).
1313

1414
## Delegation to MPS backend

examples/demo-apps/android/ExecuTorchDemo/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This guide explains how to setup ExecuTorch for Android using a demo app. The ap
1414

1515
:::{grid-item-card} Prerequisites
1616
:class-card: card-prerequisites
17-
* Refer to [Setting up ExecuTorch](getting-started-setup.md) to set up the repo and dev environment.
17+
* Refer to [Setting up ExecuTorch](https://pytorch.org/executorch/stable/getting-started-setup) to set up the repo and dev environment.
1818
* Download and install [Android Studio and SDK](https://developer.android.com/studio).
1919
* Supported Host OS: CentOS, macOS Ventura (M1/x86_64). See below for Qualcomm HTP specific requirements.
2020
* *Qualcomm HTP Only[^1]:* To build and run on Qualcomm's AI Engine Direct, please follow [Building and Running ExecuTorch with Qualcomm AI Engine Direct Backend](build-run-qualcomm-ai-engine-direct-backend.md) for hardware and software pre-requisites.

examples/demo-apps/apple_ios/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,15 @@ pip --version
4040

4141
### 3. Getting Started Tutorial
4242

43-
Before proceeding, follow the [Setting Up ExecuTorch](getting-started-setup.md)
44-
tutorial to configure the basic environment.
43+
Before proceeding, follow the [Setting Up ExecuTorch](https://pytorch.org/executorch/stable/getting-started-setup)
44+
tutorial to configure the basic environment. Feel free to skip building anything
45+
just yet. Make sure you have all the required dependencies installed, including
46+
the following tools:
47+
48+
- Buck2 (as `/tmp/buck2`)
49+
- Cmake (`cmake` reachable at `$PATH`)
50+
- FlatBuffers Compiler (`flatc` reachable at `$PATH` or as `$FLATC_EXECUTABLE`
51+
enironment variable)
4552

4653
### 4. Backend Dependencies
4754

examples/models/llama2/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This example tries to reuse the Python code, with modifications to make it compa
2626

2727

2828
# Instructions:
29-
1. Follow the [tutorial](https://github.com/pytorch/executorch/blob/main/docs/website/docs/tutorials/00_setting_up_executorch.md) to set up ExecuTorch
29+
1. Follow the [tutorial](https://pytorch.org/executorch/stable/getting-started-setup) to set up ExecuTorch
3030
2. `cd examples/third-party/llama`
3131
3. `pip install -e .`
3232
4. Go back to `executorch` root, run `python3 -m examples.portable.scripts.export --model_name="llama2"`. The exported program, llama2.pte would be saved in current directory

examples/portable/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ We will walk through an example model to generate a `.pte` file in [portable mod
2020
from the [`models/`](../models) directory using scripts in the `portable/scripts` directory. Then we will run on the `.pte` model on the ExecuTorch runtime. For that we will use `executor_runner`.
2121

2222

23-
1. Following the setup guide in [Setting up ExecuTorch from GitHub](../../docs/source/getting-started-setup.md)
23+
1. Following the setup guide in [Setting up ExecuTorch](https://pytorch.org/executorch/stable/getting-started-setup)
2424
you should be able to get the basic development environment for ExecuTorch working.
2525

2626
2. Using the script `portable/scripts/export.py` generate a model binary file by selecting a

examples/portable/custom_ops/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This folder contains examples to register custom operators into PyTorch as well
33

44
## How to run
55

6-
Prerequisite: finish the [setting up wiki](../../../docs/source/getting-started-setup.md).
6+
Prerequisite: finish the [setting up wiki](https://pytorch.org/executorch/stable/getting-started-setup).
77

88
Run:
99

examples/qualcomm/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Here are some general information and limitations.
88

99
## Prerequisite
1010

11-
Please finish tutorial [Setting up executorch](../../docs/source/getting-started-setup.md).
11+
Please finish tutorial [Setting up executorch](https://pytorch.org/executorch/stable/getting-started-setup).
1212

1313
Please finish [setup QNN backend](../../backends/qualcomm/setup.md).
1414

examples/sdk/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ examples/sdk
1414
We will use an example model (in `torch.nn.Module`) and its representative inputs, both from [`models/`](../models) directory, to generate a [BundledProgram(`.bp`)](../../docs/source/sdk-bundled-io.md) file using the [script](scripts/export_bundled_program.py). Then we will use [sdk_example_runner](sdk_example_runner/sdk_example_runner.cpp) to execute the `.bp` model on the ExecuTorch runtime and verify the model on BundledProgram API.
1515

1616

17-
1. Sets up the basic development environment for ExecuTorch by [Setting up ExecuTorch from GitHub](../../docs/source/getting-started-setup.md).
17+
1. Sets up the basic development environment for ExecuTorch by [Setting up ExecuTorch from GitHub](https://pytorch.org/executorch/stable/getting-started-setup).
1818

1919
2. Using the [script](scripts/export_bundled_program.py) to generate a BundledProgram binary file by retreiving a `torch.nn.Module` model and its representative inputs from the list of available models in the [`models/`](../models) dir。
2020

examples/selective_build/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ To optimize binary size of ExecuTorch runtime, selective build can be used. This
33

44
## How to run
55

6-
Prerequisite: finish the [setting up wiki](../../docs/source/getting-started-setup.md).
6+
Prerequisite: finish the [setting up wiki](https://pytorch.org/executorch/stable/getting-started-setup).
77

88
Run:
99

0 commit comments

Comments
 (0)