Documentation Issues

Topics to be covered (User’s Guide)

• source link dead: https://docs.cupy.dev/en/stable/reference/generated/cupy.cuda.using_allocator.html (#6126)
• some functions are undocumented (e.g. cupy.conjugate): https://docs.cupy.dev/en/stable/reference/comparison.html (fixed via #4945)
• Cover pitfalls in multi-thread (e.g., the default device is 0 so you will need to setDevice) and multi-process (e.g., do not use fork after using CUDA) c.f. #7110

Topics to be covered (API Reference)

• Add notes for cupy.cuda.profiler.initialize, saying that this feature is deprecated in CUDA Toolkit and may be removed in future versions

Broken docstring formats (easy to fix, contribution welcome!)

• https://docs.cupy.dev/en/latest/reference/generated/cupy.cuda.using_allocator.html
• https://docs.cupy.dev/en/latest/reference/generated/cupyx.distributed.init_process_group.html > Returns:
• https://docs.cupy.dev/en/stable/reference/generated/cupyx.scipy.ndimage.affine_transform.html > texture_memory

Outdated docstrings (easy to fix, contribution welcome!)

• cupy.asarray docstring says This function currently does not support the order option. but this is no longer valid and should be removed.

[leofang]

@kmaehashi I’d like to have a new page added to “Tutorial”, placed between “Basics of CuPy” and “User-Defined Kernels”. I am thinking to call it “Advanced Tricks of Using CuPy”, in which we cover (a) a number of topics that advanced users would appreciate and (b) a number of items in which we invested efforts and would like users to try and give us feedbacks. My current list is:

• How to use streams and events (we can mention PTDS here)
• How to measure GPU time correctly (Ans: use cupyx.time.repeat)
• Advanced FFT usage (cuFFT plan as context manager, inspect/manipulate the plan cache, multi-GPU FFT, callbacks, etc)
• Link to “Interoperability”
• Kernel autotuning with Optuna
• CUB/cuTENSOR Backend (a demo using sum to show the speedup)
• …what else? Comments and suggestions are welcome!

I’d also like to add a few more examples for RawModule (in “User-Defined Kernels”), mainly to show what can be done with the new options:

• translate_cucomplex
• name_expressions
• jitify

I am hoping to get all these done in time before the code-freeze for v9.0.0, but we’ll see…

[leofang]

I can also send it if you like.

Ongoing in #5093. I don’t think I have time to cover everything I wanted to add before the v9 code frozen, but it’s a start…