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.

Sign up for GitHub

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

Jump to bottom

Update build instructions #3009

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update build instructions #3009

wants to merge 1 commit into from

Conversation

avolkov-intel
Copy link
Contributor

@avolkov-intel avolkov-intel commented Dec 5, 2024 •
edited
Loading

Description

Update build instructions for windows examples and fix minor errors in instructions

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 commented my code, particularly in hard-to-understand areas.
  • 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.
  • All CI jobs are green or I have provided justification why they aren't.
  • I have extended testing suite if new functionality was introduced in this PR.

@avolkov-intel avolkov-intel added the docs Issue/PR related to oneDAL docs label Dec 5, 2024
@avolkov-intel
Copy link
Contributor Author

@Alexandr-Solovev @Vika-F could you review these changes, please

Vika-F
Vika-F reviewed Dec 5, 2024
View reviewed changes
docs/source/get-started/build-and-run-examples.rst
Comment on lines +125 to +126
set CC=icx
set CXX=icx
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 the same exports are needed on Linux to build with icx.

Alexandr-Solovev
Alexandr-Solovev reviewed Dec 5, 2024
View reviewed changes
docs/source/get-started/build-and-run-examples.rst
nmake # This will compile and run generated svm examples
cmake -G "NMake Makefiles" -DONEDAL_LINK=static # This wouldgenerate make for static version
nmake # This will compile and run all the examples
set CC=icx
Copy link
Contributor

Choose a reason for hiding this comment

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

May be it makes sense to add additional section about supported compilers. Like, user can build examples with export/set CC=gcc, but without sycl features?
I guess its better to add a comment that for CC and CXX all supported compilers can be chosen

david-cortes-intel
david-cortes-intel reviewed Dec 9, 2024
View reviewed changes
docs/source/get-started/build-and-run-examples.rst
cmake -G "Unix Makefiles" -DEXAMPLES_LIST=svm_two_class_thunder # This would generate makefiles for all svm examples matching passed name
make # This will compile and run generated svm examples
cmake -G "Unix Makefiles" -DONEDAL_LINK=static # This wouldgenerate make for static version
make # This will compile and run all the examples
Copy link
Contributor

Choose a reason for hiding this comment

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

I haven't tried the windows version, but the linux one only compiles the examples without running them.

docs/source/get-started/build-and-run-examples.rst
nmake # This will compile and run generated svm examples
cmake -G "NMake Makefiles" -DONEDAL_LINK=static # This wouldgenerate make for static version
nmake # This will compile and run all the examples
set CC=icx
Copy link
Contributor

Choose a reason for hiding this comment

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

Do the examples require icx? As far as I'm aware, there shouldn't be any issue in building them with msvc if oneDAL was already built with icx.

docs/source/get-started/build-and-run-examples.rst
cmake -G "NMake Makefiles" -DONEDAL_LINK=static # This wouldgenerate make for static version
nmake # This will compile and run all the examples
set CC=icx
set CXX=icx
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
set CXX=icx
set CXX=icpx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@david-cortes-intel david-cortes-intel david-cortes-intel left review comments

@Alexandr-Solovev Alexandr-Solovev Alexandr-Solovev left review comments

@Vika-F Vika-F Vika-F left review comments

@maria-Petrova maria-Petrova Awaiting requested review from maria-Petrova maria-Petrova will be requested when the pull request is marked ready for review maria-Petrova is a code owner

@Alexsandruss Alexsandruss Awaiting requested review from Alexsandruss Alexsandruss will be requested when the pull request is marked ready for review Alexsandruss is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
docs Issue/PR related to oneDAL docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@avolkov-intel @Vika-F @Alexandr-Solovev @david-cortes-intel