Return boolean from alignment process indicating need for manual correction of encoding #37
Conversation
Modifies a number of functions to return an indicator of whether text and volpiano encoding was proper, even in cases where an alignment can be made.
dchiller
force-pushed
the
i-35-catch-errors-boolean
branch
from
d8e0a56 to
8c52e26
Compare
| if vol_syls[-1][-3:] != "---" or vol_syls[-1][-4] == "-": | ||
| final_syl_of_word = vol_syls[-1] | ||
| if final_syl_of_word[-3:] != "---" or len(final_syl_of_word) < 4: | ||
| volpiano_improperly_spaced = True | ||
| elif vol_syls[-1][-4] == "-": |
There was a problem hiding this comment.
I don't really understand the purpose of this change - maybe I'm thrown off by the commit message - if len(vol_syls) < 4, we would have gotten an IndexError rather than a ValueError when we checked vol_syls[-1][-4] wouldn't we have?
For the elif at the bottom here, could we not have elif final_syl_of_word[-4] ... instead of elif vol_syls[-1][-4] ...?
A simpler alternative, which I understand to be more pythonic, would be to wrap if vol_syls[-1][-3:] != "---" or vol_syls[-1][-4] == "-": in a try: ... except IndexError: # last syllable has too few characters ...
But I digress - if this is just a typo in the commit message, that's fine - don't try to fix the commit message. Switching to a try/except is up to you, whichever approach you prefer is fine.
There was a problem hiding this comment.
Ok, a few things happened here:
- I just was careless in my commit message and wrote
ValueErrorrather thanIndexError...oops! - I switched to defining the
final_syl_of_wordvariable rather than usingvol_syls[-1]everywhere because it seemed clearer...and then forgot to replace every instance ofvol_syls[-1]...also oops! - The
try/exceptapproach does seem like it makes more sense generally. I think I'll just make that switch here.
There was a problem hiding this comment.
so....standby for some fixes.
|
Actually, if you don't implement the try/except, please do switch to |
dchiller
force-pushed
the
i-35-catch-errors-boolean
branch
from
9970ad3 to
9d11541
Compare
The
align_text_and_volpianofunction now returns an alignment and a boolean flag that indicates whether the volpiano and text are properly encoded. A return value ofTrueis meant to indicate the need for manual correction of the encoding. This return value is now tested in volpiano syllabification and alignment tests.As an additional test, every chant on Cantus Database with a melody and a manuscript spelling full text encoded (n = 48,639) was aligned. Only 1 chant failed to align completely and a total of 18,220 chants aligned with manual correction suggested. The chant that failed was 254921, which seems now to be a bit of an edge case for which I don't think we have a convention (although maybe we make what @annamorphism has edited it to be the convention, see #38).
Fixes #35.