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.

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

Add mode and median to gh-pages #390

Merged
merged 6 commits into from
Aug 10, 2021
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
3 changes: 2 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ The format for a structured profile is below:
"min": [null, float],
"max": [null, float],
"sum": float,
"mode": list(float),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

list[float],

"median": float,
"mean": float,
"variance": float,
"stddev": float,
Expand Down Expand Up @@ -457,4 +459,3 @@ Versions
.. _0.7.0: ../../0.7.0/html/index.html

.. _0.7.1: ../../0.7.1/html/index.html

22 changes: 21 additions & 1 deletion docs/source/profiler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,13 @@ Below is an breakdown of all the options.
* max - Finds maximum value in a column

* is_enabled - (Boolean) Enables or disables max
* mode - Finds mode(s) in a column

* is_enabled - (Boolean) Enables or disables mode
* top_k_modes - (Int) Sets the number of modes to return if multiple exist. Default returns max 5 modes.
* median - Finds median value in a column

* is_enabled - (Boolean) Enables or disables median
* sum - Finds sum of all values in a column

* is_enabled - (Boolean) Enables or disables sum
Expand Down Expand Up @@ -510,6 +517,13 @@ Below is an breakdown of all the options.
* max - Finds maximum value in a column

* is_enabled - (Boolean) Enables or disables max
* mode - Finds mode(s) in a column

* is_enabled - (Boolean) Enables or disables mode
* top_k_modes - (Int) Sets the number of modes to return if multiple exist. Default returns max 5 modes.
* median - Finds median value in a column

* is_enabled - (Boolean) Enables or disables median
* sum - Finds sum of all values in a column

* is_enabled - (Boolean) Enables or disables sum
Expand Down Expand Up @@ -552,6 +566,13 @@ Below is an breakdown of all the options.
* max - Finds maximum value in a column

* is_enabled - (Boolean) Enables or disables max
* mode - Finds mode(s) in a column

* is_enabled - (Boolean) Enables or disables mode
* top_k_modes - (Int) Sets the number of modes to return if multiple exist. Default returns max 5 modes.
* median - Finds median value in a column

* is_enabled - (Boolean) Enables or disables median
* sum - Finds sum of all values in a column

* is_enabled - (Boolean) Enables or disables sum
Expand Down Expand Up @@ -675,4 +696,3 @@ For every profile, we can provide a report and customize it with a couple option
report = profile.report(report_options={"output_format": "compact"})
report = profile.report(report_options={"output_format": "serializable"})
report = profile.report(report_options={"output_format": "flat"})