Skip to content

Document limitations of phonetic noise #506

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

Open
zmbc wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −0
Open

Document limitations of phonetic noise #506

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0db5f3
Document limitation of phonetic noise: lowercase only
zmbc Apr 10, 2025
dce11d9
Add another limitation
zmbc Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/source/noise/column_noise.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,14 @@ A phonetic error occurs when a character is misheard. For instance, this could h

pseudopeople defines the possible phonetic substitutions using `this file <https://github.com/ihmeuw/pseudopeople/blob/develop/src/pseudopeople/data/phonetic_variations.csv>`_, which was produced by the `GeCO project <https://dl.acm.org/doi/10.1145/2505515.2508207>`_.

.. note::

This noise type currently only applies to lowercase letters, which we plan to fix in a future release.

.. note::

Currently, the tag in the CSV file for position in the word is not respected by pseudopeople.

This noise type is called :code:`make_phonetic_errors` in the configuration. It takes two parameters:

.. list-table:: Parameters to the make_phonetic_errors noise type
Expand Down