Row statistics option documentation #883

drahc1R · 2023-06-15T20:12:36Z

No description provided.

docs/source/profiler.rst

JGSweets

Just need to add the extra details around unique_count

…taProfiler into row_statistics_option

drahc1R · 2023-06-15T21:06:01Z

saw that base option was of dict type whoops

docs/source/profiler.rst

…is chosen as the hashing method

ksneab7 · 2023-06-20T12:24:14Z

docs/source/profiler.rst

        labeler
    * **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 - (Boolean) Option to enable/disable functionalities from UniqueCountOptions
+        * hashing_method - (String) Property to specify row hashing method ("full" | "hll")
+        * hll - (HyperLogLogOptions) Options for alternative method of gathering unique row count (activated when "hll" is the selected hashing_method)


Suggested change

* hll - (HyperLogLogOptions) Options for alternative method of gathering unique row count (activated when "hll" is the selected hashing_method)

* hll - (HyperLogLogOptions) Options for alternative method of gathering unique row count (activated when `hll` is the selected hashing_method)

micdavis · 2023-06-20T13:05:00Z

docs/source/profiler.rst

        labeler
    * **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 - (Boolean) Option to enable/disable functionalities from UniqueCountOptions
+        * hashing_method - (String) Property to specify row hashing method ("full" | "hll")
+        * hll - (HyperLogLogOptions) Options for alternative method of gathering unique row count (activated when `hll` is the selected hashing_method)


Suggested change

* hll - (HyperLogLogOptions) Options for alternative method of gathering unique row count (activated when `hll` is the selected hashing_method)

* hll - (HyperLogLogOptions) Options for alternative method of estimating unique row count (activated when `hll` is the selected hashing_method)

micdavis · 2023-06-20T13:05:35Z

docs/source/profiler.rst

+      * unique_count - (Boolean) Option to enable/disable functionalities from UniqueCountOptions
+        * hashing_method - (String) Property to specify row hashing method ("full" | "hll")
+        * hll - (HyperLogLogOptions) Options for alternative method of gathering unique row count (activated when `hll` is the selected hashing_method)
+          * seed - (Int) Used to set HLL hashing function


Suggested change

* seed - (Int) Used to set HLL hashing function

* seed - (Int) Used to set HLL hashing function seed

taylorfturner · 2023-06-20T13:49:01Z

docs/source/profiler.rst

        labeler
    * **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 - (Boolean) Option to enable/disable functionalities from UniqueCountOptions


Suggested change

* unique_count - (Boolean) Option to enable/disable functionalities from UniqueCountOptions

* unique_count - (UniqueCountOptions) Option to enable/disable functionalities from UniqueCountOptions

taylorfturner

small changes

taylorfturner · 2023-06-20T14:16:27Z

docs/source/profiler.rst

@@ -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


Suggested change

* **correlation** - option set for correlation profiling

* **correlation** - Option set for correlation profiling

taylorfturner · 2023-06-20T14:17:08Z

docs/source/profiler.rst

        labeler
    * **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


Suggested change

* unique_count - (UniqueCountOptions) Option to enable/disable functionalities from UniqueCountOptions

* unique_count - (UniqueCountOptions) Option to enable/disable unique row count calculations

* updated documentation on new row_statistic options * added documentation for row_statistics_options * fixed typing of hll and included the note that it activates when hll is chosen as the hashing method * removed space * fixed quotation mark * added micdavis comments * fixed doc descriptions for unique_count * small changes to docs --------- Co-authored-by: JGSweets <[email protected]>

