Skip to content

Commit

Permalink
Add extra filter options for graphic and phonetic similarity
Browse files Browse the repository at this point in the history
Also renames these properties so they're easier to access on
the Match.
  • Loading branch information
thatbudakguy committed Jul 28, 2024
1 parent 83d2dfe commit 633909a
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 11 deletions.
53 changes: 45 additions & 8 deletions dphon/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,37 @@
containing at least one token with shared phonemes but differing
graphemes (a graphic variant) are shown.
--min <NUM> [default: 8]
--min-length <NUM> [default: 8]
Limit to matches with total number of tokens >= NUM. Has no effect if
less than the value for "--ngram-order".
--max <NUM> [default: 64]
--max-length <NUM> [default: 64]
Limit to matches with total number of tokens <= NUM. Must be equal to
or greater than the value for "--ngram-order".
--min-graphic-similarity <NUM> [default: 0]
Limit to matches with a graphic similarity ratio >= NUM. The default is
to allow matches with no graphic similarity at all (0).
--max-graphic-similarity <NUM> [default: 0.9]
Limit to matches with a graphic similarity ratio <= NUM. The default is
to exclude matches that are almost graphically identical (0.9).
--min-phonetic-similarity <NUM> [default: 0.7]
Limit to matches with a phonetic similarity ratio >= NUM. The default is
to allow matches with some phonetic variance (0.7).
--max-phonetic-similarity <NUM> [default: 1]
Limit to matches with a phonetic similarity ratio <= NUM. The default is
to allow matches that are phonetically identical (1).
Display options:
-g, --group [default: False]
Group matches by shared text. By default, matches are displayed as
individual pairs of similar sequences.
Examples:
dphon texts/*.txt --min 8 > matches.txt
dphon texts/*.txt > matches.txt
dphon file1.txt file2.txt --ngram-order 8 --threshold 0.8
dphon docs.jsonl --input-format jsonl --output-format jsonl > matches.jsonl
Expand Down Expand Up @@ -246,11 +267,27 @@ def process(nlp: Language, args: Dict) -> MatchGraph:
# align all matches
graph.align(SmithWatermanPhoneticAligner(gap_char=" "))

# limit via min and max lengths if requested
if args["--min"]:
graph.filter(lambda m: len(m) >= int(args["--min"]))
if args["--max"]:
graph.filter(lambda m: len(m) <= int(args["--max"]))
# filter if requested
if args["--min-length"]:
graph.filter(lambda m: len(m) >= int(args["--min-length"]))
if args["--max-length"]:
graph.filter(lambda m: len(m) <= int(args["--max-length"]))
if args["--min-graphic-similarity"]:
graph.filter(
lambda m: m.graphic_similarity >= float(args["--min-graphic-similarity"])
)
if args["--max-graphic-similarity"]:
graph.filter(
lambda m: m.graphic_similarity <= float(args["--max-graphic-similarity"])
)
if args["--min-phonetic-similarity"]:
graph.filter(
lambda m: m.phonetic_similarity >= float(args["--min-phonetic-similarity"])
)
if args["--max-phonetic-similarity"]:
graph.filter(
lambda m: m.phonetic_similarity <= float(args["--max-phonetic-similarity"])
)

# group all matches
graph.group()
Expand Down
6 changes: 3 additions & 3 deletions dphon/match.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def phonetic_similarity(self) -> float:
def weighted_score(self) -> float:
"""Ratio of phonemic similarity to graphic similarity."""
try:
return self.weight / Lev.seqratio(self.au, self.av)
return self.phonetic_similarity / self.graphic_similarity
except ZeroDivisionError:
return math.inf

Expand All @@ -78,6 +78,6 @@ def as_dict(self) -> Dict[str, str]:
"u_end": self.utxt.end,
"v_start": self.vtxt.start,
"v_end": self.vtxt.end,
"score": str(self.weight),
"weighted_score": str(self.weighted_score),
"phonetic_similarity": self.phonetic_similarity,
"graphic_similarity": self.graphic_similarity,
}

0 comments on commit 633909a

Please sign in to comment.