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

documentation update for cms specific options to category #917

Conversation

tyfarnan
Copy link
Contributor

No description provided.

docs/source/profiler.rst Outdated Show resolved Hide resolved
docs/source/profiler.rst Outdated Show resolved Hide resolved
docs/source/profiler.rst Outdated Show resolved Hide resolved
docs/source/profiler.rst Outdated Show resolved Hide resolved
docs/source/profiler.rst Outdated Show resolved Hide resolved
docs/source/profiler.rst Outdated Show resolved Hide resolved
@taylorfturner taylorfturner changed the title add cms specific options to category documentation update for cms specific options to category Jun 27, 2023
@taylorfturner taylorfturner added the Documentation Improvements or additions to documentation label Jun 27, 2023
Comment on lines 765 to 766
* cms_confidence - (float) Defines the number of hashes used in CMS.
eg. confidence = 1 - failure probability, default 0.95
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
* cms_confidence - (float) Defines the number of hashes used in CMS.
eg. confidence = 1 - failure probability, default 0.95
* cms_confidence - (float) Defines the number of hashes used in CMS. E.G. confidence = 1 - failure probability, default 0.95

Comment on lines 767 to 768
* cms_relative_error - (float) Defines the number of buckets used in CMS,
default 0.01
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
* cms_relative_error - (float) Defines the number of buckets used in CMS,
default 0.01
* cms_relative_error - (float) Defines the number of buckets used in CMS, default 0.01

Copy link
Contributor

@taylorfturner taylorfturner left a comment

Choose a reason for hiding this comment

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

LGTM

@taylorfturner taylorfturner enabled auto-merge (squash) June 27, 2023 21:04
@taylorfturner taylorfturner merged commit 46a62c5 into capitalone:dev-gh-pages Jun 27, 2023
JGSweets added a commit that referenced this pull request Jun 30, 2023
* 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 <taylorfturner@gmail.com>

* Update `sampling_ratio` documentation

Co-authored-by: Taylor Turner <taylorfturner@gmail.com>

* Update `sampling_ratio` documentation

* Updated `sampling_ratio` documentation

* Updated `sampling_ratio` documentation

* Updated `sampling_ratio` documentation

---------

Co-authored-by: Taylor Turner <taylorfturner@gmail.com>

* 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 <JGSweets@users.noreply.github.com>

* rendering issue

* rendering issue

* update to fix rendering

---------

Co-authored-by: Liz Smith <liz.smith@richmond.edu>
Co-authored-by: clee1152 <72765198+clee1152@users.noreply.github.com>
Co-authored-by: Richard Bann <87214439+drahc1R@users.noreply.github.com>
Co-authored-by: JGSweets <JGSweets@users.noreply.github.com>

* 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 <taylorfturner@gmail.com>

* Update docs/source/profiler.rst

Co-authored-by: Taylor Turner <taylorfturner@gmail.com>

---------

Co-authored-by: Taylor Turner <taylorfturner@gmail.com>

* fixed formatting in docs (#936)

---------

Co-authored-by: Taylor Turner <taylorfturner@gmail.com>

* Staging update docs 0.10.0  (#945)

* update or 0.10.0 docs version release

* empty

---------

Co-authored-by: Tyler <tfarnan@ucsd.edu>
Co-authored-by: Liz Smith <liz.smith@richmond.edu>
Co-authored-by: clee1152 <72765198+clee1152@users.noreply.github.com>
Co-authored-by: Richard Bann <87214439+drahc1R@users.noreply.github.com>
Co-authored-by: JGSweets <JGSweets@users.noreply.github.com>
Co-authored-by: Michael Davis <36012613+micdavis@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants