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.

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

Add Perf Sample Example Section #307

Merged
merged 6 commits into from
Aug 29, 2024
Merged

Add Perf Sample Example Section #307

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
99d9de5
Add Perf Sample Example Section
Aug 13, 2024
e194d63
Merge branch 'main' into tylertitsworth/perf-sample-ex
Aug 13, 2024
d4e0f3d
Update README.md
Aug 15, 2024
0deb8ef
Update README.md
Aug 16, 2024
f1d7cfa
Update README.md
tylertitsworth Aug 18, 2024
4b9065c
Merge branch 'main' into tylertitsworth/perf-sample-ex
Aug 29, 2024
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
14 changes: 13 additions & 1 deletion python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The images below include variations for only the core packages in the [Intel® D

## Build from Source
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after discussion with Alex Rybkin, it seems like build from source option is not relevant for our target users. So, we probably should remove this section if there are no objections


To build the images from source, clone the [Intel® AI Containers](https://github.com/intel/ai-containers) repository, follow the main `README.md` file to setup your environment, and run the following command:
To build the images from source, clone the [Intel® AI Containers](https://github.com/intel/ai-containers) repository, follow the main `README.md` file to setup your environment, and run the following commands:

```bash
cd python
Expand All @@ -30,6 +30,18 @@ You can find the list of services below for each container in the group:
| `idp` | Base image with [Intel® Distribution for Python] |
| `pip` | Equivalent python image without [Intel® Distribution for Python] |

## Run a Performance Sample

To run a performance sample, clone the [Intel® AI Containers](https://github.com/intel/ai-containers) repository, follow the main `README.md` file to setup your environment, and run the following commands:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't expect our target users (who may be novice users) to follow the instructions in the main README of containers repo. Instead of it, we need to provide all the needed commands here (not for building from source, but for pulling and running the container).


```bash
cd python
docker run --rm -it \
-v $PWD/tests:/tests \
intel/python:latest \
python /tests/perf_sample.py
```

## License

View the [License](https://github.com/intel/ai-containers/blob/main/LICENSE) for the [Intel® Distribution for Python].
Expand Down