-
Notifications
You must be signed in to change notification settings - Fork 27
Add Perf Sample Example Section #307
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
99d9de5
Add Perf Sample Example Section
e194d63
Merge branch 'main' into tylertitsworth/perf-sample-ex
d4e0f3d
Update README.md
0deb8ef
Update README.md
f1d7cfa
Update README.md
tylertitsworth 4b9065c
Merge branch 'main' into tylertitsworth/perf-sample-ex
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,44 @@ | ||
| # Intel® Distribution for Python | ||
| # Intel® Distribution for Python* | ||
|
|
||
| [Intel® Distribution for Python] enhances performance and can improve your program speed from 10 to 100 times faster. It is a Python distribution that includes the [Intel® Math Kernel Library] (oneMKL) and other Intel performance libraries to enable near-native performance through acceleration of core numerical and machine learning packages. | ||
|
|
||
| [Intel® Distribution for Python] is available as part of the [Intel® oneAPI Base Toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/base-toolkit.html). | ||
| [Intel® Distribution for Python*] enhances performance and can improve your program speed from 10 to 100 times faster. It is a Python* distribution that includes the [Intel® Math Kernel Library] (oneMKL) and other Intel performance libraries to enable near-native performance through acceleration of core numerical and machine learning packages. | ||
|
|
||
| ## Images | ||
|
|
||
| The images below include variations for only the core packages in the [Intel® Distribution for Python] installation, or all of the packages. | ||
| The images below include variations for only the core packages in the [Intel® Distribution for Python*] installation, or all of the packages. | ||
|
|
||
| | Tag(s) | IDP | | ||
| | ---------------------- | ---------- | | ||
| | `3.10-full`, `latest` | `2024.2.0` | | ||
| | `3.10-core` | `2024.2.0` | | ||
|
|
||
| ## Build from Source | ||
| ## Run a Performance Sample | ||
|
|
||
| To run a performance sample run the following commands: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/intel/ai-containers | ||
| cd ai-containers/python | ||
| docker run --rm -it \ | ||
| -v $PWD/tests:/tests \ | ||
| intel/python:latest \ | ||
| python /tests/perf_sample.py | ||
| ``` | ||
|
|
||
| ### Compare the results against stock python | ||
|
|
||
| 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.
Sorry, something went wrong.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added a note regarding that |
||
| ```bash | ||
| # Use the working directory from the above command | ||
| docker run --rm -it \ | ||
| -v $PWD/tests:/tests \ | ||
| python:3.11-slim-bullseye \ | ||
| bash | ||
| pip install numpy | ||
| python /tests/perf_sample.py | ||
| ``` | ||
|
|
||
| ## Build from Source (Advanced) | ||
|
|
||
| To build the images from source, clone the [AI Containers](https://github.com/intel/ai-containers) repository, follow the main `README.md` file to setup your environment, and run the following command: | ||
|
|
||
|
|
@@ -27,8 +52,8 @@ You can find the list of services below for each container in the group: | |
|
|
||
| | Service Name | Description | | ||
| | ------------ | ------------------------------------------------------------------- | | ||
| | `idp` | Base image with [Intel® Distribution for Python] | | ||
| | `pip` | Equivalent python image without [Intel® Distribution for Python] | | ||
| | `idp` | Base image with [Intel® Distribution for Python*] | | ||
| | `pip` | Equivalent python image without [Intel® Distribution for Python*] | | ||
|
|
||
| ## License | ||
|
|
||
|
|
@@ -40,5 +65,5 @@ It is the image user's responsibility to ensure that any use of The images below | |
|
|
||
| <!--Below are links used in these document. They are not rendered: --> | ||
|
|
||
| [Intel® Distribution for Python]: https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html#gs.9bos9m | ||
| [Intel® Distribution for Python*]: https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html#gs.9bos9m | ||
| [Intel® Math Kernel Library]: https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html | ||
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.
Uh oh!
There was an error while loading. Please reload this page.