Add documentation for `any_resource` #2309

miscco · 2024-08-28T09:51:33Z

The docs weren building properly, so add some

github-actions · 2024-08-28T10:05:30Z

🟩 CI finished in 12m 43s: Pass: 100%/56 | Total: 2h 34m | Avg: 2m 46s | Max: 12m 06s | Hits: 78%/112

🟩 cudax: Pass: 100%/55 | Total: 2h 22m | Avg: 2m 35s | Max: 10m 05s | Hits: 78%/112

🟩 cpu
  🟩 amd64              Pass: 100%/51  | Total:  2h 15m | Avg:  2m 39s | Max: 10m 05s | Hits:  78%/112   
  🟩 arm64              Pass: 100%/4   | Total:  7m 33s | Avg:  1m 53s | Max:  2m 43s
🟩 ctk
  🟩 12.0               Pass: 100%/23  | Total:  1h 01m | Avg:  2m 41s | Max: 10m 05s | Hits:  78%/56    
  🟩 12.5               Pass: 100%/32  | Total:  1h 21m | Avg:  2m 32s | Max:  8m 50s | Hits:  78%/56    
🟩 cudacxx
  🟩 nvcc12.0           Pass: 100%/23  | Total:  1h 01m | Avg:  2m 41s | Max: 10m 05s | Hits:  78%/56    
  🟩 nvcc12.5           Pass: 100%/32  | Total:  1h 21m | Avg:  2m 32s | Max:  8m 50s | Hits:  78%/56    
🟩 cudacxx_family
  🟩 nvcc               Pass: 100%/55  | Total:  2h 22m | Avg:  2m 35s | Max: 10m 05s | Hits:  78%/112   
🟩 cxx
  🟩 Clang9             Pass: 100%/2   | Total:  4m 26s | Avg:  2m 13s | Max:  2m 17s
  🟩 Clang10            Pass: 100%/2   | Total:  4m 09s | Avg:  2m 04s | Max:  2m 07s
  🟩 Clang11            Pass: 100%/4   | Total:  8m 11s | Avg:  2m 02s | Max:  2m 18s
  🟩 Clang12            Pass: 100%/4   | Total:  7m 49s | Avg:  1m 57s | Max:  2m 04s
  🟩 Clang13            Pass: 100%/4   | Total:  7m 59s | Avg:  1m 59s | Max:  2m 07s
  🟩 Clang14            Pass: 100%/6   | Total: 16m 14s | Avg:  2m 42s | Max:  4m 06s
  🟩 Clang15            Pass: 100%/2   | Total:  4m 13s | Avg:  2m 06s | Max:  2m 10s
  🟩 Clang16            Pass: 100%/6   | Total: 17m 25s | Avg:  2m 54s | Max:  4m 27s
  🟩 GCC9               Pass: 100%/2   | Total:  3m 34s | Avg:  1m 47s | Max:  1m 48s
  🟩 GCC10              Pass: 100%/4   | Total:  7m 36s | Avg:  1m 54s | Max:  1m 58s
  🟩 GCC11              Pass: 100%/4   | Total:  8m 07s | Avg:  2m 01s | Max:  2m 11s
  🟩 GCC12              Pass: 100%/12  | Total: 31m 30s | Avg:  2m 37s | Max:  4m 26s
  🟩 Intel2023.2.0      Pass: 100%/1   | Total:  2m 44s | Avg:  2m 44s | Max:  2m 44s
  🟩 MSVC14.36          Pass: 100%/1   | Total: 10m 05s | Avg: 10m 05s | Max: 10m 05s | Hits:  78%/56    
  🟩 MSVC14.39          Pass: 100%/1   | Total:  8m 50s | Avg:  8m 50s | Max:  8m 50s | Hits:  78%/56    
🟩 cxx_family
  🟩 Clang              Pass: 100%/30  | Total:  1h 10m | Avg:  2m 20s | Max:  4m 27s
  🟩 GCC                Pass: 100%/22  | Total: 50m 47s | Avg:  2m 18s | Max:  4m 26s
  🟩 Intel              Pass: 100%/1   | Total:  2m 44s | Avg:  2m 44s | Max:  2m 44s
  🟩 MSVC               Pass: 100%/2   | Total: 18m 55s | Avg:  9m 27s | Max: 10m 05s | Hits:  78%/112   
🟩 gpu
  🟩 v100               Pass: 100%/55  | Total:  2h 22m | Avg:  2m 35s | Max: 10m 05s | Hits:  78%/112   
🟩 jobs
  🟩 Build              Pass: 100%/47  | Total:  1h 50m | Avg:  2m 21s | Max: 10m 05s | Hits:  78%/112   
  🟩 Test               Pass: 100%/8   | Total: 32m 03s | Avg:  4m 00s | Max:  4m 27s
