Skip to content

Add docs for num_quantiles option for histogram_and_quantiles. #991

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

Merged
taylorfturner merged 2 commits into from
Aug 2, 2023
Merged

Add docs for num_quantiles option for histogram_and_quantiles. #991

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdf2dfa
Add docs for `num_quantiles` option for histgram_and_quantiles.
clee1152 Aug 2, 2023
7b9688b
Slight readability change
clee1152 Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/source/profiler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -717,6 +717,8 @@ Below is an breakdown of all the options.
If multiple specified (list) the optimal method will be chosen by attempting the provided ones.
methods: 'auto', 'fd', 'doane', 'scott', 'rice', 'sturges', 'sqrt'
Note: 'auto' is used to choose optimally between 'fd' and 'sturges'
* num_quantiles - (Int) Number of quantiles to bin the data.
Default value is set to 1,000 quantiles.
* is_enabled - (Boolean) Enables or disables histogram and quantiles
* **float** - Options for the float columns

Expand Down Expand Up @@ -772,6 +774,8 @@ Below is an breakdown of all the options.
If multiple specified (list) the optimal method will be chosen by attempting the provided ones.
methods: 'auto', 'fd', 'doane', 'scott', 'rice', 'sturges', 'sqrt'
Note: 'auto' is used to choose optimally between 'fd' and 'sturges'
* num_quantiles - (Int) Number of quantiles to bin the data.
Default value is set to 1,000 quantiles.
* is_enabled - (Boolean) Enables or disables histogram and quantiles
* **text** - Options for the text columns

Expand Down Expand Up @@ -825,6 +829,8 @@ Below is an breakdown of all the options.
If multiple specified (list) the optimal method will be chosen by attempting the provided ones.
methods: 'auto', 'fd', 'doane', 'scott', 'rice', 'sturges', 'sqrt'
Note: 'auto' is used to choose optimally between 'fd' and 'sturges'
* num_quantiles - (Int) Number of quantiles to bin the data.
Default value is set to 1,000 quantiles.
* is_enabled - (Boolean) Enables or disables histogram and quantiles
* **datetime** - Options for the datetime columns

Expand Down