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

[REVIW] Miscellaneous documentation fixes to cudf #9471

Merged
merged 8 commits into from
Oct 20, 2021

Conversation

galipremsagar
Copy link
Contributor

This PR:

  • Exposes .struct accessor
  • Exposes Decimal32Dtype
  • Adds newly introduced Datetime related APIs
  • Fixes some examples.

@galipremsagar galipremsagar added 3 - Ready for Review Ready for review by team doc Documentation Python Affects Python cuDF API. non-breaking Non-breaking change labels Oct 19, 2021
@galipremsagar galipremsagar self-assigned this Oct 19, 2021
@galipremsagar galipremsagar requested a review from a team as a code owner October 19, 2021 14:17
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Oct 19, 2021

Codecov Report

Merging #9471 (4411060) into branch-21.12 (ab4bfaa) will decrease coverage by 0.13%.
The diff coverage is n/a.

Impacted file tree graph

@@               Coverage Diff                @@
##           branch-21.12    #9471      +/-   ##
================================================
- Coverage         10.79%   10.65%   -0.14%     
================================================
  Files               116      117       +1     
  Lines             18869    19760     +891     
================================================
+ Hits               2036     2106      +70     
- Misses            16833    17654     +821     
Impacted Files Coverage Δ
python/cudf/cudf/io/csv.py 0.00% <0.00%> (ø)
python/cudf/cudf/io/hdf.py 0.00% <0.00%> (ø)
python/cudf/cudf/io/orc.py 0.00% <0.00%> (ø)
python/cudf/cudf/__init__.py 0.00% <0.00%> (ø)
python/cudf/cudf/_version.py 0.00% <0.00%> (ø)
python/cudf/cudf/core/abc.py 0.00% <0.00%> (ø)
python/cudf/cudf/api/types.py 0.00% <0.00%> (ø)
python/cudf/cudf/io/dlpack.py 0.00% <0.00%> (ø)
python/cudf/cudf/core/frame.py 0.00% <0.00%> (ø)
python/cudf/cudf/core/index.py 0.00% <0.00%> (ø)
... and 61 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a19bd23...4411060. Read the comment docs.

Copy link
Contributor

@isVoid isVoid left a comment

Choose a reason for hiding this comment

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

I recently also noticed that the docstrings of rand_dataframe in dataset_generator.py is lacking description to list dtype dtype_meta. Specifically:

  • lists_max_length
  • nesting_max_depth
  • value_type

Can you add them to this PR also as part of the doc fixes?

@galipremsagar
Copy link
Contributor Author

I recently also noticed that the docstrings of rand_dataframe in dataset_generator.py is lacking description to list dtype dtype_meta. Specifically:

  • lists_max_length
  • nesting_max_depth
  • value_type

Can you add them to this PR also as part of the doc fixes?

I think I'll need to be updating the docstrings of rand_dataframe of dataset_generator anyways in this PR: #9180, where I'm introducing struct support. So will tackle it 9180 instead of this PR.

@galipremsagar galipremsagar added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 3 - Ready for Review Ready for review by team labels Oct 20, 2021
@galipremsagar
Copy link
Contributor Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 7e84aa1 into rapidsai:branch-21.12 Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Ready to Merge Testing and reviews complete, ready to merge doc Documentation non-breaking Non-breaking change Python Affects Python cuDF API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants