Skip to content
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.

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

Rename aimet_torch wheel file name in docs #3721

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions Docs/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ Use one of the following commands to install AIMET based on your choice of frame

.. parsed-literal::
python3 -m pip install |download_url|\ |version|/aimet_torch-|version|\+cu121\ |whl_suffix| -f |torch_pkg_url|
python3 -m pip install |download_url|\ |version|/aimet_torch-|version|\+cu121\ |torch_whl_suffix| -f |torch_pkg_url|
With CPU only:

.. parsed-literal::
python3 -m pip install |download_url|\ |version|/aimet_torch-|version|\+cpu\ |whl_suffix| -f |torch_pkg_url|
python3 -m pip install |download_url|\ |version|/aimet_torch-|version|\+cpu\ |torch_whl_suffix| -f |torch_pkg_url|
.. tab-item:: TensorFlow
Expand Down Expand Up @@ -88,6 +88,7 @@ Use one of the following commands to install AIMET based on your choice of frame
python3 -m pip install |download_url|\ |version|/aimet_onnx-|version|\+cpu\ |whl_suffix| -f |torch_pkg_url|
.. |torch_whl_suffix| replace:: \-cp310-none-any.whl
.. |whl_suffix| replace:: \-cp310-cp310-manylinux_2_34_x86_64.whl
.. |download_url| replace:: \https://github.com/quic/aimet/releases/download/
.. |torch_pkg_url| replace:: \https://download.pytorch.org/whl/torch_stable.html
Expand Down
5 changes: 3 additions & 2 deletions Docs/install/install_docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ Releases are listed at: https://github.com/quic/aimet/releases
export download_url="\https://github.com/quic/aimet/releases/download/${release_tag}"
# Set the wheel file name with extension,
# for example "aimet_torch-|version|\+cu121-cp310-cp310-manylinux_2_34_x86_64.whl"
# for example "aimet_torch-|version|\+cu121\ |torch_whl_suffix|"
export wheel_file_name="<wheel file name>"
# NOTE: Do the following only for the PyTorch and ONNX variant packages!
Expand Down Expand Up @@ -266,4 +266,5 @@ Environment setup
source /usr/local/lib/python3.10/dist-packages/aimet_common/bin/envsetup.sh
.. _docker-install-next:
.. |torch_whl_suffix| replace:: \-cp310-none-any.whl
5 changes: 4 additions & 1 deletion Docs/install/install_host.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ For example, "|version|". Releases are listed at: https://github.com/quic/aimet/
export download_url="\https://github.com/quic/aimet/releases/download/${release_tag}"
# Set the wheel file name with extension,
# for example "aimet_torch-|version|\+cu121-cp310-cp310-manylinux_2_34_x86_64.whl"
# for example "aimet_torch-|version|\+cu121\ |torch_whl_suffix|"
export wheel_file_name="<wheel file name>"
# NOTE: Do the following ONLY for the PyTorch and ONNX variant packages!
Expand Down Expand Up @@ -345,3 +345,6 @@ Pillow-SIMD is an optimized version of the Pillow Python Imaging Library. It can
.. code-block:: bash

source /usr/local/lib/python3.10/dist-packages/aimet_common/bin/envsetup.sh


.. |torch_whl_suffix| replace:: \-cp310-none-any.whl
Loading