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.

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

Row statistics option documentation #883

Merged
merged 11 commits into from
Jun 20, 2023
Merged

Row statistics option documentation #883

Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2a87f90
updated documentation on new row_statistic options
drahc1R Jun 15, 2023
5906f0f
Merge branch 'feature/dev-gh-pages/options' into row_statistics_option
drahc1R Jun 15, 2023
9070848
added documentation for row_statistics_options
drahc1R Jun 15, 2023
78208fa
Merge branch 'row_statistics_option' of https://github.com/drahc1R/Da…
drahc1R Jun 15, 2023
fef9f57
fixed typing of hll and included the note that it activates when hll …
drahc1R Jun 16, 2023
2f8e2ee
removed space
drahc1R Jun 16, 2023
a53dc38
Merge branch 'feature/dev-gh-pages/options' into row_statistics_option
JGSweets Jun 19, 2023
ca2e39d
fixed quotation mark
drahc1R Jun 20, 2023
94962ea
added micdavis comments
drahc1R Jun 20, 2023
b133744
fixed doc descriptions for unique_count
drahc1R Jun 20, 2023
fc9d412
small changes to docs
drahc1R Jun 20, 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
9 changes: 8 additions & 1 deletion docs/source/profiler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -806,12 +806,19 @@ Below is an breakdown of all the options.
* data_labeler_dirpath - (String) Directory path to data labeler
* data_labeler_object - (BaseDataLabeler) Datalabeler to replace
the default labeler
* max_sample_size - (Int) The max number of samples for the data
* max_sample_size - (Int) The max number of samples for the data
labeler
* **correlation** - option set for correlation profiling
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* **correlation** - option set for correlation profiling
* **correlation** - Option set for correlation profiling

* is_enabled - (Boolean) Enables or disables performing correlation profiling
* columns - Columns considered to calculate correlation
* **row_statistics** - (Boolean) Option to enable/disable row statistics calculations
* unique_count - (UniqueCountOptions) Option to enable/disable functionalities from UniqueCountOptions
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* unique_count - (UniqueCountOptions) Option to enable/disable functionalities from UniqueCountOptions
* unique_count - (UniqueCountOptions) Option to enable/disable unique row count calculations

* is_enabled - (Bool) Enables or disables options for unique row count
* hashing_method - (String) Property to specify row hashing method ("full" | "hll")
* hll - (HyperLogLogOptions) Options for alternative method of estimating unique row count (activated when `hll` is the selected hashing_method)
* seed - (Int) Used to set HLL hashing function seed
* register_count - (Int) Number of registers is equal to 2^register_count
* null_count - (Boolean) Option to enable/disable functionalities for row_has_null_ratio and row_is_null_ratio
* **chi2_homogeneity** - Options for the chi-squared test matrix

* is_enabled - (Boolean) Enables or disables performing chi-squared tests for homogeneity between the categorical columns of the dataset.
Expand Down