Install doc edits. #3398
Install doc edits. #3398
Conversation
Signed-off-by: Dave Welsch <[email protected]>
Signed-off-by: Dave Welsch <[email protected]>
quic-hitameht
requested review from
quic-jpolizzi,
quic-bharathr,
quic-hitameht and
quic-akhobare
Signed-off-by: Dave Welsch <[email protected]>
Docs/install/index.rst
Outdated
|
|
||
| The AIMET PyTorch GPU PyPI packages are available for environments that meet the following requirements: | ||
| - :doc:`Install manually <install_host>` | ||
| - :doc:`Install a Docker image, including from a pre-built image or local build <install_docker>` |
There was a problem hiding this comment.
Can consider rewording as follows:
Install or build within a docker container from a pre-built image
There was a problem hiding this comment.
How about:
Install a pre-built or locally built image in a Docker container
There was a problem hiding this comment.
Let's word it like this:
Install within a Docker container from a pre-built or locally built Docker image
There was a problem hiding this comment.
I added some feedback- please review and LMK if any questions. I understand a lot of content was paraphrased and reorganized. Also, could you please ensure the format is largely consistent across the Install Docker and Install Host pages. For instance the latter has separate sections for pytorch, TF and ONNX; whereas the former has everything combined. Thanks for your work.
Signed-off-by: Dave Welsch <[email protected]>
|
|
||
| apt-get install liblapacke -y |
There was a problem hiding this comment.
Can you please remind me where these steps moved to?
There was a problem hiding this comment.
The install procedures follow below in the order they're listed (starting immediately below with PyTorch). Presumably in the Install rewrite they'll be on separate pages or in tabs to avoid the confusion of listing them sequentially.
It looks like I forgot to include the liblapacke install instruction on this page. Does this apply only to the PyTorch PyPI install, or generally to all the installs? I'll modify here and on the main install page as needed.
I've also omitted the PyPI quick install instructions on this page. This exists on the main install page, and this page gives complete instructions for the wheel install. Is it necessary to include the PyPI install here?
There was a problem hiding this comment.
"Does this apply only to the PyTorch PyPI install, or generally to all the installs?" Good question - Let's add it to all installs for now. We can remove from the others later if they are not needed
There was a problem hiding this comment.
@dwelsch-esi Looks good. I added a few more comments. After addressing them, can you also please rebase your branch with the latest upstream develop tip. Please contact me if you need any help.
Grammar and style edits to all installation documentation. Some contents rearranged to make instructions more clear. Install from release packages reorganized by framework.