Skip to content

Commit

Permalink
small readme tweaks (#2267)
Browse files Browse the repository at this point in the history
Signed-off-by: Mark McCormick <[email protected]>
  • Loading branch information
mamccorm authored Feb 23, 2024
1 parent 57bb9b2 commit 590cd4e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
13 changes: 8 additions & 5 deletions images/pytorch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<!--monopod:end-->

<!--overview:start-->
A minimal, [wolfi](https://github.com/wolfi-dev)-based image for pytorch, a Python package that provides two high-level features: Tensor computation (like NumPy) with strong GPU acceleration and Deep neural networks built on a tape-based autograd system.
A minimal, [wolfi](https://github.com/wolfi-dev)-based image for pytorch, a Python package that provides two high-level features: Tensor computation with strong GPU acceleration and Deep neural networks built on a tape-based autograd system.

<!--overview:end-->

Expand All @@ -30,11 +30,14 @@ docker pull cgr.dev/chainguard/pytorch:latest

## Running pytorch

Please refer TESTING.md for instructions on how to configure and test pytorch.
The below examples are intended as demonstrating how to substitute with the chainguard image, and
are not comprehensive.
Pytorch has some pre-requisites which need to be configured in the environment
prior to running. For examples, please refer to [TESTING.md](https://github.com/chainguard-images/images/blob/main/images/pytorch/TESTING.md).

### Docker
Additionally, please refer to the [upstream documentation](https://github.com/pytorch/pytorch)
for more information on coniguring and using Pytorch.

Assuming the environment pre-requisite have been met, below demonstrates how
to launch the container:

```bash
docker run --rm -i -t \
Expand Down
2 changes: 1 addition & 1 deletion images/pytorch/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ logo: https://storage.googleapis.com/chainguard-academy/logos/pytorch.svg
endoflife: ""
console_summary: ""
short_description: |
A minimal, [wolfi](https://github.com/wolfi-dev)-based image for pytorch, a Python package that provides two high-level features: Tensor computation (like NumPy) with strong GPU acceleration and Deep neural networks built on a tape-based autograd system.
A minimal, [wolfi](https://github.com/wolfi-dev)-based image for pytorch, a Python package that provides two high-level features: Tensor computation with strong GPU acceleration and Deep neural networks built on a tape-based autograd system.
compatibility_notes: ""
readme_file: README.md
upstream_url: https://www.pytorch.org/
Expand Down

0 comments on commit 590cd4e

Please sign in to comment.