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

seperating matching functions into its own module #20

Merged
merged 10 commits into from
Sep 19, 2024

Conversation

ericbuckley
Copy link
Collaborator

@ericbuckley ericbuckley commented Sep 16, 2024

Description

Moving matching functions into its own module so they can be more easily reused. Keeping these functions separate, from the logic used for linkage, allows us to move forward with creating an alternative set of linkage functions using a new schema. Also, changing the syntax of the algorithm configuration for all value references that map to python functions. The new format is func:<module_path>.<function_name>, this not only makes it easy for parsing the algorithm, but also makes it transparent to the author as to where the matching code lives.

Related Issues

closes #9

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.
  • I have notified teammates in the review thread to build awareness.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

…using a new syntax for specifying functions in the algo configs
@ericbuckley ericbuckley added the enhancement New feature or request label Sep 16, 2024
@ericbuckley ericbuckley self-assigned this Sep 16, 2024
@ericbuckley ericbuckley marked this pull request as ready for review September 17, 2024 03:20
Copy link
Collaborator

@alhayward alhayward left a comment

Choose a reason for hiding this comment

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

Left some comments/questions, some related to future refactoring efforts.

Overall I think this does a really great job of simplifying & making the code more organized!

src/recordlinker/linkage/matchers.py Show resolved Hide resolved
src/recordlinker/linkage/matchers.py Outdated Show resolved Hide resolved
src/recordlinker/linkage/matchers.py Show resolved Hide resolved
src/recordlinker/linkage/matchers.py Show resolved Hide resolved
assets/linkage/dibbs_basic_algorithm.json Show resolved Hide resolved
src/recordlinker/linkage/utils.py Show resolved Hide resolved
src/recordlinker/linkage/utils.py Outdated Show resolved Hide resolved
src/recordlinker/linkage/algorithms.py Show resolved Hide resolved
@ericbuckley ericbuckley merged commit 30da916 into main Sep 19, 2024
4 checks passed
@ericbuckley ericbuckley deleted the ericbuckley/9-breakout-transformers-matchers branch September 19, 2024 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Separate transformer and matching functions
3 participants