[SYCL][Doc] Render user API classes on a dedicated page #1578

alexbatashev · 2020-04-23T14:11:47Z

This does not add new meaningful documentation, only introduces
a new module for some public host-side APIs.

Also:

Rename sycl/doc/contents.rst to sycl/doc/index.rst to generate
index.html for final website.
Link documentation from the README.md

Signed-off-by: Alexander Batashev alexander.batashev@intel.com

This does not add new meaningful documentation, only introduces a new module for some public host-side APIs. Also: - Rename sycl/doc/contents.rst to sycl/doc/index.rst to generate index.html for final website. - Link documentation from the README.md Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

…_docs * origin/sycl: (664 commits) [SYCL][Doc] Update ExtendedAtomics documentation (intel#1487) [SYCL][CUDA] Expose context extended deleters on PI API (intel#1483) [SYCL][NFC] Remove a dropped environment variable from a test (intel#1506) [SYCL] Add opencl-aot to sycl-toolchain target (intel#1504) [SYCL] Allow to run deploy LIT tests from particular directory [SYCL][CUDA] Fix LIT testing with CUDA devices (intel#1300) [SYCL] Remove operator name keywords (intel#1501) [Driver][SYCL] Consider .lo files as static archives (intel#1500) [SYCL-PTX] Update the compiler design to describe the CUDA target (intel#1408) [SYCL] Fix library build on Windows (intel#1499) [SYCL][NFC] Refactor lit.cfg.py (intel#1452) [SYCL] Fixed sub-buffer memory allocation update (intel#1486) [SYCL] Ensure proper definition of spirv builtins for SYCL (intel#1393) [SYCL][CUDA] LIT XFAIL/UNSUPPORTED (intel#1303) [SYCL][Doc] Function-type kernel attribute extension (intel#1494) [Driver][SYCL] Move include/sycl header before other system header locations (intel#1492) [BuildBot] Improve usability of buildbot scripts (intel#1472) [NFC] Add GitHub actions badges to README file (intel#1496) [SYCL] Improve error handling for kernel invocation (intel#1209) [SYCL][Driver] Fix SYCL standards' handling for '-fsycl -fsycl-device-only' invocations (intel#1371) ...

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

…_docs * origin/sycl: (42 commits) [SYCL][CUDA] Move interop tests (intel#1570) [Driver][SYCL] Remove COFF object format designator for Windows device compiles (intel#1574) [SYCL] Fix conflicting visibility attributes (intel#1571) [SYCL][DOC] Update the SYCL Runtime Interface document with design details (intel#680) [SYCL] Improve image accessors support on a host device (intel#1502) [SYCL] Make queue's non-USM event ownership temporary (intel#1561) [SYCL] Added support of rounding modes for non-host devices (intel#1463) [SYCL] SemaSYCL significant refactoring (intel#1517) [SYCL] Support 0-dim accessor in handler::copy(accessor, accessor) (intel#1551) [SYCL][NFC] Remove outdated sycl-check tool (intel#1563) [SYCL][Experimental] Reduce the set of optimizations for SYCL device (intel#1550) [Driver][SYCL][FPGA] Improve expected triple and link behaviors for AOCX files (intel#1549) [SYCL][NFC] Add a test for SYCL subdevice feature (intel#1554) [SYCL] Fix platform selection in opencl-aot (intel#1510) [SYCL][Driver] Enforce unique filenames when -save-temps is used (intel#1545) [SYCL] [xmethods] Allow replacing xmethod script (intel#1532) [SYCL] Add tests for inline asm feature (intel#1444) [SYCL][Doc] Add device_specific_kernel_queries extension. (intel#1540) [SYCL][USM] Remove unused header and unnecessary includes (intel#1537) Fix check-llvm dependencies (intel#1547) ...

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

sycl/examples/simple-dpcpp-app.cpp

sycl/include/CL/sycl/id.hpp

sycl/include/CL/sycl/queue.hpp

sycl/include/CL/sycl/types.hpp

bader · 2020-04-23T18:57:28Z

sycl/include/CL/sycl/ordered_queue.hpp

+/// Represents an in-order SYCL queue.
+///
+/// \deprecated Replaced by in_order queue property.
+/// \sa queue
+///
+/// \ingroup sycl_api


Suggested change

/// Represents an in-order SYCL queue.

///

/// \deprecated Replaced by in_order queue property.

/// \sa queue

///

/// \ingroup sycl_api

Do we need to expose this class in the documentation?

I decided to keep the deprecation notice and link to queue in doxygen, but remove the class from public page. Is it acceptable?

sycl/include/CL/sycl/event.hpp

sycl/include/CL/sycl/device_selector.hpp

turinevgeny

Looked only at types.hpp. LGTM.

README.md

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

…_docs * origin/sycl: [XPTI][Framework] Reference implementation of the Xpti framework to be used with instrumentation in SYCL (intel#1557) [SYCL] Initial ABI checks implementation (intel#1528) [SYCL] Support connection with multiple plugins (intel#1490) [SYCL] Add a new header file with the reduction class definition (intel#1558) [SYCL] Add test for SYCL kernels with accessor and spec constant (intel#1536)

bader

LGTM, just one nit.

Please, resolve the merge conflict.

sycl/examples/simple-dpcpp-app.cpp

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

…_docs * origin/sycl: (6482 commits) [SYCL][NFC] Clean formatting in Markdown documents (intel#1635) [SYCL][Doc] Remove obsolete parens from README (intel#1637) [SYCL] Fix failing ABI tests when LLVM_LIBDIR_SUFFIX is set (intel#1605) [SYCL] Fix warnings in libdevice (intel#1630) [SYCL][CUDA] Triage and clean LIT (intel#1620) [SYCL][NFC] Fix GCC 8 compilation warnings (intel#1631) [SYCL] Minor fixes in LowerWGScope [SYCL] PI: correct default interoperability plugin selection [SYCL] Add faster reduction implementations using atomic or/and intel::reduce() (intel#1615) [SYCL] Add sycl-ls utility for listing devices discovered/selected by SYCL RT (intel#1575) [SYCL] Fix getDeviceFromHandler declarations (intel#1626) [SPIR-V] Correct/improve declaration of SPIR-V builtins (intel#1519) [SYCL][USM] Improve USM allocator test and fix improper behavior. (intel#1538) [SYCL] Fix failing ABI LITs (intel#1622) [SYCL] Add support for MSVC internal math functions in device library (intel#1441) [SYCL] Add runtime library versioning (intel#1604) [SYCL] Check weak symbols in ABI dumps (intel#1609) [NFC][SYCL] Improve kernel metadata test (intel#1610) Revert "[SYCL] XFAIL LIT test due to duplicate diagnostic" (intel#1460) [SYCL] Move the reduction command group funcs out of handler.hpp (intel#1602) ...

…_docs * origin/sycl: [SYCL] Fix xmethod script deployment (intel#1645) [SYCL] Support scalar accessor in handler::copy(acc,ptr) and copy(ptr,acc) (intel#1634) [SYCL][CUDA] Reduction ext unsupported (intel#1641) [SYCL][NFC] Simplifying contribution guidelines (intel#1644)

bader · 2020-05-17T09:38:02Z

@alexbatashev, please, resolve the merge conflict.

…_docs * origin/sycl: (1867 commits) [SYCL] Implement USM vars and placeholder accessors passed to reduction (intel#1657) [SYCL] Fix post-commit testing (intel#1705) [SYCL][NFC] Remove multi_ptr<const void, Space>::operator multi_ptr<const void, Space> (intel#1702) [Doc] Readme update. (intel#1701) Support function pointers in cast instructions Adjust FPGA IVDep translation for embedded loops [SYCL] Fix host-to-host copy during copyback (intel#1692) [SYCL] Add information about dependencies used in CI [SYCL] Add runtime support for fsycl-id-queries-fit-in-int (intel#1685) Revert "Revert "[llvm][NFC] Cleanup uses of std::function in Inlining-related APIs"" StoreInst should store Align, not MaybeAlign [clang][slh] Add test for SLH feature checking macro [NFC] Deduplicate comment in PromoteMemoryToRegister.cpp [WebAssembly] Optimize splats of bitcasted vectors [LLD][ELF] Use offset in thin archives to disambiguate thinLTO members [AArch64][SVE] Implement AArch64ISD::SETCC_PRED [SVE] Restore broken LLVM-C ABI compatability IR: Remove extra name mangling from llvm.ptrmask [NFC] Whitespace fix inside OptParserEmitter [compiler-rt][CMAKE] Only add cmake link flags in standalone build ...

alexbatashev · 2020-05-18T19:57:51Z

@alexbatashev, please, resolve the merge conflict.

done

README.md

* sycl: (65 commits) [SYCL] Host task implementation (intel#1471) [SYCL] Update getting dependencies documentation (intel#1699) [SYCL] Fix types and transparent functors recognition in reduction (intel#1709) [SYCL][Doc] Get started guide clean-up (intel#1697) Add --spirv-fp-contract={on|off|fast} option (intel#509) [SYCL][Doc] Fix tbb target path in Get Started Guide. (intel#1695) [SYCL] Add support for kernel name types templated using enums. (intel#1675) [Driver][SYCL] Make -std=c++17 the default for DPC++ (intel#1662) AllocaInst should store Align instead of MaybeAlign. [X86] Replace selectScalarSSELoad ComplexPattern with PatFrags to handle the 3 types of loads we currently match. Harden IR and bitcode parsers against infinite size types. Revert "[nfc] test commit" [nfc] test commit Expose IRGen API to add the default IR attributes to a function definition. The release notes for ObjCBreakBeforeNestedBlockParam was placed between the release note for IndentCaseBlocks and its example code [VectorCombine] forward walk through instructions to improve chaining of transforms [PhaseOrdering] add vector reduction tests; NFC [InstCombine] Clean up alignment handling (NFC) [ARM] Patterns for VQSHRN [VectorCombine] add reduction-like patterns; NFC ...

pvchupin · 2020-05-26T20:59:11Z

README.md

@@ -22,7 +22,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
 ## Sub-projects Documentation

 * oneAPI Data Parallel C++ compiler - See
-  [GetStartedGuide.md](sycl/doc/GetStartedGuide.md)
+  [DPC++ Documentation](https://intel.github.io/llvm-docs/)


Link doesn't work now. Is it expected?

Yes, this patch also renames contents.html to index.html, so the link will work.

bader · 2020-05-27T11:05:38Z

@turinevgeny, @againull, @intel/llvm-reviewers-runtime, ping.

turinevgeny

types.hpp looks good.

sergey-semenov · 2020-05-27T11:21:09Z

sycl/source/device_selector.cpp

@@ -77,6 +77,11 @@ device device_selector::select_device() const {
                                PI_DEVICE_NOT_FOUND);
 }

+/// Devices of different kinds are prioritized in the following order:
+/// 1. GPU
+/// 2. Accelerator


That's no longer the case for accelerators as of b217bc5

@sergey-semenov is it ok if I fix this right after this PR lands?

Switched the visitCallDot check to use isFloatingPointTy for scalar floating point operands. Bugfix for previous change regarding integer dot product. Original commit: KhronosGroup/SPIRV-LLVM-Translator@71e01b5

Alexander Batashev added 8 commits March 28, 2020 19:19

Restructure docs

3df80d2

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

Minor updates

5680e74

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

Address example comments

fab13a4

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

Fix config

175777c

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

Remove repeated link

6ce877d

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

alexbatashev requested review from againull, bader, jbrodman, kbobrovs, pvchupin, turinevgeny and a team as code owners April 23, 2020 14:11

alexbatashev requested a review from sergey-semenov April 23, 2020 14:11

s-kanaev reviewed Apr 23, 2020

View reviewed changes

sycl/examples/simple-dpcpp-app.cpp Show resolved Hide resolved

bader reviewed Apr 23, 2020

View reviewed changes

turinevgeny previously approved these changes Apr 24, 2020

View reviewed changes

againull previously approved these changes Apr 24, 2020

View reviewed changes

pvchupin previously approved these changes Apr 24, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

Alexander Batashev added 2 commits April 26, 2020 22:31

React to comments

2bc4535

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

alexbatashev dismissed stale reviews from pvchupin, againull, and turinevgeny via d120b47 April 26, 2020 19:34

bader reviewed May 1, 2020

View reviewed changes

sycl/examples/simple-dpcpp-app.cpp Outdated Show resolved Hide resolved

sycl/examples/simple-dpcpp-app.cpp Outdated Show resolved Hide resolved

Alexander Batashev added 3 commits May 6, 2020 11:09

Resolve comments

df3658b

Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>

pvchupin suggested changes May 18, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

Cleanup merge leftovers

1caa683

alexbatashev requested review from pvchupin, bader, s-kanaev, againull and turinevgeny May 19, 2020 07:31

pvchupin reviewed May 20, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

pvchupin self-requested a review May 20, 2020 00:24

Alexander Batashev added 4 commits May 20, 2020 12:54

Address review comments

37c6596

Return blank line to README

ca9ed9f

More fixes

1b40d54

bader approved these changes May 25, 2020

View reviewed changes

pvchupin approved these changes May 26, 2020

View reviewed changes

turinevgeny approved these changes May 27, 2020

View reviewed changes

sergey-semenov reviewed May 27, 2020

View reviewed changes

sergey-semenov approved these changes May 27, 2020

View reviewed changes

againull approved these changes May 27, 2020

View reviewed changes

bader merged commit 98b6ee4 into intel:sycl May 28, 2020

alexbatashev deleted the private/abatashe/user_docs branch July 28, 2021 06:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SYCL][Doc] Render user API classes on a dedicated page #1578

[SYCL][Doc] Render user API classes on a dedicated page #1578

alexbatashev commented Apr 23, 2020

bader Apr 23, 2020

alexbatashev Apr 26, 2020

turinevgeny left a comment

bader left a comment

bader commented May 17, 2020

alexbatashev commented May 18, 2020

pvchupin May 26, 2020

alexbatashev May 27, 2020 •

edited

Loading

bader commented May 27, 2020

turinevgeny left a comment

sergey-semenov May 27, 2020

alexbatashev May 27, 2020

sergey-semenov May 27, 2020

[SYCL][Doc] Render user API classes on a dedicated page #1578

[SYCL][Doc] Render user API classes on a dedicated page #1578

Conversation

alexbatashev commented Apr 23, 2020

bader Apr 23, 2020

Choose a reason for hiding this comment

alexbatashev Apr 26, 2020

Choose a reason for hiding this comment

turinevgeny left a comment

Choose a reason for hiding this comment

bader left a comment

Choose a reason for hiding this comment

bader commented May 17, 2020

alexbatashev commented May 18, 2020

pvchupin May 26, 2020

Choose a reason for hiding this comment

alexbatashev May 27, 2020 • edited Loading

Choose a reason for hiding this comment

bader commented May 27, 2020

turinevgeny left a comment

Choose a reason for hiding this comment

sergey-semenov May 27, 2020

Choose a reason for hiding this comment

alexbatashev May 27, 2020

Choose a reason for hiding this comment

sergey-semenov May 27, 2020

Choose a reason for hiding this comment

alexbatashev May 27, 2020 •

edited

Loading