[Docs] Rewrite build documentation #510

hjabird · 2024-06-10T16:23:44Z

Description

This PR completely rewrites the build documentation in an attempt to make it easier to follow and less intimidating. It separates out the DPC++ and AdaptiveCpp builds, and also adds a section on using oneMKL with CMake.

contributes to the solution of #459

Rbiessy

This looks great to me!

docs/building_the_project_with_adaptivecpp.rst

docs/building_the_project_with_dpcpp.rst

docs/index.rst

hjabird · 2024-06-11T13:33:12Z

html.zip

The rendered html for 90ce137 is contained in the attached .zip.

vbm23 · 2024-06-11T15:09:10Z

Since at least 2 approving reviews are required to merge this pull request and 1 done, @hjabird who would be the 2nd here?

hjabird · 2024-06-11T15:18:18Z

Since at least 2 approving reviews are required to merge this pull request and 1 done, @hjabird who would be the 2nd here?

I hope that @dnhsieh-intel, @mkrainiuk, @vmalia or @akabalov will take some interest! I'm hoping for feedback from more than two people ideally however since this is a very public-facing PR.

andrewtbarker

Thank you for doing this, this will be a great improvement when it is done.

docs/building_the_project_with_adaptivecpp.rst

docs/building_the_project_with_dpcpp.rst

docs/consuming_with_cmake.rst

andrewtbarker

Thank you for the great care and thoroughness in your response to my review. I'm looking forward to seeing these docs merged.

dnhsieh-intel

Thank you for the contribution! I still need some time to go through it.

Here are somethings I noticed:

Should we say "building oneMKL interface library", "building oneMKL interfaces library", or just "building oneMKL interfaces"?
For CMake options, we have yes/no, True/False, ON/OFF. I think it would be better to unify the usage.

docs/building_the_project_with_dpcpp.rst

hjabird · 2024-06-14T16:27:59Z

Here are somethings I noticed:

* Should we say "building oneMKL interface library", "building oneMKL interface**s** library", or just "building oneMKL interface**s**"?

* For CMake options, we have `yes/no`, `True/False`, `ON/OFF`. I think it would be better to unify the usage.

TIL I've always called it the wrong thing! Where its been called more than just oneMKL (i.e. oneMKL Interface Library or similar), I've renamed it oneMKL Interfaces to match the name given in the Github landing page.
I've unified everything on True/False.

Thank you very much for comments!

* Rewrites the build documentation * Separates DPC++ and AdaptiveCpp documentation * Adds section on consuming with CMake

…fiddle with titles

…nal clarifications

hjabird · 2024-06-14T16:39:14Z

I've rebased on some recent changes, so the rendered html now looks prettier:
html.zip

dnhsieh-intel

Sorry for the delay. Thanks again for the great work!

docs/building_the_project_with_dpcpp.rst

docs/building_and_running_tests.rst

dnhsieh-intel · 2024-06-18T07:42:37Z

Ah, I forgot one thing. The "fixes: #459" in the description will close the issue automatically after this PR is merged. GitHub doesn't recognize partially fixes.

…sparse BLAS; `clang++`

docs/using_onemkl_with_cmake.rst

hjabird · 2024-06-19T17:42:06Z

@dnhsieh-intel how is this looking to you? I'm running a tutorial tomorrow, so if you think its ready I'd be delighted if we got this merged.

* Rewrites build documentation * Splits documentation into several files * Adds docs for using with CMake.

Rbiessy reviewed Jun 11, 2024

View reviewed changes

docs/building_the_project_with_adaptivecpp.rst Outdated Show resolved Hide resolved

docs/building_the_project_with_dpcpp.rst Outdated Show resolved Hide resolved

docs/building_the_project_with_dpcpp.rst Outdated Show resolved Hide resolved

docs/index.rst Outdated Show resolved Hide resolved

Rbiessy approved these changes Jun 11, 2024

View reviewed changes

This was referenced Jun 11, 2024

[Build][Docs] Improve build documentation #459

Open

oneMKL build instruction improvements uxlfoundation/open-source-working-group#38

Closed

andrewtbarker reviewed Jun 11, 2024

View reviewed changes

andrewtbarker approved these changes Jun 12, 2024

View reviewed changes

dnhsieh-intel reviewed Jun 13, 2024

View reviewed changes

Rbiessy reviewed Jun 13, 2024

View reviewed changes

docs/building_the_project_with_dpcpp.rst Outdated Show resolved Hide resolved

docs/building_the_project_with_dpcpp.rst Show resolved Hide resolved

docs/building_the_project_with_dpcpp.rst Outdated Show resolved Hide resolved

hjabird added 14 commits June 14, 2024 17:30

[Docs] Rewrite build documentation

e8d6a5a

* Rewrites the build documentation * Separates DPC++ and AdaptiveCpp documentation * Adds section on consuming with CMake

Address RBiessy comments

104dbd4

Minor rewording; link AdaptiveCpp target docs;

3b90655

Move test docs to new file; Rename using with cmake file, add into

0244f4c

Merge portFFT/portBLAS sections; link to windows supported backends; …

eabd21e

…fiddle with titles

Link nvidia compute capability table

6021078

Simplify Build Setup sections

ef4c835

Improve Build Setup (now Environment Setup)

3b8c17e

Rename Introduction->Build Commands; Unindent code

9071393

Common Problems->Build FAQ; clarify port*/MKL?PU exclusivity; Additio…

adedb54

…nal clarifications

Format for 80 character lines

edb51ee

Use True/False for CMake

3701e07

Call it oneMKL Interfaces; more formatting to 80 columns

b33077b

Update for ONEAPI_DEVICE_SELECTOR; Fix minor formatting issues

e06b9b9

hjabird force-pushed the hjab/rewrite_building_the_project branch from 73d3510 to e06b9b9 Compare June 14, 2024 16:38

dnhsieh-intel reviewed Jun 18, 2024

View reviewed changes

hjabird added 7 commits June 18, 2024 10:07

Improve DPC++ Build Commands introduction

04744c6

Reducing spacing in invocation examples

17befab

Replace remaining OFFs / ONs with False / True

8f4fc93

Minor changes: clarify may require; clean up grammar; _o_neMKL; list …

ef02116

…sparse BLAS; `clang++`

Rewording

4f6af02

Bullet point formatting

882b98b

Cleanup -> clean up part 2

cbd83b4

Rbiessy reviewed Jun 18, 2024

View reviewed changes

docs/using_onemkl_with_cmake.rst Show resolved Hide resolved

Mention MKLROOT environment variable

c55db76

dnhsieh-intel approved these changes Jun 19, 2024

View reviewed changes

hjabird merged commit 69bad82 into oneapi-src:develop Jun 20, 2024
8 checks passed

Rbiessy mentioned this pull request Jul 9, 2024

Fix README documentation link #530

Merged

vbm23 mentioned this pull request Jul 16, 2024

oneMKL Quick start documentation uxlfoundation/open-source-working-group#39

Closed

normallytangent pushed a commit to normallytangent/oneMKL that referenced this pull request Aug 6, 2024

[Docs] Rewrite build documentation (oneapi-src#510)

989578c

* Rewrites build documentation * Splits documentation into several files * Adds docs for using with CMake.

hjabird mentioned this pull request Aug 7, 2024

v0.5 release notes #547

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Rewrite build documentation #510

[Docs] Rewrite build documentation #510

hjabird commented Jun 10, 2024 •

edited

Loading

Rbiessy left a comment

hjabird commented Jun 11, 2024

vbm23 commented Jun 11, 2024

hjabird commented Jun 11, 2024

andrewtbarker left a comment

andrewtbarker left a comment

dnhsieh-intel left a comment

hjabird commented Jun 14, 2024

hjabird commented Jun 14, 2024

dnhsieh-intel left a comment

dnhsieh-intel commented Jun 18, 2024

hjabird commented Jun 19, 2024

[Docs] Rewrite build documentation #510

[Docs] Rewrite build documentation #510

Conversation

hjabird commented Jun 10, 2024 • edited Loading

Description

Rbiessy left a comment

Choose a reason for hiding this comment

hjabird commented Jun 11, 2024

vbm23 commented Jun 11, 2024

hjabird commented Jun 11, 2024

andrewtbarker left a comment

Choose a reason for hiding this comment

andrewtbarker left a comment

Choose a reason for hiding this comment

dnhsieh-intel left a comment

Choose a reason for hiding this comment

hjabird commented Jun 14, 2024

hjabird commented Jun 14, 2024

dnhsieh-intel left a comment

Choose a reason for hiding this comment

dnhsieh-intel commented Jun 18, 2024

hjabird commented Jun 19, 2024

hjabird commented Jun 10, 2024 •

edited

Loading