Open kmaehashi opened 3 years ago
It'd be nice to also document cupyx.time.repeat
and mention it in, say, the tutorial, for how to perform a fair timing.
related: #3692
I don't remember where we discussed this (sorry!), but we should also document common ROCm/HIP pitfalls.
@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:
sum
to show the speedup)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....
Thanks Leo! These docs would definitely help users 😄 I feel however these topics are more than "Tutorial" things. (that's why I reverted this: #4857) I'm thinking it's better to rename "Tutorial" to "User Guide" following NumPy's docs: https://numpy.org/devdocs/user/index.html Then we can move topics like Interoperability, Memory Management, API Compatibility Policy, Difference between CuPy and NumPy, License, etc. to there, instead of wildcard "API Reference" section.
Some other topics I would cover is #1566.
I'm thinking it's better to rename "Tutorial" to "User Guide" following NumPy's docs: https://numpy.org/devdocs/user/index.html Then we can move topics like Interoperability, Memory Management, API Compatibility Policy, Difference between CuPy and NumPy, License, etc. to there, instead of wildcard "API Reference" section.
Sounds good, @kmaehashi! If you send a restructuring PR for this I'll be able to build upon it. I can also send it if you like.
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...
Topics to be covered (User's Guide)
cupy.conjugate
): https://docs.cupy.dev/en/stable/reference/comparison.html (fixed via #4945)Topics to be covered (API Reference)
cupy.cuda.profiler.initialize
, saying that this feature is deprecated in CUDA Toolkit and may be removed in future versionsBroken docstring formats (easy to fix, contribution welcome!)
Returns:
texture_memory
scipy.special.erf()
Outdated docstrings (easy to fix, contribution welcome!)
cupy.asarray
docstring saysThis function currently does not support the order option.
but this is no longer valid and should be removed.