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 descriptions for the first four noise types #119

Merged
merged 8 commits into from
Apr 24, 2023

Conversation

zmbc
Copy link
Collaborator

@zmbc zmbc commented Apr 21, 2023

Add descriptions for the first four noise types

Description

  • Category: documentation
  • JIRA issue: none

@NathanielBlairStahn interested to get your review here and also compare notes on how you are documenting these.

@zmbc zmbc added the documentation Improvements or additions to documentation label Apr 21, 2023
@zmbc zmbc requested review from a team and pletale as code owners April 21, 2023 20:39
@zmbc zmbc changed the base branch from main to develop April 21, 2023 20:47
docs/source/noise/column_noise.rst Outdated Show resolved Hide resolved
docs/source/noise/column_noise.rst Outdated Show resolved Hide resolved
docs/source/noise/column_noise.rst Outdated Show resolved Hide resolved
docs/source/noise/column_noise.rst Outdated Show resolved Hide resolved
docs/source/noise/column_noise.rst Show resolved Hide resolved
Copy link
Collaborator

@pletale pletale left a comment

Choose a reason for hiding this comment

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

All looks good to me! Just left a couple suggestions but feel free to take them or leave them (-:

docs/source/noise/column_noise.rst Outdated Show resolved Hide resolved
docs/source/noise/column_noise.rst Outdated Show resolved Hide resolved
docs/source/noise/column_noise.rst Outdated Show resolved Hide resolved
docs/source/noise/column_noise.rst Outdated Show resolved Hide resolved
docs/source/noise/column_noise.rst Outdated Show resolved Hide resolved
The first value in this list is the probability that the first digit of the ZIP code will be wrong
**given that the cell is being considered for this noise type**.
The second value in the list is this same probability but about the second digit, and so on.
- [0.04, 0.04, 0.20, 0.36, 0.36]
Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, now that we've changed these (back?), we'd better make sure the values match the actual default values in the code

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I did! They're here:

Keys.ZIPCODE_DIGIT_PROBABILITIES: [0.04, 0.04, 0.20, 0.36, 0.36],

Co-authored-by: Nathaniel Blair-Stahn <[email protected]>
@zmbc zmbc merged commit 2240c9e into develop Apr 24, 2023
@zmbc zmbc deleted the docs/noise-types-part-1 branch April 24, 2023 22:59
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.

4 participants