Remove warning in from_dlpack and to_dlpack methods #7001
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix #6926 . Hi, Hi! When invoking from_dlpack() and to_dlpack, the following warnings are displayed: from_dlpack() /opt/conda/envs/rapids/lib/python3.7/site-packages/cudf/io/dlpack.py:33: UserWarning: WARNING: cuDF from_dlpack() assumes column-major (Fortran order) input. If the input tensor is row-major, transpose it before passing it to this function. res = libdlpack.from_dlpack(pycapsule_obj) to_dlpack() /opt/conda/envs/rapids/lib/python3.7/site-packages/cudf/io/dlpack.py:74: UserWarning: WARNING: cuDF to_dlpack() produces column-major (Fortran order) output. If the output tensor needs to be row major, transpose the output of this function. return libdlpack.to_dlpack(gdf_cols) I think those warnings should be removed, because it contains information that should be available in the API documentation, and not necessarily displayed each time the methods are invoked. Some users, like me, love to have their notebooks/code without warnings. Even if it is possible to disable those warnings, I think the user should not go that way, because the warning is just repeating what the API documentation should cover. Hope it helps! Miguel
Codecov Report
@@ Coverage Diff @@
## branch-0.18 #7001 +/- ##
============================================
Coverage 82.01% 82.01%
============================================
Files 96 96
Lines 16338 16340 +2
============================================
+ Hits 13400 13402 +2
Misses 2938 2938
Continue to review full report at Codecov.
|
galipremsagar
requested changes
Dec 14, 2020
There was a problem hiding this comment.
Can we add the warnings being removed in both of the from_dlpack & to_dlpack under notes in pydocs here: https://github.com/rapidsai/cudf/blob/598a14d820d47b7c3bfcb2bb3341b97a85317646/python/cudf/cudf/io/dlpack.py
galipremsagar
added
0 - Waiting on Author
Moved API documentation from warning message to API doc.
|
Thank you for your review @galipremsagar. I have just added the requested comments accordingly. |
Removed trailing space and reduced the line length to <=80
I have just moved the warning to a NOTES section.
galipremsagar
removed
the
0 - Waiting on Author
galipremsagar
approved these changes
Dec 14, 2020
galipremsagar
added
5 - Ready to Merge
rgsl888prabhu
approved these changes
Dec 14, 2020
Updated copyright notice from 2019 to 2019-2020.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #6926 .
Hi!
When invoking from_dlpack() and to_dlpack, the following warnings are displayed:
from_dlpack()
to_dlpack()
I think those warnings should be removed, because it contains information that should be available in the API documentation, and not necessarily displayed each time the methods are invoked.
Some users, like me, love to have their notebooks/code without warnings. Even if it is possible to disable those warnings, I think the user should not go that way, because the warning is just repeating what the API documentation should cover.
Hope it helps!
Miguel