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

Jump to bottom

Document some undocumented comparison features #44

Closed
5 tasks done
riley-harper opened this issue Oct 3, 2022 · 0 comments · Fixed by #47
Closed
5 tasks done

Document some undocumented comparison features #44

riley-harper opened this issue Oct 3, 2022 · 0 comments · Fixed by #47
Labels
documentation Improvements or additions to documentation

Comments

@riley-harper
Copy link
Contributor

riley-harper commented Oct 3, 2022 •
edited
Loading

This is a checklist issue for documenting some undocumented comparison types and feature selection transforms that I've found that are undocumented.

Comparison Types to Document

  • present_and_equal_categorical_in_universe
  • caution_comp_3_012
  • caution_comp_4_012
  • present_and_matching_categorical
  • not_zero_and_not_equals

All of these comparison features are implemented in hlink/linking/core/comparison_feature.py.

caution_comp_3_012 and caution_comp_4_012 are variants of caution_comp_3 and caution_comp_4, respectively. Instead of returning just 0 or 1, they return 0, 1, or 2. The 2 is returned as a special case, and if caution_comp_3_012 returns 0 or 1, then it agrees with caution_comp_3, and similarly for caution_comp_4_012 and caution_comp_4.
@riley-harper riley-harper added the documentation Improvements or additions to documentation label Oct 3, 2022
@riley-harper riley-harper changed the title Document caution_comp_3_012 and caution_comp_4_012 Document some undocumented comparison features and feature selections Oct 6, 2022
riley-harper added a commit that referenced this issue Oct 7, 2022
@riley-harper
[#44] Document some comparison types
93404f6 
- not_zero_and_not_equals
- present_and_matching_categorical
- caution_comp_3_012 (also tweaked the docs for caution_comp_3)
- caution_comp_4_012 (also tweaked the docs for caution_comp_4)
@riley-harper riley-harper self-assigned this Oct 7, 2022
@riley-harper riley-harper changed the title Document some undocumented comparison features and feature selections Document some undocumented comparison features Oct 7, 2022
riley-harper added a commit that referenced this issue Oct 7, 2022
@riley-harper
[#44] Document the present_and_equal_categorical_in_universe comparis…
07ef9a7 
…on type

I also added a note to the documentation for not_zero_and_not_equals, since
that comparison type is essentially a special case of this one.
@riley-harper riley-harper mentioned this issue Oct 7, 2022
Merged
@riley-harper riley-harper removed their assignment Dec 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation for some comparison types ipums/hlink
1 participant
@riley-harper