Skip to content

docs: include torchaudio in stable install commands #2074

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
ymrohit wants to merge 1 commit into from
Closed

docs: include torchaudio in stable install commands #2074

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
2 changes: 1 addition & 1 deletion _get_started/installation/mac.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To install PyTorch via pip, use the following command, depending on your Python

```bash
# Python 3.x
pip3 install torch torchvision
pip3 install torch torchvision torchaudio
```

## Verification
Expand Down
16 changes: 9 additions & 7 deletions _includes/quick_start_local.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
<a href="{{ site.baseurl }}/get-started/previous-versions">install previous versions of PyTorch</a>. Note that LibTorch is only available for C++.
</p>

<p><b>NOTE:</b> Latest PyTorch requires Python 3.9 or later.</p>
<p><b>NOTE:</b> Latest Stable PyTorch requires Python 3.10 or later.</p>

<p>When upgrading an existing environment, install any PyTorch domain packages you use, such as <code>torchvision</code> and <code>torchaudio</code>, in the same command to keep package versions compatible.</p>

<div class="row">
<div class="col-md-3 headings">
Expand Down Expand Up @@ -34,7 +36,7 @@
<div class="option-text">PyTorch Build</div>
</div>
<div class="col-md-6 option block version selected" id="stable">
<div class="option-text">Stable (1.13.0)</div>
<div class="option-text">Stable (2.11.0)</div>
</div>
<div class="col-md-6 option block version" id="preview">
<div class="option-text">Preview (Nightly)</div>
Expand Down Expand Up @@ -84,16 +86,16 @@
<div class="option-text">Compute Platform</div>
</div>
<div class="col-md-2 option block version" id="cuda.x">
<div class="option-text">CUDA 11.8</div>
<div class="option-text">CUDA 12.6</div>
</div>
<div class="col-md-2 option block version" id="cuda.y">
<div class="option-text">CUDA 12.1</div>
<div class="option-text">CUDA 12.8</div>
</div>
<div class="col-md-2 option block version" id="cuda.z">
<div class="option-text">CUDA 12.4</div>
<div class="option-text">CUDA 13.0</div>
</div>
<div class="col-md-3 option block version" id="rocm5.x">
<div class="option-text">ROCm 5.2</div>
<div class="option-text">ROCm 7.2</div>
</div>
<div class="col-md-3 option block version" id="accnone">
<div class="option-text">CPU</div>
Expand All @@ -104,7 +106,7 @@
<div class="option-text">Run this Command:</div>
</div>
<div class="command-container">
<div class="col-md-12" id="command">pip install torch torchvision</div>
<div class="col-md-12" id="command">pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu126</div>
</div>
</div>
</div>
Expand Down
3 changes: 1 addition & 2 deletions assets/quick-start-module.js
View file
Open in desktop

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions published_versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6921,23 +6921,23 @@
"pip": {
"accnone": {
"note": null,
"command": "pip3 install torch torchvision --index-url https://download.pytorch.org/whl/cpu"
"command": "pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu"
},
"cuda.x": {
"note": null,
"command": "pip3 install torch torchvision --index-url https://download.pytorch.org/whl/cu126"
"command": "pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu126"
},
"cuda.y": {
"note": null,
"command": "pip3 install torch torchvision --index-url https://download.pytorch.org/whl/cu128"
"command": "pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu128"
},
"cuda.z": {
"note": null,
"command": "pip3 install torch torchvision"
"command": "pip3 install torch torchvision torchaudio"
},
"rocm5.x": {
"note": null,
"command": "pip3 install torch torchvision --index-url https://download.pytorch.org/whl/rocm7.2"
"command": "pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm7.2"
}
},
"libtorch": {
Expand Down Expand Up @@ -6977,27 +6977,27 @@
"pip": {
"cuda.x": {
"note": "# CUDA is not available on MacOS, please use default package",
"command": "pip3 install torch torchvision",
"command": "pip3 install torch torchvision torchaudio",
"default": true
},
"cuda.y": {
"note": "# CUDA is not available on MacOS, please use default package",
"command": "pip3 install torch torchvision",
"command": "pip3 install torch torchvision torchaudio",
"default": true
},
"cuda.z": {
"note": "# CUDA is not available on MacOS, please use default package",
"command": "pip3 install torch torchvision",
"command": "pip3 install torch torchvision torchaudio",
"default": true
},
"rocm5.x": {
"note": "# ROCm is not available on MacOS, please use default package",
"command": "pip3 install torch torchvision",
"command": "pip3 install torch torchvision torchaudio",
"default": true
},
"accnone": {
"note": null,
"command": "pip3 install torch torchvision"
"command": "pip3 install torch torchvision torchaudio"
}
},
"libtorch": {
Expand Down Expand Up @@ -7041,19 +7041,19 @@
"pip": {
"accnone": {
"note": null,
"command": "pip3 install torch torchvision"
"command": "pip3 install torch torchvision torchaudio"
},
"cuda.x": {
"note": null,
"command": "pip3 install torch torchvision --index-url https://download.pytorch.org/whl/cu126"
"command": "pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu126"
},
"cuda.y": {
"note": null,
"command": "pip3 install torch torchvision --index-url https://download.pytorch.org/whl/cu128"
"command": "pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu128"
},
"cuda.z": {
"note": null,
"command": "pip3 install torch torchvision --index-url https://download.pytorch.org/whl/cu130"
"command": "pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu130"
},
"rocm5.x": {
"note": "<b>NOTE:</b> ROCm is not available on Windows",
Expand Down Expand Up @@ -7097,4 +7097,4 @@
}
}
}
}
}
11 changes: 10 additions & 1 deletion scripts/gen_quick_start_module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,12 @@ def get_gpu_info(acc_key, instr, acc_arch_map):
return (gpu_arch_type, gpu_arch_version)


def add_stable_pip_domain_packages(command):
if command is None:
return None
return command.replace("torch torchvision", "torch torchvision torchaudio")


# This method is used for generating new published_versions.json file
# It will modify versions json object with installation instructions
# Provided by generate install matrix Github Workflow, stored in release_matrix
Expand Down Expand Up @@ -148,7 +154,10 @@ def update_versions(versions, release_matrix, release_version):

if pkg_arch_matrix:
if package_type != "libtorch":
instr["command"] = pkg_arch_matrix[0]["installation"]
command = pkg_arch_matrix[0]["installation"]
if release_version == "release" and pkg_key == "pip":
command = add_stable_pip_domain_packages(command)
instr["command"] = command
else:
if os_key == OperatingSystem.LINUX.value:
rel_entry_dict = {
Expand Down
Loading