Add Perf Sample Example Section #307
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Tyler Titsworth <[email protected]>
tylertitsworth
added
documentation
tylertitsworth
requested review from
jitendra42,
sramakintel and
sharvil10
as code owners
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Manifest Files |
Marina-Zubova
suggested changes
Aug 14, 2024
python/README.md
Outdated
| @@ -15,7 +15,7 @@ The images below include variations for only the core packages in the [Intel® D | |||
|
|
|||
| ## Build from Source | |||
There was a problem hiding this comment.
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
python/README.md
Outdated
| @@ -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: | |||
There was a problem hiding this comment.
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).
Signed-off-by: Tyler Titsworth <[email protected]>
Marina-Zubova
suggested changes
Aug 15, 2024
|
|
||
| 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: | ||
| In the previous command, you should see a result at the bottom like: `Time Consuming: 0.03897857666015625`. We can compare this against `python:3.11-slim-bullseye` | ||
|
|
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
I added a note regarding that
Signed-off-by: Tyler Titsworth <[email protected]>
Marina-Zubova
approved these changes
Aug 19, 2024
Signed-off-by: Tyler Titsworth <[email protected]>
tylertitsworth
pushed a commit
that referenced
this pull request
Sep 25, 2024
Signed-off-by: Tyler Titsworth <[email protected]>
jitendra42
pushed a commit
to jitendra42/ai-containers
that referenced
this pull request
Oct 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Customer Request to add an example for how to run our basic perf sample. See the test file for reference.
Related Issue
n/a
Changes Made
Validation
Ran the command in my terminal
test_runner.pywith all existing tests passing, and I have added new tests where applicable.