Skip to content

[Doc] Add documentation for Docker images #4778

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.

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

Merged
merged 6 commits into from
Dec 20, 2021

Conversation

alexbatashev
Copy link
Contributor

Describe some useful tips and best known methods for building DPC++ compiler inside Docker images.

@@ -26,6 +26,7 @@ sycl/ReleaseNotes.md @pvchupin @tfzhu
sycl/doc/ @pvchupin @bader
sycl/doc/extensions/ @intel/dpcpp-specification-reviewers
sycl/doc/SPIRV @AlexeySotkin @bashbaug @mbelicki
sycl/doc/dev @bader @vladimirlaz
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bader @vladimirlaz folks, I hope you don't mind

bader
bader previously approved these changes Oct 18, 2021
`latest`, that uses latest available drivers, and `stable`, that uses
recommended drivers.
- `ghcr.io/intel/llvm/ubuntu2004_nightly`: contains latest successfully built
nightly build of DPC++ compiler, as well as pre-installed Intel drivers.
Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose this image uses Intel drivers from the stable tag. Right?
Is it possible to trigger the build of the container with latest Intel drivers in GitHub Actions manually?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you mean from CI? I think I can make that possible. Otherwise, Dockerfiles have base_tag argument, so you can build with any tag (i.e. latest or a particular commit hash) locally.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes. The scenario I'm thinking about is using CI to build the image, which I can use locally (because I can't or don't want to build the image locally).

bader pushed a commit that referenced this pull request Dec 1, 2021
This pull request is a follow-up on #4754, that adds two more Docker containers: a container with Intel drivers installed and a container with pre-installed nightly build of DPC++ from this repository.

"Intel drivers" container includes all the latest version of low-level runtimes for Intel devices.

The "nightly" container is derived from "Intel drivers" container, and provides the latest nightly build of SYCL.

Requires: #4773
Documentation: #4778
* upstream/sycl: (5961 commits)
  [SYCL] Implement discard_events extension (intel#5026)
  [SYCL][NFC] Fix unused parameter warning in piQueueFlush (intel#5139)
  [SYCL][XPTI] Fix static analysis tool warnings (intel#5040)
  [CI] Switch post-commit jobs to self-hosted runners (intel#5147)
  [SYCL] Fix support for classes implicitly converted from items in parallel_for (intel#5118)
  [SYCL][HIP] Fix platform query in USM alloc info (intel#5140)
  [Docker] Add workarounds for two SYCL issues (intel#5143)
  [CI] Install cm-compiler in drivers image (intel#5128)
  [ESIMD] Add support for an arbitrary number of elements to simd::copy_from/to (intel#5135)
  [SYCL] Add number HW threads per EU query (intel#4901)
  [CI] Refactor workflow files (intel#5134)
  [CI] Enable HIP and CUDA plugins in GitHub Actions builds (intel#5087)
  [SYCL] Implement queue flushing (intel#5052)
  Disable issue labeler in LLVM forks
  Modify translation for disable_loop_pipelining metadata
  Add SPIR-V friendly translation for OpLoad and OpStore
  Fix return type postfix for SPIR-V Friendly IR
  Restrict special handling of sampler OpVariable only to UniformConstant
  Add lowering for llvm.bswap intrinsic
  Fix translation of OpVariable with OpSamplerType
  ...
@alexbatashev alexbatashev marked this pull request as ready for review December 15, 2021 15:03
Alexander Batashev and others added 2 commits December 15, 2021 18:04
Co-authored-by: vladimirlaz <vladimir.lazarev@intel.com>
@bader bader requested a review from vladimirlaz December 18, 2021 12:27
bader
bader previously approved these changes Dec 18, 2021
Comment on lines 56 to 65

This command will download an image if it does not exist locally. If you've
downloaded an image previously, and you want to update it, use
`docker pull <image_name>` command.

## Persisting data

This command will download an image, if it does not exist locally. If you've
downloaded an image previously, and you want to update it, use
`docker pull <image_name>` command.
Copy link
Contributor

Choose a reason for hiding this comment

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

This section is repeated twice. I think we can remove one instance.

vladimirlaz
vladimirlaz previously approved these changes Dec 20, 2021
@alexbatashev alexbatashev dismissed stale reviews from vladimirlaz and bader via 8063875 December 20, 2021 11:27
@bader bader merged commit 76cb2d5 into intel:sycl Dec 20, 2021
alexbatashev added a commit to alexbatashev/llvm that referenced this pull request Dec 23, 2021
* upstream/sycl: (1382 commits)
  [SYCL][XPTI] Report memory allocation info from SYCL runtime (intel#5172)
  [CI] Switch labels for OCL x64 job (intel#5185)
  [SYCL] Add basic support for the generic_space address space (intel#5148)
  [CI] Update CODEOWNERS for SYCL printf support passes (intel#5199)
  [SYCL][Matrix] Enable wi_slice for joint_matrix (intel#4979)
  [SYCL][Group algorithms] Move group sort extension to experimental (intel#5169)
  [SYCL] Fix kernel bundles don't really carry kernel IDs (intel#5121)
  [SYCL] Initial printf support for non-constant AS format strings (intel#5069)
  [SYCL][NFC] Fix static code analysis concerns (intel#5189)
  [SYCL][Doc] Fix typos to fix doc build (intel#5190)
  [Driver][SYCL] Turn on -fsycl-dead-args-optimization by default (intel#3004)
  [SYCL][L0][Plugin] Add support for batching copy commands (intel#5155)
  [CI] Add cache checkout script to docker containers (intel#5184)
  [SYCL][Doc] Add HIP backend to the filter selector (intel#5176)
  [Doc] Add documentation for Docker images (intel#4778)
  [LIBCLC] Add functionality for in-kernel asserts for CUDA backend (intel#5174)
  Force opt to use new pass manager in exponential-deferred-inlining test after a8c2ba1
  [SYCL] Add vec and marray support to known_identity type trait (intel#5163)
  Correctly resolve merge conflicts
  Update SPV_INTEL_hw_thread_queries to rev 2
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants