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.

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

Cover more topics in installation instructions #2923

Merged

Conversation

david-cortes-intel
Copy link
Contributor

Description

This PR updates the installation instructions to more accurately reflect the requirements when building from source, and to point at ways of executing the provided examples and unit tests.

@david-cortes-intel david-cortes-intel added the docs Issue/PR related to oneDAL docs label Sep 30, 2024
INSTALL.md Outdated
@@ -19,7 +19,9 @@

Required Software:
* C/C++ Compiler
* [DPC++ Compiler](https://www.intel.com/content/www/us/en/developer/tools/oneapi/dpc-compiler.html)
* [DPC++ Compiler](https://www.intel.com/content/www/us/en/developer/tools/oneapi/dpc-compiler.html) if building with SYCL support
* Python version 3.7 or higher
Copy link
Contributor

Choose a reason for hiding this comment

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

i think 3.7 as well as 3.8 are not officially supported

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks. Updated it to mention version 3.9 or higher.

* [DPC++ Compiler](https://www.intel.com/content/www/us/en/developer/tools/oneapi/dpc-compiler.html)
* [DPC++ Compiler](https://www.intel.com/content/www/us/en/developer/tools/oneapi/dpc-compiler.html) if building with SYCL support
* Python version 3.9 or higher
* TBB library (repository contains script to download it)
Copy link
Contributor

@Alexandr-Solovev Alexandr-Solovev Oct 1, 2024

Choose a reason for hiding this comment

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

there is a tricky thing, that depends on tbb version we must use MKL_FPK_GPU_VERSION_LINE=2024.0. This var controls what layout of tbb will be used. If tbb < 2024.7 its not necessary to use this flag, if higher, its necessary.
We have task for removing it, but its not done yet

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Questions in this regard:

  • Isn't the latest version of TBB set at 2021.13.0?
  • If the build script sources the TBB script that sets the environment variables, would it be possible to retrieve the version from the .pc file? Under the default oneapi-basekit install, it should be under /opt/intel/oneapi/tbb/latest/lib/pkgconfig/tbb.pc.

Copy link
Contributor

@Alexandr-Solovev Alexandr-Solovev left a comment

Choose a reason for hiding this comment

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

LGTM!

@napetrov napetrov merged commit 3fb542f into uxlfoundation:main Oct 1, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issue/PR related to oneDAL docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants