Add get_upstream_resource method to stream_checking_resource_adaptor
#15203
Conversation
Also deprecate `get_upstream` as we want to get away from raw upstreams
|
@harrism can you set the labels etc, I do not have any permissions in cudf |
| * @brief Return pointer to the upstream resource. | ||
| * | ||
| * @return Pointer to the upstream resource. | ||
| * @briefreturn{rmm::device_async_resource_ref to the upstream resource} |
There was a problem hiding this comment.
Can you change this back?
There was a problem hiding this comment.
I can yeah, I would note that this is what we settled on in rmm
There was a problem hiding this comment.
This macro was created by @vyasr to clean up repetitive documentation in exactly this situation of documenting getters. Why did you want it changed back, @davidwendt ?
There was a problem hiding this comment.
It is not a standard doxygen tag. This macro is implemented in rmm but not cudf.
This header is not included in the published docs (and not actually processed by doxygen) so I'd rather it be more decipherable to humans in the source text here.
There was a problem hiding this comment.
Ah, I thought the macro was centralized for RAPIDS. I'm guessing @vyasr will add it once cuDF moves to unified C++/Python docs.
davidwendt
added
3 - Ready for Review
| } | ||
|
|
||
| /** | ||
| * @briefreturn{Upstream* to the upstream memory resource} |
| @@ -73,11 +73,7 @@ class stream_checking_resource_adaptor final : public rmm::mr::device_memory_res | |||
| * | |||
| * @return Pointer to the upstream resource. | |||
| */ | |||
| [[deprecated("Use get_upstream_resource instead")]] [[nodiscard]] Upstream* get_upstream() | |||
There was a problem hiding this comment.
In the cudf case this is only used in tests. As long as all the tests are updated to not call this method it's perfectly fine to deprecate, and probably even to remove it without deprecation (since it's internal to libcudf unit tests).
|
@davidwendt I removed the From my point this is ready to be merged |
|
/merge |
Also remove
get_upstreamas we want to get away from raw upstreams