* reset ignore, update .gitignore, update documentation on presets (#874) * reset ignore * taylor's requested change * taylor's requested change * Fixed documentation for `sampling_ratio` option (#873) * Add documentation for `sampling_ratio` option * Update `sample_ratio` to `sampling_ratio` in documentations Co-authored-by: Taylor Turner <[email protected]> * Update `sampling_ratio` documentation Co-authored-by: Taylor Turner <[email protected]> * Update `sampling_ratio` documentation * Updated `sampling_ratio` documentation * Updated `sampling_ratio` documentation * Updated `sampling_ratio` documentation --------- Co-authored-by: Taylor Turner <[email protected]> * update (#882) * Add documentation for `median_abs_deviation` option (#881) * Add documentation for `median_abs_deviation` option * Updated `median_abs_deviation` documentation * Row statistics option documentation (#883) * updated documentation on new row_statistic options * added documentation for row_statistics_options * fixed typing of hll and included the note that it activates when hll is chosen as the hashing method * removed space * fixed quotation mark * added micdavis comments * fixed doc descriptions for unique_count * small changes to docs --------- Co-authored-by: JGSweets <[email protected]> * rendering issue * rendering issue * update to fix rendering --------- Co-authored-by: Liz Smith <[email protected]> Co-authored-by: clee1152 <[email protected]> Co-authored-by: Richard Bann <[email protected]> Co-authored-by: JGSweets <[email protected]>

* documentation update for cms specific options to category (#917) * add cms specific options to category * address formatting requests * address formatting requests * Documentation: Update for Reservoir Sampling (#919) * update option for reservoir sampling * update for clarity rendering * Documentation: feature/options branch docs updates (#921) * reset ignore, update .gitignore, update documentation on presets (#874) * reset ignore * taylor's requested change * taylor's requested change * Fixed documentation for `sampling_ratio` option (#873) * Add documentation for `sampling_ratio` option * Update `sample_ratio` to `sampling_ratio` in documentations Co-authored-by: Taylor Turner <[email protected]> * Update `sampling_ratio` documentation Co-authored-by: Taylor Turner <[email protected]> * Update `sampling_ratio` documentation * Updated `sampling_ratio` documentation * Updated `sampling_ratio` documentation * Updated `sampling_ratio` documentation --------- Co-authored-by: Taylor Turner <[email protected]> * update (#882) * Add documentation for `median_abs_deviation` option (#881) * Add documentation for `median_abs_deviation` option * Updated `median_abs_deviation` documentation * Row statistics option documentation (#883) * updated documentation on new row_statistic options * added documentation for row_statistics_options * fixed typing of hll and included the note that it activates when hll is chosen as the hashing method * removed space * fixed quotation mark * added micdavis comments * fixed doc descriptions for unique_count * small changes to docs --------- Co-authored-by: JGSweets <[email protected]> * rendering issue * rendering issue * update to fix rendering --------- Co-authored-by: Liz Smith <[email protected]> Co-authored-by: clee1152 <[email protected]> Co-authored-by: Richard Bann <[email protected]> Co-authored-by: JGSweets <[email protected]> * fix req tornado (#922) * Merge `staging/dev-gh-pages/profile-serialization` into `dev-gh-pages` (#937) * Docs: Profiler Serialization (#928) * added info to profile save and load func * addressed PR comments * fixed formatting * Update docs/source/profiler.rst Co-authored-by: Taylor Turner <[email protected]> * Update docs/source/profiler.rst Co-authored-by: Taylor Turner <[email protected]> --------- Co-authored-by: Taylor Turner <[email protected]> * fixed formatting in docs (#936) --------- Co-authored-by: Taylor Turner <[email protected]> * Staging update docs 0.10.0 (#945) * update or 0.10.0 docs version release * empty --------- Co-authored-by: Tyler <[email protected]> Co-authored-by: Liz Smith <[email protected]> Co-authored-by: clee1152 <[email protected]> Co-authored-by: Richard Bann <[email protected]> Co-authored-by: JGSweets <[email protected]> Co-authored-by: Michael Davis <[email protected]>

updated documentation on new row_statistic options

2a87f90

drahc1R requested review from JGSweets, ksneab7, taylorfturner, micdavis and tyfarnan as code owners June 15, 2023 20:12

taylorfturner assigned drahc1R Jun 15, 2023

taylorfturner added the Documentation Improvements or additions to documentation label Jun 15, 2023

drahc1R changed the base branch from main to dev-gh-pages June 15, 2023 20:15

drahc1R changed the base branch from dev-gh-pages to feature/dev-gh-pages/options June 15, 2023 20:16

taylorfturner enabled auto-merge (squash) June 15, 2023 20:17

Merge branch 'feature/dev-gh-pages/options' into row_statistics_option

5906f0f

JGSweets reviewed Jun 15, 2023

View reviewed changes

docs/source/profiler.rst Outdated Show resolved Hide resolved

JGSweets suggested changes Jun 15, 2023

View reviewed changes

drahc1R added 2 commits June 15, 2023 17:01

added documentation for row_statistics_options

9070848

Merge branch 'row_statistics_option' of https://github.com/drahc1R/Da…

78208fa

…taProfiler into row_statistics_option

auto-merge was automatically disabled June 15, 2023 21:05
Head branch was pushed to by a user without write access

JGSweets reviewed Jun 15, 2023

View reviewed changes

docs/source/profiler.rst Outdated Show resolved Hide resolved

taylorfturner reviewed Jun 16, 2023

View reviewed changes

docs/source/profiler.rst Outdated Show resolved Hide resolved

taylorfturner enabled auto-merge (squash) June 16, 2023 14:02

fixed typing of hll and included the note that it activates when hll …

fef9f57

…is chosen as the hashing method

auto-merge was automatically disabled June 16, 2023 14:56
Head branch was pushed to by a user without write access

removed space

2f8e2ee

JGSweets approved these changes Jun 19, 2023

View reviewed changes

Merge branch 'feature/dev-gh-pages/options' into row_statistics_option

a53dc38

JGSweets enabled auto-merge (squash) June 19, 2023 22:30

ksneab7 reviewed Jun 20, 2023

View reviewed changes

fixed quotation mark

ca2e39d

auto-merge was automatically disabled June 20, 2023 12:47
Head branch was pushed to by a user without write access

micdavis reviewed Jun 20, 2023

View reviewed changes

added micdavis comments

94962ea

taylorfturner enabled auto-merge (squash) June 20, 2023 13:47

taylorfturner reviewed Jun 20, 2023

View reviewed changes

taylorfturner suggested changes Jun 20, 2023

View reviewed changes

fixed doc descriptions for unique_count

b133744

auto-merge was automatically disabled June 20, 2023 13:59
Head branch was pushed to by a user without write access

taylorfturner enabled auto-merge (squash) June 20, 2023 14:09

taylorfturner reviewed Jun 20, 2023

View reviewed changes

small changes to docs

fc9d412

auto-merge was automatically disabled June 20, 2023 14:22
Head branch was pushed to by a user without write access

taylorfturner approved these changes Jun 20, 2023

View reviewed changes

taylorfturner merged commit 87d5cff into capitalone:feature/dev-gh-pages/options Jun 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Row statistics option documentation #883

Row statistics option documentation #883

drahc1R commented Jun 15, 2023

JGSweets left a comment

drahc1R commented Jun 15, 2023

ksneab7 Jun 20, 2023

micdavis Jun 20, 2023

micdavis Jun 20, 2023

taylorfturner Jun 20, 2023

taylorfturner left a comment

taylorfturner Jun 20, 2023

taylorfturner Jun 20, 2023

	* hll - (HyperLogLogOptions) Options for alternative method of gathering unique row count (activated when "hll" is the selected hashing_method)
	* hll - (HyperLogLogOptions) Options for alternative method of gathering unique row count (activated when `hll` is the selected hashing_method)

	* seed - (Int) Used to set HLL hashing function
	* seed - (Int) Used to set HLL hashing function seed

	* unique_count - (Boolean) Option to enable/disable functionalities from UniqueCountOptions
	* unique_count - (UniqueCountOptions) Option to enable/disable functionalities from UniqueCountOptions

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

Row statistics option documentation #883

Row statistics option documentation #883

Conversation

drahc1R commented Jun 15, 2023

JGSweets left a comment

Choose a reason for hiding this comment

drahc1R commented Jun 15, 2023

ksneab7 Jun 20, 2023

Choose a reason for hiding this comment

micdavis Jun 20, 2023

Choose a reason for hiding this comment

micdavis Jun 20, 2023

Choose a reason for hiding this comment

taylorfturner Jun 20, 2023

Choose a reason for hiding this comment

taylorfturner left a comment

Choose a reason for hiding this comment

taylorfturner Jun 20, 2023

Choose a reason for hiding this comment

taylorfturner Jun 20, 2023

Choose a reason for hiding this comment