Skip to content
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

[REVIEW] Make documentation uniform for stream and memory resource params #5216

Merged
merged 47 commits into from
May 27, 2020

Conversation

karthikeyann
Copy link
Contributor

@karthikeyann karthikeyann commented May 18, 2020

Update documentation common params such as mr, stream.

  • param mr device memory resource (taken input from "culture of quality" series)
  • param stream CUDA stream

@karthikeyann karthikeyann requested a review from a team as a code owner May 18, 2020 16:12
@GPUtester
Copy link
Collaborator

Please update the changelog in order to start CI tests.

View the gpuCI docs here.

@karthikeyann karthikeyann changed the title update documentation uniformly for param [WIP] update documentation uniformly for param May 18, 2020
@karthikeyann karthikeyann added the doc Documentation label May 18, 2020
Copy link
Contributor

@devavret devavret left a comment

Choose a reason for hiding this comment

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

Can you base this on #5069. Much of detail documentation has been removed

@karthikeyann
Copy link
Contributor Author

cudf::strings::all_float(), cudf::strings::all_integer() accepts device memory resource in arguments. but it is not used inside.

bool all_float(strings_column_view const& strings,
rmm::mr::device_memory_resource* mr = rmm::mr::get_default_resource());

bool all_integer(strings_column_view const& strings,
rmm::mr::device_memory_resource* mr = rmm::mr::get_default_resource());

@davidwendt should this argument be removed?

@davidwendt
Copy link
Contributor

cudf::strings::all_float(), cudf::strings::all_integer() accepts device memory resource in arguments. but it is not used inside.

bool all_float(strings_column_view const& strings,
rmm::mr::device_memory_resource* mr = rmm::mr::get_default_resource());

bool all_integer(strings_column_view const& strings,
rmm::mr::device_memory_resource* mr = rmm::mr::get_default_resource());

@davidwendt should this argument be removed?

Yes, this argument should be removed.

@harrism harrism added the 2 - In Progress Currently a work in progress label May 19, 2020
@harrism harrism changed the title [WIP] update documentation uniformly for param [WIP] Make documentation uniform for stream and memory resource params May 19, 2020
@karthikeyann
Copy link
Contributor Author

karthikeyann commented May 19, 2020

AFAIK, writers don't need device memory resource.
rmm::mr::device_memory_resource _mr is not used in writer::impl of

  // TODO : figure out if we want to keep this. It is currently unused.
  rmm::mr::device_memory_resource* _mr = nullptr;

@nvdbaranec @OlivierNV should this argument and private data member (TODO) be removed?

@karthikeyann karthikeyann changed the title [WIP] Make documentation uniform for stream and memory resource params [REVIEW] Make documentation uniform for stream and memory resource params May 19, 2020
Copy link
Contributor

@davidwendt davidwendt left a comment

Choose a reason for hiding this comment

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

Please don't merge this until the other reviewers have approved.

Copy link
Contributor

@rgsl888prabhu rgsl888prabhu left a comment

Choose a reason for hiding this comment

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

LGTM, minor changes and questions.

cpp/include/cudf/column/column_factories.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/detail/scatter.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/detail/transform.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/unary.hpp Outdated Show resolved Hide resolved
karthikeyann and others added 3 commits May 19, 2020 20:51
Copy link
Contributor

@jrhemstad jrhemstad left a comment

Choose a reason for hiding this comment

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

Thanks for going through and standardizing all of these. Since we're going through that effort, we should make sure to get it 100% right.

As such, I see a lot of cases where it says "Device memory resource used to allocate the returned column". This isn't quite right. The resource isn't used to allocate the column object, it's used to allocate the device memory contained inside the column. So a more accurate description would be to say: "Device memory resource used to allocate the returned column's device memory."

@OlivierNV
Copy link
Contributor

@nvdbaranec @OlivierNV should this argument and private data member (TODO) be removed?

We've talked about this: the mr is currently unused by io writers, but it could possibly be needed in the future if returning output data in device memory rather than on disk (ok with me either way).

@karthikeyann karthikeyann merged commit 4520d0f into rapidsai:branch-0.14 May 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In Progress Currently a work in progress doc Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants