Add developer docs for writing tests by vyasr · Pull Request #11199 · NVIDIA/cudf

vyasr · 2022-07-05T21:15:50Z

This PR adds documentation on how Python tests should be written.

Related to #4730. This PR will establish best practices. Follow-up PRs will be needed to implement them.

Resolves #6481.

wence-

Minor quibble

codecov · 2022-07-18T21:07:43Z

Codecov Report

Base: 87.47% // Head: 86.86% // Decreases project coverage by -0.60% ⚠️

Coverage data is based on head (f469142) compared to base (f817d96).
Patch has no changes to coverable lines.

❗ Current head f469142 differs from pull request most recent head 0d622b5. Consider uploading reports for the commit 0d622b5 to get more accurate results

Additional details and impacted files

@@               Coverage Diff                @@
##           branch-22.12   #11199      +/-   ##
================================================
- Coverage         87.47%   86.86%   -0.61%     
================================================
  Files               133      135       +2     
  Lines             21826    21985     +159     
================================================
+ Hits              19093    19098       +5     
- Misses             2733     2887     +154

Impacted Files	Coverage Δ
python/strings_udf/strings_udf/lowering.py	`0.00% <0.00%> (-84.40%)`	⬇️
python/strings_udf/strings_udf/_typing.py	`81.05% <0.00%> (-13.69%)`	⬇️
python/cudf/cudf/io/text.py	`91.66% <0.00%> (-8.34%)`	⬇️
python/cudf/cudf/core/_base_index.py	`81.28% <0.00%> (-4.27%)`	⬇️
python/cudf/cudf/io/json.py	`92.06% <0.00%> (-2.68%)`	⬇️
python/cudf/cudf/utils/utils.py	`89.91% <0.00%> (-0.69%)`	⬇️
python/dask_cudf/dask_cudf/core.py	`73.72% <0.00%> (-0.41%)`	⬇️
python/cudf/cudf/io/parquet.py	`90.45% <0.00%> (-0.39%)`	⬇️
python/dask_cudf/dask_cudf/backends.py	`84.90% <0.00%> (-0.37%)`	⬇️
python/cudf/cudf/core/dataframe.py	`93.63% <0.00%> (-0.10%)`	⬇️
... and 30 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

This PR adds a primary developer guide for Python. It provides a more complete and informative landing page for new developers. When #11217, #11199, and #11122 are merged, they will all be linked from this page to provide a complete set of developer documentation. There is one main point of discussion that I would like reviewer comments on, and that is the section on directory and file organization. How do we want that aspect of cuDF to look? Authors: - Vyas Ramasubramani (https://github.com/vyasr) Approvers: - Matthew Roeschke (https://github.com/mroeschke) - Lawrence Mitchell (https://github.com/wence-) - Ashwin Srinath (https://github.com/shwina) URL: #11235

github-actions · 2022-08-17T22:03:10Z

This PR has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this PR if it is no longer required. Otherwise, please respond with a comment indicating any updates. This PR will be labeled inactive-90d if there is no activity in the next 60 days.

…esting

review-notebook-app · 2022-10-26T23:49:32Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

wence-

Some minor comments, but overall looks good, thanks!

bdice

Minor changes suggested, otherwise LGTM.

vyasr · 2022-11-01T22:21:48Z

rerun tests

wence-

Very minor nit, but overall great! Thanks!

vyasr · 2022-11-02T18:44:21Z

rerun tests

shwina

LGTM w/ small suggestion/question.

vyasr · 2022-11-02T20:41:44Z

rerun tests

vyasr · 2022-11-03T00:34:04Z

@gpucibot merge

First version of testing docs.

f0a1d9d

vyasr added 2 - In Progress Currently a work in progress doc Documentation Python Affects Python cuDF API. improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Jul 5, 2022

vyasr added this to the CuDF Python Refactoring milestone Jul 5, 2022

vyasr self-assigned this Jul 5, 2022

github-actions Bot removed the Python Affects Python cuDF API. label Jul 5, 2022

Add testing file to index.

edb728e

vyasr removed the improvement Improvement / enhancement to an existing function label Jul 5, 2022

This was referenced Jul 9, 2022

Create main developer guide for Python #11235

Merged

[DISCUSS] cuDF internal/developer documentation #6481

Closed

shwina reviewed Jul 11, 2022

View reviewed changes

Comment thread docs/cudf/source/developer_guide/testing.md Outdated

vyasr mentioned this pull request Jul 12, 2022

[QST/Discussion] Reorganize pytests #4730

Closed

wence- reviewed Jul 12, 2022

View reviewed changes

Comment thread docs/cudf/source/developer_guide/testing.md

mroeschke reviewed Jul 12, 2022

View reviewed changes

Comment thread docs/cudf/source/developer_guide/testing.md

Merge branch 'branch-22.08' into docs/python_testing

5cc9d43

harrism mentioned this pull request Jul 20, 2022

[DOC] Improve Python developer documentation rapidsai/cuspatial#599

Closed

vyasr mentioned this pull request Jul 22, 2022

Add developer documentation for benchmarking #11122

Merged

github-actions Bot added the inactive-30d label Aug 17, 2022

vyasr added 2 commits October 26, 2022 15:36

Merge remote-tracking branch 'origin/branch-22.12' into docs/python_t…

3a97ebf

…esting

Update based on various discussions.

44ae688

github-actions Bot added CMake CMake build issue conda Java Affects Java cuDF API. labels Oct 26, 2022

vyasr added 3 - Ready for Review Ready for review by team Python Affects Python cuDF API. and removed gpuCI CMake CMake build issue libcudf Affects libcudf (C++/CUDA) code. labels Oct 26, 2022

vyasr marked this pull request as ready for review October 26, 2022 23:50

vyasr requested review from mroeschke, shwina and wence- October 26, 2022 23:51

bdice reviewed Oct 27, 2022

View reviewed changes

wence- requested changes Oct 31, 2022

View reviewed changes

Address reviews.

0fbd477

vyasr requested review from bdice and wence- November 1, 2022 19:19

github-actions Bot removed the Python Affects Python cuDF API. label Nov 1, 2022

bdice approved these changes Nov 1, 2022

View reviewed changes

One more round of PR review.

e18f5c5

mroeschke approved these changes Nov 1, 2022

View reviewed changes

wence- approved these changes Nov 2, 2022

View reviewed changes

Comment thread docs/cudf/source/developer_guide/testing.md Outdated

Make warning against GPU allocations more prominent.

0d622b5

shwina reviewed Nov 2, 2022

View reviewed changes

Comment thread docs/cudf/source/developer_guide/testing.md

shwina approved these changes Nov 2, 2022

View reviewed changes

rapids-bot Bot merged commit eaa0706 into NVIDIA:branch-22.12 Nov 3, 2022

vyasr deleted the docs/python_testing branch November 3, 2022 00:34

Uh oh!

Conversation

vyasr commented Jul 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

wence- left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Jul 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Aug 17, 2022

Uh oh!

review-notebook-app Bot commented Oct 26, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wence- left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bdice left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vyasr commented Nov 1, 2022

Uh oh!

wence- left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vyasr commented Nov 2, 2022

Uh oh!

Uh oh!

shwina left a comment

Choose a reason for hiding this comment

Uh oh!

vyasr commented Nov 2, 2022

Uh oh!

vyasr commented Nov 3, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

vyasr commented Jul 5, 2022 •

edited

Loading

codecov Bot commented Jul 18, 2022 •

edited

Loading