🟩 sm
  🟩 90                 Pass: 100%/1   | Total:  2m 07s | Avg:  2m 07s | Max:  2m 07s
  🟩 90a                Pass: 100%/1   | Total:  1m 56s | Avg:  1m 56s | Max:  1m 56s
🟩 std
  🟩 17                 Pass: 100%/31  | Total:  1h 11m | Avg:  2m 18s | Max:  4m 27s
  🟩 20                 Pass: 100%/24  | Total:  1h 11m | Avg:  2m 58s | Max: 10m 05s | Hits:  78%/112

🟩 pycuda: Pass: 100%/1 | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s

🟩 cpu
  🟩 amd64              Pass: 100%/1   | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s
🟩 ctk
  🟩 12.5               Pass: 100%/1   | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s
🟩 cudacxx
  🟩 nvcc12.5           Pass: 100%/1   | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s
🟩 cudacxx_family
  🟩 nvcc               Pass: 100%/1   | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s
🟩 cxx
  🟩 GCC13              Pass: 100%/1   | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s
🟩 cxx_family
  🟩 GCC                Pass: 100%/1   | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s
🟩 gpu
  🟩 v100               Pass: 100%/1   | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s
🟩 jobs
  🟩 Test               Pass: 100%/1   | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s

👃 Inspect Changes

Modifications in project?

	Project
	CCCL Infrastructure
	libcu++
	CUB
	Thrust
+/-	CUDA Experimental
	pycuda

Modifications in project or dependencies?

	Project
	CCCL Infrastructure
	libcu++
	CUB
	Thrust
+/-	CUDA Experimental
+/-	pycuda

🏃‍ Runner counts (total jobs: 56)

#	Runner
41	`linux-amd64-cpu16`
9	`linux-amd64-gpu-v100-latest-1`
4	`linux-arm64-cpu16`
2	`windows-amd64-cpu16`

cudax/include/cuda/experimental/__memory_resource/any_resource.h

Co-authored-by: Bernhard Manfred Gruber <[email protected]>

github-actions · 2024-08-28T14:44:57Z

🟩 CI finished in 2h 07m: Pass: 100%/56 | Total: 2h 37m | Avg: 2m 48s | Max: 11m 03s | Hits: 83%/112

🟩 cudax: Pass: 100%/55 | Total: 2h 26m | Avg: 2m 39s | Max: 11m 03s | Hits: 83%/112

🟩 cpu
  🟩 amd64              Pass: 100%/51  | Total:  2h 17m | Avg:  2m 41s | Max: 11m 03s | Hits:  83%/112   
  🟩 arm64              Pass: 100%/4   | Total:  8m 56s | Avg:  2m 14s | Max:  2m 46s
🟩 ctk
  🟩 12.0               Pass: 100%/23  | Total:  1h 03m | Avg:  2m 46s | Max: 11m 03s | Hits:  83%/56    
  🟩 12.5               Pass: 100%/32  | Total:  1h 22m | Avg:  2m 34s | Max:  8m 11s | Hits:  83%/56    
🟩 cudacxx
  🟩 nvcc12.0           Pass: 100%/23  | Total:  1h 03m | Avg:  2m 46s | Max: 11m 03s | Hits:  83%/56    
  🟩 nvcc12.5           Pass: 100%/32  | Total:  1h 22m | Avg:  2m 34s | Max:  8m 11s | Hits:  83%/56    
🟩 cudacxx_family
  🟩 nvcc               Pass: 100%/55  | Total:  2h 26m | Avg:  2m 39s | Max: 11m 03s | Hits:  83%/112   
🟩 cxx
  🟩 Clang9             Pass: 100%/2   | Total:  4m 14s | Avg:  2m 07s | Max:  2m 11s
  🟩 Clang10            Pass: 100%/2   | Total:  3m 57s | Avg:  1m 58s | Max:  2m 00s
  🟩 Clang11            Pass: 100%/4   | Total:  8m 36s | Avg:  2m 09s | Max:  2m 37s
  🟩 Clang12            Pass: 100%/4   | Total:  8m 20s | Avg:  2m 05s | Max:  2m 15s
  🟩 Clang13            Pass: 100%/4   | Total:  8m 43s | Avg:  2m 10s | Max:  2m 31s
  🟩 Clang14            Pass: 100%/6   | Total: 16m 09s | Avg:  2m 41s | Max:  3m 53s
  🟩 Clang15            Pass: 100%/2   | Total:  4m 20s | Avg:  2m 10s | Max:  2m 12s
  🟩 Clang16            Pass: 100%/6   | Total: 17m 31s | Avg:  2m 55s | Max:  4m 10s
  🟩 GCC9               Pass: 100%/2   | Total:  4m 14s | Avg:  2m 07s | Max:  2m 12s
  🟩 GCC10              Pass: 100%/4   | Total:  9m 50s | Avg:  2m 27s | Max:  3m 00s
  🟩 GCC11              Pass: 100%/4   | Total:  7m 33s | Avg:  1m 53s | Max:  2m 07s
  🟩 GCC12              Pass: 100%/12  | Total: 30m 50s | Avg:  2m 34s | Max:  4m 05s
  🟩 Intel2023.2.0      Pass: 100%/1   | Total:  2m 45s | Avg:  2m 45s | Max:  2m 45s
  🟩 MSVC14.36          Pass: 100%/1   | Total: 11m 03s | Avg: 11m 03s | Max: 11m 03s | Hits:  83%/56    
  🟩 MSVC14.39          Pass: 100%/1   | Total:  8m 11s | Avg:  8m 11s | Max:  8m 11s | Hits:  83%/56    
