DOC: Instructions for installing with dependencies from `conda` #3016

david-cortes-intel · 2024-12-10T10:37:22Z

Description

This PR adds instructions for building oneDAL from source using packages from conda to satisfy dependencies instead of using system installs. Packages from conda don'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

I have reviewed my changes thoroughly before submitting this pull request.
I have updated the documentation to reflect the changes or created a separate PR with update and provided its number in the description, if necessary.
Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
I have added a respective label(s) to PR if I have a permission for that.
I have resolved any merge conflicts that might occur with the base branch.

Testing

I have run it locally and tested the changes extensively.

Performance

Not applicable.

Vika-F · 2024-12-11T11:50:26Z

INSTALL.md

@@ -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.


I think it is possible to add the link to a respective chapter and remove "see rest ...".

Added a link.

Vika-F · 2024-12-11T12:04:50Z

INSTALL.md

 ## 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)_


I don't think this is needed if the reference to the chapter is added at the beginning.

Vika-F · 2024-12-11T12:20:16Z

INSTALL.md

@@ -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


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.

Vika-F · 2024-12-11T12:23:34Z

INSTALL.md

+```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)_


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.

Changed to separate code snippets.

Vika-F · 2024-12-11T12:27:03Z

INSTALL.md

+
+_(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:**


Other chapters use '(Linux*)' and '(Windows*)' to distinguish. Let's align and use the wording like this:

Suggested change

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 *):

Splitted into linux/windows sections.

Vika-F · 2024-12-11T12:27:27Z

INSTALL.md

+export CMAKE_PREFIX_PATH="${CONDA_PREFIX}/lib/cmake:${CMAKE_PREFIX_PATH}"
+```
+
+Equivalent for windows:


Suggested change

Equivalent for windows:

Modify the environment variables to point to the necessary libraries (Windows*):

Vika-F

The final request and lgtm.

Vika-F · 2024-12-17T10:25:06Z

INSTALL.md

+
+Then, install the necessary dependencies from the appropriate channels with `conda`:
+
+* Linux:


Suggested change

* Linux:

**Linux\***:

That doesn't appear to render correctly:

Modified the 4 occurrences to use the formatting you're suggesting but inside bullet points.

Vika-F · 2024-12-17T10:25:30Z

INSTALL.md

+    cmake `# required to build the examples only`
+```
+
+* Windows:


Suggested change

* Windows:

**Windows\***:

Vika-F · 2024-12-17T10:26:23Z

INSTALL.md

+
+Then modify the relevant environment variables to point to the conda-installed libraries:
+
+* Linux:


Suggested change

* Linux:

**Linux\***:

Vika-F · 2024-12-17T10:26:26Z

INSTALL.md

+export CMAKE_PREFIX_PATH="${CONDA_PREFIX}/lib/cmake:${CMAKE_PREFIX_PATH}"
+```
+
+* windows:


Suggested change

* windows:

**Windows\***:

instructions for installing with conda dependencies

2632da7

david-cortes-intel added the docs Issue/PR related to oneDAL docs label Dec 10, 2024

david-cortes-intel requested review from Vika-F, maria-Petrova and Alexsandruss as code owners December 10, 2024 10:37

david-cortes-intel added 4 commits December 10, 2024 16:57

correct conda command

f9d149a

more details

d4ff615

corrections

0b02f38

remove MPI, not required

f9f0952

Vika-F reviewed Dec 11, 2024

View reviewed changes

improve instructions

2358a05

Vika-F reviewed Dec 17, 2024

View reviewed changes

formatting

9d88708

Vika-F approved these changes Dec 18, 2024

View reviewed changes

david-cortes-intel merged commit f077d53 into uxlfoundation:main Dec 18, 2024
16 of 18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Instructions for installing with dependencies from `conda` #3016

DOC: Instructions for installing with dependencies from `conda` #3016

david-cortes-intel commented Dec 10, 2024 •

edited

Loading

Vika-F Dec 11, 2024

david-cortes-intel Dec 11, 2024

Vika-F Dec 11, 2024

david-cortes-intel Dec 11, 2024

Vika-F Dec 11, 2024

david-cortes-intel Dec 11, 2024

Vika-F Dec 11, 2024

david-cortes-intel Dec 11, 2024

Vika-F Dec 11, 2024

david-cortes-intel Dec 11, 2024

Vika-F Dec 11, 2024

Vika-F left a comment

Vika-F Dec 17, 2024

david-cortes-intel Dec 17, 2024

david-cortes-intel Dec 17, 2024

Vika-F Dec 17, 2024

Vika-F Dec 17, 2024

Vika-F Dec 17, 2024

		@@ -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.


		_(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:

	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 *):

	Equivalent for windows:
	Modify the environment variables to point to the necessary libraries (Windows*):


		Then, install the necessary dependencies from the appropriate channels with `conda`:

		* Linux:


		Then modify the relevant environment variables to point to the conda-installed libraries:

		* Linux:

DOC: Instructions for installing with dependencies from conda #3016

DOC: Instructions for installing with dependencies from conda #3016

Conversation

david-cortes-intel commented Dec 10, 2024 • edited Loading

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vika-F left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DOC: Instructions for installing with dependencies from `conda` #3016

DOC: Instructions for installing with dependencies from `conda` #3016

david-cortes-intel commented Dec 10, 2024 •

edited

Loading