Skip to content

Commit

Permalink
Add docs for num_quantiles option for histogram_and_quantiles. (cap…
Browse files Browse the repository at this point in the history
…italone#991) (capitalone#993)

* Add docs for `num_quantiles` option for histgram_and_quantiles.

* Slight readability change
  • Loading branch information
clee1152 authored and ksneab7 committed Aug 7, 2023
1 parent dbae5e2 commit f0cc65a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/profiler.rst
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

0 comments on commit f0cc65a

Please sign in to comment.