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.

Sign up for GitHub

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

Jump to bottom

Document cudf.read_text and cudf.read_avro. #10638

Merged
merged 3 commits into from
Apr 12, 2022
Merged

Document cudf.read_text and cudf.read_avro. #10638

merged 3 commits into from
Apr 12, 2022

Conversation

bdice
Copy link
Contributor

@bdice bdice commented Apr 12, 2022

This adds documentation for cudf.read_text and cudf.read_avro.

@bdice bdice added the doc Documentation label Apr 12, 2022
@bdice bdice requested a review from a team as a code owner April 12, 2022 00:02
@bdice bdice self-assigned this Apr 12, 2022
@github-actions github-actions bot added the Python Affects Python cuDF API. label Apr 12, 2022
bdice
bdice commented Apr 12, 2022
View reviewed changes
python/cudf/cudf/utils/ioutils.py Outdated
Comment on lines 81 to 84
See Also
--------
cudf.read_csv
cudf.read_json
cudf.io.json.read_json
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Question for reviewers: Why are cudf.read_csv and cudf.io.json.read_json in the "See Also" section of the read_avro docs? Should we remove this? I don't see the relationship, but I'm not familiar with the Avro format.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, remove them.

Copy link
Contributor

Choose a reason for hiding this comment

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

Good catch, I don't think there's a good reason to mention CSV and JSON here.
Why are namespaces(?) so different between csv and json?

Copy link
Contributor Author

@bdice bdice Apr 12, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Why are namespaces(?) so different between csv and json?

It seems to me that cudf.io.json.read_json should be documented as cudf.read_json to mirror pandas. https://pandas.pydata.org/docs/reference/api/pandas.read_json.html

I can fix that in a separate PR, if you like. This one has a nice small scope.

Copy link
Contributor Author

@bdice bdice Apr 12, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Fixed in #10640

@bdice bdice requested a review from vuule April 12, 2022 00:02
@galipremsagar galipremsagar added the non-breaking Non-breaking change label Apr 12, 2022
@galipremsagar galipremsagar added the 5 - Ready to Merge Testing and reviews complete, ready to merge label Apr 12, 2022
@bdice bdice mentioned this pull request Apr 12, 2022
Merged
@codecov
Copy link

codecov bot commented Apr 12, 2022 •
edited
Loading

Codecov Report

Merging #10638 (c553660) into branch-22.06 (bf4ffc9) will increase coverage by 0.02%.
The diff coverage is 100.00%.

@@               Coverage Diff                @@
##           branch-22.06   #10638      +/-   ##
================================================
+ Coverage         86.33%   86.36%   +0.02%     
================================================
  Files               140      140              
  Lines             22289    22289              
================================================
+ Hits              19244    19250       +6     
+ Misses             3045     3039       -6
Impacted Files Coverage Δ
python/cudf/cudf/utils/ioutils.py 79.60% <ø> (ø)
python/dask_cudf/dask_cudf/backends.py 86.44% <100.00%> (ø)
python/dask_cudf/dask_cudf/sorting.py 93.03% <100.00%> (ø)
python/cudf/cudf/core/column/string.py 89.10% <0.00%> (+0.12%) ⬆️
python/cudf/cudf/core/groupby/groupby.py 91.72% <0.00%> (+0.22%) ⬆️
python/cudf/cudf/core/tools/datetimes.py 84.49% <0.00%> (+0.30%) ⬆️
python/cudf/cudf/core/column/lists.py 92.70% <0.00%> (+1.28%) ⬆️

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 012af64...c553660. Read the comment docs.

@bdice
Copy link
Contributor Author

bdice commented Apr 12, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 3c13ef1 into rapidsai:branch-22.06 Apr 12, 2022
rapids-bot bot pushed a commit that referenced this pull request Apr 12, 2022
@bdice
Use cudf.read_json as documented API name. (#10640)
d6c15e4 
Changes documented API name from `cudf.io.json.read_json` to `cudf.read_json`. This aligns with Pandas' documentation and eliminates an awkward switch of the `.. currentmodule` in Sphinx. See thread: #10638 (comment)

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - https://github.com/brandon-b-miller

URL: #10640
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@galipremsagar galipremsagar galipremsagar approved these changes

@vuule vuule vuule approved these changes

@charlesbluca charlesbluca Awaiting requested review from charlesbluca charlesbluca is a code owner automatically assigned from rapidsai/cudf-python-codeowners

Assignees

@bdice bdice

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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bdice @galipremsagar @vuule