Add Perf Sample Example Section #307
Conversation
Signed-off-by: Tyler Titsworth <tyler.titsworth@intel.com>
tylertitsworth
added
documentation
tylertitsworth
requested review from
jitendra42,
sharvil10 and
sramakintel
as code owners
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Manifest Files |
Marina-Zubova
left a comment
Marina-Zubova
left a comment
There was a problem hiding this comment.
I reviewed and left my comments, I'll schedule a meeting to discuss more
python/README.md
Outdated
| | `3.10-full`, `latest` | `2024.2.0` | | ||
| | `3.10-core` | `2024.2.0` | | ||
|
|
||
| ## 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
|
|
||
| ## 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 <tyler.titsworth@intel.com>
|
|
||
| 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 <tyler.titsworth@intel.com>
Marina-Zubova
left a comment
Marina-Zubova
left a comment
There was a problem hiding this comment.
DX reviewed, approved. Maybe Julia would like to look at it as well to check the language. But in general, I think this version is good for Beta testing
Signed-off-by: Tyler Titsworth <tyler.titsworth@intel.com>
Signed-off-by: Tyler Titsworth <tyler.titsworth@intel.com>
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.