Skip to content

documentation update for cms specific options to category #917

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 3 commits into from
Jun 27, 2023
Merged

documentation update for cms specific options to category #917

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30564d5
add cms specific options to category
tyfarnan Jun 27, 2023
3f44d90
address formatting requests
tyfarnan Jun 27, 2023
4281b24
address formatting requests
tyfarnan Jun 27, 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
4 changes: 4 additions & 0 deletions docs/source/profiler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -761,6 +761,10 @@ Below is an breakdown of all the options.
* top_k_categories - (int) Number of categories to be displayed when reporting
* max_sample_size_to_check_stop_condition - (int) The maximum sample size before categorical stop conditions are checked
* stop_condition_unique_value_ratio - (float) The highest ratio of unique values to dataset size that is to be considered a categorical type
* cms - (Boolean) Enables or Disables the use of count min sketch / heavy hitters for approximate frequency counts
* cms_confidence - (float) Defines the number of hashes used in CMS, default 0.95
* cms_relative_error - (float) Defines the number of buckets used in CMS, default 0.01
* cms_max_num_heavy_hitters - (int) The value used to define the threshold for minimum frequency required by a category to be counted
* **data_labeler** - Options for the data labeler columns

* is_enabled - (Boolean) Enables or disables the data labeler operations
Expand Down