Repository navigation
Commit 17fe76d
authored
Show every install variant on the getting started page (pytorch#23012)
### What is wrong today
The Installation section gives one command, `pip install executorch`,
and that command
does not produce a working setup.
PyTorch is not installed with it. The package does not declare torch as
a dependency,
because the right build depends on the hardware. In a clean environment
the export
example a few paragraphs further down the same page stops with
`No module named 'torch'`.
The CUDA packages are not mentioned anywhere on the page, although
releases and nightly
builds both carry `cu130`, `cu132` and `cu134`. To find any of them
today you have to
already know how the package index is laid out.
### What this changes
The single command becomes one command template plus a small table of
variants, in the
spirit of the PyTorch get started page. You find the row for the machine
you export on
and put its name in the index URL. Nightly builds are the same names
with `nightly/` in
front.
The section now also says why torch is on the command line, why a second
index is
needed, that the CUDA packages are Linux only, and what to do when your
CUDA version is
not one of the listed ones.
A test is added next to the existing release matrix checks: the CUDA
versions named in
that section must be exactly the ones the release matrix publishes. A
version added to
or dropped from the build then cannot leave the page behind.
### What was tested
Every documented variant was installed with `pip install --dry-run` in a
clean
environment, and the resolved executorch and torch versions come from
the intended
index: `cpu`, `cu130`, `cu132`, `nightly/cpu`, `nightly/cu130`,
`nightly/cu132` and
`nightly/cu134`. CUDA 13.4 has no release wheel yet, which the page
says.
The old instruction was confirmed broken: `pip install executorch` in a
clean
environment installs no torch, and `import executorch.exir` then fails.
`pytest .ci/scripts/tests/test_filter_cuda_matrix.py` passes. It fails
when a row is
removed from the table, when a version that is not published is added to
it, and when
the section heading is renamed.1 parent 61f9d45 commit 17fe76d
2 files changed
Lines changed: 50 additions & 12 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
| |||
285 | 286 | | |
286 | 287 | | |
287 | 288 | | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
288 | 306 | | |
289 | 307 | | |
290 | 308 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | | - | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
21 | 24 | | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
| 25 | + | |
| 26 | + | |
29 | 27 | | |
30 | 28 | | |
31 | | - | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
35 | | - | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
36 | 56 | | |
37 | 57 | | |
38 | 58 | | |
| |||
0 commit comments