Document that describe() uses approximate quantile algorithms#12288
Closed
RamiNoodle733 wants to merge 1 commit intodask:mainfrom
Closed
Document that describe() uses approximate quantile algorithms#12288RamiNoodle733 wants to merge 1 commit intodask:mainfrom
RamiNoodle733 wants to merge 1 commit intodask:mainfrom
Conversation
Add explicit docstrings to DataFrame.describe() and Series.describe() that document: - The approximate nature of quantile calculations - The percentiles_method parameter options - Reference to quantile() for more information Fixes #10416
Contributor
Unit Test ResultsSee test report for an extended history of previous test failures. This is useful for diagnosing flaky tests. 21 files ±0 21 suites ±0 5h 6m 52s ⏱️ +37s Results for commit 3730b4d. ± Comparison against base commit e5a9087. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR adds explicit docstrings to
DataFrame.describe()andSeries.describe()that document:percentiles_methodparameter and its options ('dask','tdigest','default')quantile()for more informationPreviously, the docstrings were inherited from pandas via
@derived_from, which did not mention that dask uses approximate algorithms for computing percentiles. This was confusing for users comparing results with pandas directly.Fixes #10416
Changes
DataFrame.describe()andSeries.describe()indask_expr/_collection.py@derived_fromdecorators since we now have custom docstrings.. note::highlighting the approximate nature of quantilespercentiles_method