DOC: Instructions for installing with dependencies from conda
#3016
Conversation
david-cortes-intel
requested review from
Vika-F,
maria-Petrova and
Alexsandruss
as code owners
INSTALL.md
Outdated
| @@ -35,12 +35,17 @@ Note: the Intel(R) oneAPI components listed here can be installed together throu | |||
|
|
|||
| https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit.html | |||
|
|
|||
| These dependencies can also be installed through the `conda` software, but doing so will require a few additional setup steps - see rest of the instructions for details. | |||
There was a problem hiding this comment.
I think it is possible to add the link to a respective chapter and remove "see rest ...".
There was a problem hiding this comment.
Added a link.
INSTALL.md
Outdated
| ## Docker Development Environment | ||
|
|
||
| [Docker file](https://github.com/uxlfoundation/oneDAL/tree/main/dev/docker) with the oneDAL development environment | ||
| is available as an alternative to the manual setup. | ||
|
|
||
| ## Installation Steps | ||
|
|
||
| _(If using `conda`, see subsequent sections for instructions)_ |
There was a problem hiding this comment.
I don't think this is needed if the reference to the chapter is added at the beginning.
There was a problem hiding this comment.
Removed.
INSTALL.md
Outdated
| @@ -195,3 +200,69 @@ For example, in a Linux platform, assuming one wishes to execute the `adaboost_d | |||
| ```shell | |||
| ./_cmake_results/intel_intel64_so/adaboost_dense_batch | |||
| ``` | |||
|
|
|||
| ## Installation with a conda environment | |||
There was a problem hiding this comment.
Let's rename to something like: Conda Development Environment Setup, and remove the last part about running make that duplicates the info in the previous chapter.
There was a problem hiding this comment.
Renamed.
INSTALL.md
Outdated
| ```shell | ||
| conda install -y \ | ||
| -c https://software.repos.intel.com/python/conda/ \ `# Intel's repository` | ||
| -c conda-forge \ `# conda-forge, for tools like 'make'` | ||
| make python \ `# used by the build system` | ||
| dpcpp-cpp-rt dpcpp_linux-64 intel-sycl-rt \ `# Intel compiler packages` | ||
| tbb tbb-devel \ `# required TBB packages` | ||
| mkl mkl-devel mkl-static mkl-dpcpp mkl-devel-dpcpp \ `# required MKL packages` | ||
| cmake `# required to build the examples only` | ||
| ``` | ||
|
|
||
| _(for windows, replace `dpcpp_linux-64` with `dpcpp_win-64`, and remove the comments within backticks)_ |
There was a problem hiding this comment.
Let's have separate instructions for Linux and Windows - save the time for users on copy-pasting.
Also, i think the minimal supported versions for the packages (at least some) need to be added. Like python=3.9, etc.
There was a problem hiding this comment.
Changed to separate code snippets.
INSTALL.md
Outdated
|
|
||
| _(for windows, replace `dpcpp_linux-64` with `dpcpp_win-64`, and remove the comments within backticks)_ | ||
|
|
||
| Then, one needs to modify environment variables as appropriate to point to the necessary libraries - **assuming a linux system:** |
There was a problem hiding this comment.
Other chapters use '(Linux*)' and '(Windows*)' to distinguish. Let's align and use the wording like this:
| Then, one needs to modify environment variables as appropriate to point to the necessary libraries - **assuming a linux system:** | |
| Modify the environment variables to point to the necessary libraries (Linux *): |
There was a problem hiding this comment.
Splitted into linux/windows sections.
INSTALL.md
Outdated
| export CMAKE_PREFIX_PATH="${CONDA_PREFIX}/lib/cmake:${CMAKE_PREFIX_PATH}" | ||
| ``` | ||
|
|
||
| Equivalent for windows: |
There was a problem hiding this comment.
| Equivalent for windows: | |
| Modify the environment variables to point to the necessary libraries (Windows*): |
Description
This PR adds instructions for building oneDAL from source using packages from
condato satisfy dependencies instead of using system installs. Packages fromcondadon't come with activation scripts, so this adds the necessary instructions for getting them to work with the oneDAL make file.Disclaimer: I haven't fully tested the windows instructions.
PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.
You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).
Checklist to comply with before moving PR from draft:
PR completeness and readability
Testing
Performance
Not applicable.