🟩 cxx_family
  🟩 Clang              Pass: 100%/30  | Total:  1h 11m | Avg:  2m 23s | Max:  4m 10s
  🟩 GCC                Pass: 100%/22  | Total: 52m 27s | Avg:  2m 23s | Max:  4m 05s
  🟩 Intel              Pass: 100%/1   | Total:  2m 45s | Avg:  2m 45s | Max:  2m 45s
  🟩 MSVC               Pass: 100%/2   | Total: 19m 14s | Avg:  9m 37s | Max: 11m 03s | Hits:  83%/112   
🟩 gpu
  🟩 v100               Pass: 100%/55  | Total:  2h 26m | Avg:  2m 39s | Max: 11m 03s | Hits:  83%/112   
🟩 jobs
  🟩 Build              Pass: 100%/47  | Total:  1h 55m | Avg:  2m 27s | Max: 11m 03s | Hits:  83%/112   
  🟩 Test               Pass: 100%/8   | Total: 30m 57s | Avg:  3m 52s | Max:  4m 10s
🟩 sm
  🟩 90                 Pass: 100%/1   | Total:  1m 54s | Avg:  1m 54s | Max:  1m 54s
  🟩 90a                Pass: 100%/1   | Total:  1m 59s | Avg:  1m 59s | Max:  1m 59s
🟩 std
  🟩 17                 Pass: 100%/31  | Total:  1h 13m | Avg:  2m 22s | Max:  4m 05s
  🟩 20                 Pass: 100%/24  | Total:  1h 12m | Avg:  3m 01s | Max: 11m 03s | Hits:  83%/112

🟩 pycuda: Pass: 100%/1 | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s

🟩 cpu
  🟩 amd64              Pass: 100%/1   | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s
🟩 ctk
  🟩 12.5               Pass: 100%/1   | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s
🟩 cudacxx
  🟩 nvcc12.5           Pass: 100%/1   | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s
🟩 cudacxx_family
  🟩 nvcc               Pass: 100%/1   | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s
🟩 cxx
  🟩 GCC13              Pass: 100%/1   | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s
🟩 cxx_family
  🟩 GCC                Pass: 100%/1   | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s
🟩 gpu
  🟩 v100               Pass: 100%/1   | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s
🟩 jobs
  🟩 Test               Pass: 100%/1   | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s

👃 Inspect Changes

Modifications in project?

	Project
	CCCL Infrastructure
	libcu++
	CUB
	Thrust
+/-	CUDA Experimental
	pycuda

Modifications in project or dependencies?

	Project
	CCCL Infrastructure
	libcu++
	CUB
	Thrust
+/-	CUDA Experimental
+/-	pycuda

🏃‍ Runner counts (total jobs: 56)

#	Runner
41	`linux-amd64-cpu16`
9	`linux-amd64-gpu-v100-latest-1`
4	`linux-arm64-cpu16`
2	`windows-amd64-cpu16`

ericniebler

a few questions, otherwise looks good. thanks. i will be better about documenting my public additions.

ericniebler · 2024-08-28T15:46:39Z

cudax/include/cuda/experimental/__memory_resource/any_resource.h

+//! ``basic_any_resource`` abstracts the differences between a resource and an async resource away, allowing efficient
+//! interoperability between the two.


i'm not sure what this is referring to. any_resource and any_async_resource are different types with different interfaces. the differences haven 't been abstracted away.

ericniebler · 2024-08-28T15:48:44Z

cudax/include/cuda/experimental/__memory_resource/any_resource.h

@@ -95,10 +105,12 @@ class basic_any_resource
    }
  }

-#ifndef DOXYGEN_SHOULD_SKIP_THIS // Doxygen misparses the below constructor, so dumb it down for it.
+  //! @brief Conversion from a \c basic_any_resource with the same set of properties but in a different order.


i think we should require properties to have a UUID. that way we can have a canonical global ordering of properties. not for this PR obviously.

