Update documentation examples to use Splink 5 APIs - #3322
Open
Robin Linacre (RobinL) wants to merge 1 commit into
Open
Robin Linacre (RobinL) wants to merge 1 commit into
Robin Linacre (RobinL) wants to merge 1 commit into
Conversation
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Copying several documentation examples into Splink 5 fails because they pass raw data or
db_apitoLinker, call obsolete comparison/dataset methods, or use settings that no longer exist.Update the README and affected guides to register inputs first, use the current API names and settings, and load saved models through the v5 constructor. Also correct the README's date input type and the blocking/term-frequency examples, and use record output in the basic examples so they do not require pandas. This changes documentation only.
Validation: reproduced the old API failures, executed the revised markdown examples against the unmodified v5 runtime, and smoke-ran 45 notebook source files successfully with DuckDB 1.5.5, PyArrow 25.0.1 and SQLGlot 30.18.0. Notebook runs used temporary output directories and cached example data. Spark and the optional pseudopeople example were not executed; a static API-signature sweep included all 47 notebooks. No runtime, deployment, dependency or test changes are included.
Closes #3321.