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

[DOC] Update data-types page for cudf #11605

Closed
galipremsagar opened this issue Aug 25, 2022 · 6 comments · Fixed by #11974
Closed

[DOC] Update data-types page for cudf #11605

galipremsagar opened this issue Aug 25, 2022 · 6 comments · Fixed by #11974
Assignees
@galipremsagar
Labels
doc Documentation Python Affects Python cuDF API.

Comments

@galipremsagar
Copy link
Contributor

galipremsagar commented Aug 25, 2022 •
edited
Loading

Describe the problems or issues found in the documentation
We will need to expose some of the cudf specific data-type into the existing data-types page here: (https://docs.rapids.ai/api/cudf/nightly/user_guide/data-types.html)

Suggested fix for documentation
(https://pandas.pydata.org/docs/reference/api/pandas.CategoricalDtype.html#pandas.CategoricalDtype)
@galipremsagar galipremsagar added doc Documentation Needs Triage Need team to review and classify labels Aug 25, 2022
@galipremsagar galipremsagar mentioned this issue Aug 25, 2022
Merged
3 tasks
@shwina
Copy link
Contributor

shwina commented Aug 26, 2022

Do we just need to update/add to https://docs.rapids.ai/api/cudf/nightly/user_guide/data-types.html?

@galipremsagar
Copy link
Contributor Author

Do we just need to update/add to https://docs.rapids.ai/api/cudf/nightly/user_guide/data-types.html?

Yup

@galipremsagar galipremsagar changed the title [DOC] Add data-types page for cudf [DOC] Update data-types page for cudf Aug 26, 2022
@github-actions
Copy link

This issue has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this issue if no further response or action is needed. Otherwise, please respond with a comment indicating any updates or changes to the original issue and/or confirm this issue still needs to be addressed. This issue will be labeled inactive-90d if there is no activity in the next 60 days.

@vyasr
Copy link
Contributor

vyasr commented Oct 18, 2022

@galipremsagar what data types are missing? It seems like all of our main extension types are there (list, struct) but perhaps I missed something?

@GregoryKimball
Copy link
Contributor

Please feel free to re-open if #11604 did not solve this.

@galipremsagar galipremsagar self-assigned this Oct 21, 2022
@galipremsagar galipremsagar added Python Affects Python cuDF API. and removed Needs Triage Need team to review and classify labels Oct 21, 2022
@galipremsagar
Copy link
Contributor Author

We list all our extension types(as text) but their docstrings are not discoverable by any means(dtypes page/search). I intend to add that aspect.

@galipremsagar galipremsagar reopened this Oct 21, 2022
@galipremsagar galipremsagar mentioned this issue Oct 22, 2022
Merged
6 tasks
rapids-bot bot pushed a commit that referenced this issue Oct 24, 2022
@galipremsagar
Add dtype docs pages and docstrings for cudf specific dtypes (#11974)
11918ae 
Resolves #11605 
This PR:

- [x] Creates docs page entries for `cudf.CategoricalDtype`, `cudf.ListDtype`, `cudf.StructDtype`, `cudf.Decimal32Dtype`, `cudf.Decimal64Dtype`, `cudf.Decimal128Dtype`.
- [x] Updates docstrings in all of the public APIs of the above dtypes.
- [x] Links them in the `data-types.md` page where all supported dtypes are listed as a table.

Authors:
  - GALI PREM SAGAR (https://github.com/galipremsagar)

Approvers:
  - Vyas Ramasubramani (https://github.com/vyasr)

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

@galipremsagar galipremsagar

Labels
doc Documentation Python Affects Python cuDF API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[REVIEW] Add dtype docs pages and docstrings for cudf specific dtypes galipremsagar/cudf
4 participants
@vyasr @shwina @galipremsagar @GregoryKimball