ericniebler · 2024-08-28T15:51:02Z

cudax/include/cuda/experimental/__memory_resource/any_resource.h

  _LIBCUDACXX_TEMPLATE(_CUDA_VMR::_AllocType _OtherAllocType, class... _OtherProperties)
  _LIBCUDACXX_REQUIRES(
-    _CUDA_VSTD::_IsNotSame<basic_any_resource, basic_any_resource<_OtherAllocType, _OtherProperties...>>::value
+    (_CUDA_VSTD::_IsNotSame<basic_any_resource, basic_any_resource<_OtherAllocType, _OtherProperties...>>::value)


ah, much better. thanks.

ericniebler · 2024-08-28T15:58:30Z

docs/repo.toml

+  "_LIBCUDACXX_REQUIRES(x)= ::cuda::std::__enable_if_t<x, int> = 0>",
+  "_LIBCUDACXX_TEMPLATE(x)=template<x, ",


do we really want our docs to have the enable_if gunk?

The issue is that doxygen does not support requires so we either have SFINAE or nothing

Add documentation for any_resource

3baf7dd

miscco requested review from a team as code owners August 28, 2024 09:51

miscco requested a review from griwes August 28, 2024 09:51

bernhardmgruber approved these changes Aug 28, 2024

View reviewed changes

Apply suggestions from code review

bd30484

Co-authored-by: Bernhard Manfred Gruber <[email protected]>

miscco enabled auto-merge (squash) August 28, 2024 12:36

ericniebler reviewed Aug 28, 2024

View reviewed changes

ericniebler approved these changes Aug 28, 2024

View reviewed changes

miscco merged commit 7d4be26 into NVIDIA:main Aug 28, 2024
71 checks passed

miscco deleted the any_resource_docs branch August 28, 2024 16:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for `any_resource` #2309

Add documentation for `any_resource` #2309

miscco commented Aug 28, 2024

github-actions bot commented Aug 28, 2024

🟩 cudax: Pass: 100%/55 | Total: 2h 22m | Avg: 2m 35s | Max: 10m 05s | Hits: 78%/112

🟩 pycuda: Pass: 100%/1 | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s

👃 Inspect Changes

Modifications in project?

Modifications in project or dependencies?

🏃‍ Runner counts (total jobs: 56)

github-actions bot commented Aug 28, 2024

🟩 cudax: Pass: 100%/55 | Total: 2h 26m | Avg: 2m 39s | Max: 11m 03s | Hits: 83%/112

🟩 pycuda: Pass: 100%/1 | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s

👃 Inspect Changes

Modifications in project?

Modifications in project or dependencies?

🏃‍ Runner counts (total jobs: 56)

ericniebler left a comment

ericniebler Aug 28, 2024

ericniebler Aug 28, 2024

ericniebler Aug 28, 2024

ericniebler Aug 28, 2024

miscco Aug 28, 2024

		//! ``basic_any_resource`` abstracts the differences between a resource and an async resource away, allowing efficient
		//! interoperability between the two.

		"_LIBCUDACXX_REQUIRES(x)= ::cuda::std::__enable_if_t<x, int> = 0>",
		"_LIBCUDACXX_TEMPLATE(x)=template<x, ",

Add documentation for any_resource #2309

Add documentation for any_resource #2309

Conversation

miscco commented Aug 28, 2024

github-actions bot commented Aug 28, 2024

🟩 cudax: Pass: 100%/55 | Total: 2h 22m | Avg: 2m 35s | Max: 10m 05s | Hits: 78%/112

🟩 pycuda: Pass: 100%/1 | Total: 12m 06s | Avg: 12m 06s | Max: 12m 06s

👃 Inspect Changes

Modifications in project?

Modifications in project or dependencies?

🏃‍ Runner counts (total jobs: 56)

github-actions bot commented Aug 28, 2024

🟩 cudax: Pass: 100%/55 | Total: 2h 26m | Avg: 2m 39s | Max: 11m 03s | Hits: 83%/112

🟩 pycuda: Pass: 100%/1 | Total: 11m 00s | Avg: 11m 00s | Max: 11m 00s

👃 Inspect Changes

Modifications in project?

Modifications in project or dependencies?

🏃‍ Runner counts (total jobs: 56)

ericniebler left a comment

Choose a reason for hiding this comment

ericniebler Aug 28, 2024

Choose a reason for hiding this comment

ericniebler Aug 28, 2024

Choose a reason for hiding this comment

ericniebler Aug 28, 2024

Choose a reason for hiding this comment

ericniebler Aug 28, 2024

Choose a reason for hiding this comment

miscco Aug 28, 2024

Choose a reason for hiding this comment

Add documentation for `any_resource` #2309

Add documentation for `any_resource` #2309