bifonia 0.1.1__tar.gz

bifonia-0.1.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

bifonia-0.1.1/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: bifonia
+Version: 0.1.1
+Summary: Portuguese heterophonic homograph disambiguation (rule-based + learned)
+Author-email: JarbasAi <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/TigreGotico/bifonia
+Project-URL: Repository, https://github.com/TigreGotico/bifonia
+Keywords: portuguese,nlp,homograph,ipa,phonetics,g2p,tts
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# bifonia
+
+Pronunciation disambiguation for European-Portuguese **heterophonic homographs** —
+words spelled identically whose pronunciation depends on **meaning**.
+
+`sede` is *thirst* (`ˈsedɨ`, closed e) or a *headquarters* (`ˈsɛdɨ`, open e); `forma`
+is a *mould* (`ˈfoɾmɐ`) or a *shape* (`ˈfɔɾmɐ`); `molho` is *sauce* (`ˈmoʎu`) or a
+*bundle* (`ˈmɔʎu`). A text-to-speech front-end that guesses wrong says the wrong word
+out loud. bifonia picks the right reading — and therefore the right IPA — from context.
+
+```python
+from bifonia import tokenize, is_ambiguous, guess_sense, disambiguate
+
+words = tokenize("Tinha tanta sede que bebi a garrafa toda.")
+i = words.index("sede")
+guess_sense(words, i)    # 'thirst'
+disambiguate(words, i)   # 'ˈsedɨ'
+```
+
+## Why meaning, not part of speech
+
+The obvious approach — tag the part of speech and pick the pronunciation from it —
+cannot work when two readings share a POS. `sede` thirst and seat are **both nouns**;
+`corte` cut and court are both nominal; `forma` mould and shape likewise. A POS tagger
+labels them identically and is wrong on the minority reading by construction. bifonia
+keys every reading on **`sense`** (a meaning slug) and resolves the meaning directly.
+
+## Two interchangeable engines
+
+| engine | needs a corpus? | how it decides |
+|--------|-----------------|----------------|
+| **rules** | no | hand-written context rules + wordlists (`.voc`) |
+| **learned** | yes | per-word Naive-Bayes / averaged-perceptron over context features |
+
+The rule engine is self-contained and needs no training data — the right fit for a fork
+of a low-resource language. The learned models are trained from the labelled corpus and
+generalise better where enough data exists. `guess_sense` uses a **per-word ensemble**:
+each word is served by whichever engine scores at least as well on held-out data, so the
+combined system never does worse than the rules alone. Both are pure Python with no heavy
+runtime dependencies.
+
+The learned engine ships in two forms — a Naive-Bayes model and an averaged perceptron —
+and `guess_sense` loads the **averaged perceptron** by default. The perceptron leads on both
+the synthetic and the real-world benchmarks and avoids the per-word collapses that Naive-Bayes
+suffers when correlated features violate its independence assumption; it is warm-started from
+the Naive-Bayes log-odds, so its weights stay readable as per-sense lexicons. Load the other
+model explicitly with `SenseModel.load(path)` if you want to compare.
+
+## Accuracy
+
+Sense prediction, measured two ways:
+
+| approach | synthetic test | real-world (OOD) |
+|----------|:--------------:|:----------------:|
+| most-common baseline | 52.7% | 47.5% |
+| spaCy POS → sense | 65.7% | 81.4% |
+| Stanza POS → sense | 75.5% | 82.5% |
+| rules (no corpus) | 94.5% | 84.6% |
+| Naive-Bayes | 98.1% | 86.7% |
+| averaged perceptron | 99.0% | 89.6% |
+| **shipped ensemble** | **96.1%** | **90.5%** |
+
+The *synthetic* column is the held-out split of the generated training corpus, balanced
+across senses; the *OOD* column is real sentences from
+[`bifonia-pt-homographs-wild`](https://huggingface.co/datasets/TigreGotico/bifonia-pt-homographs-wild).
+The two columns answer different questions. The synthetic set is balanced, so it exposes
+how badly POS tagging handles minority readings (a tagger cannot separate two senses that
+share a part of speech — both score 0% on `sede`/thirst). Real text is skewed toward the
+majority readings POS taggers do get right, which lifts them to ~82% — yet the
+meaning-aware models still win, and the perceptron leads by ~7 points. Reproduce with
+`python benchmark_tagger.py` (synthetic) and `python benchmark_ood.py` (OOD).
+
+## Install
+
+```bash
+pip install -e . --no-deps
+```
+
+No dependencies — pure standard library.
+
+## API
+
+```python
+from bifonia import (tokenize, is_ambiguous, guess_sense, guess_pos,
+                     disambiguate, add_extra_diacritics)
+
+sentence = "Resolveu o problema desta forma simples."
+words = tokenize(sentence)
+i = words.index("forma")
+
+guess_sense(words, i)              # 'shape'
+guess_pos(words, i)                # 'NOUN'   (descriptive)
+disambiguate(words, i)             # 'ˈfɔɾmɐ'
+disambiguate(words, i, sense="mould")   # 'ˈfoɾmɐ'  (override)
+add_extra_diacritics(sentence)     # '...desta fórma simples.'  (acute = open vowel)
+```
+
+`add_extra_diacritics` rewrites each homograph with a disambiguating diacritic
+(acute → open vowel, circumflex → closed) that a downstream grapheme-to-phoneme stage
+can read directly.
+
+## Datasets
+
+Both on the Hugging Face Hub, schema `{word, sense, pos, ipa, sentence}`:
+
+- [`bifonia-pt-homographs`](https://huggingface.co/datasets/TigreGotico/bifonia-pt-homographs)
+  — 56,891 labelled sentences over 27 words, with stratified train/test splits, for
+  training and synthetic evaluation.
+- [`bifonia-pt-homographs-wild`](https://huggingface.co/datasets/TigreGotico/bifonia-pt-homographs-wild)
+  — real Wikipedia and web sentences, an out-of-distribution test set.
+
+## Word coverage
+
+27 homographs: `acordo`, `acerto`, `cerro`, `choro`, `colher`, `começo`, `conserto`,
+`coro`, `corte`, `forma`, `gosto`, `gozo`, `jogo`, `molho`, `olho`, `para`, `pelo`,
+`peso`, `porto`, `posto`, `rego`, `seco`, `sede`, `sobre`, `tola`, `torre`, `transtorno`.
+
+Per-word IPA, senses, and diacritized forms are in [`docs/words.md`](docs/words.md).
+
+## Project layout
+
+- `bifonia/data/corpus.jsonl` — the labelled corpus (single source of truth).
+- `bifonia/data/heterophonic_homographs.csv` — the `word,sense,pos,ipa` table.
+- `bifonia/data/sense_model_{nb,perceptron}.json` — trained models (JSON weights).
+- `bifonia/locale/<lang>/*.voc` — context wordlists, one term per line, editable.
+- `bifonia/features.py` — language-agnostic feature extraction (shared by train and inference).
+
+Porting to a related language means supplying a corpus and `.voc` files and retraining —
+the algorithm carries no hardcoded Portuguese.
+
+## See also
+
+- [`docs/methodology.md`](docs/methodology.md) — algorithm, features, and benchmarks
+- [`docs/usage.md`](docs/usage.md) — full API reference
+- [`docs/words.md`](docs/words.md) — per-word pronunciation notes
+- [`docs/diacritics_restoration.md`](docs/diacritics_restoration.md) — the diacritics-restoration task
+- [`examples/basic_usage.py`](examples/basic_usage.py) — runnable demo
+- [`train.py`](train.py) · [`benchmark_tagger.py`](benchmark_tagger.py) · [`benchmark_ood.py`](benchmark_ood.py)

bifonia-0.1.1/README.md

@@ -0,0 +1,138 @@
+# bifonia
+
+Pronunciation disambiguation for European-Portuguese **heterophonic homographs** —
+words spelled identically whose pronunciation depends on **meaning**.
+
+`sede` is *thirst* (`ˈsedɨ`, closed e) or a *headquarters* (`ˈsɛdɨ`, open e); `forma`
+is a *mould* (`ˈfoɾmɐ`) or a *shape* (`ˈfɔɾmɐ`); `molho` is *sauce* (`ˈmoʎu`) or a
+*bundle* (`ˈmɔʎu`). A text-to-speech front-end that guesses wrong says the wrong word
+out loud. bifonia picks the right reading — and therefore the right IPA — from context.
+
+```python
+from bifonia import tokenize, is_ambiguous, guess_sense, disambiguate
+
+words = tokenize("Tinha tanta sede que bebi a garrafa toda.")
+i = words.index("sede")
+guess_sense(words, i)    # 'thirst'
+disambiguate(words, i)   # 'ˈsedɨ'
+```
+
+## Why meaning, not part of speech
+
+The obvious approach — tag the part of speech and pick the pronunciation from it —
+cannot work when two readings share a POS. `sede` thirst and seat are **both nouns**;
+`corte` cut and court are both nominal; `forma` mould and shape likewise. A POS tagger
+labels them identically and is wrong on the minority reading by construction. bifonia
+keys every reading on **`sense`** (a meaning slug) and resolves the meaning directly.
+
+## Two interchangeable engines
+
+| engine | needs a corpus? | how it decides |
+|--------|-----------------|----------------|
+| **rules** | no | hand-written context rules + wordlists (`.voc`) |
+| **learned** | yes | per-word Naive-Bayes / averaged-perceptron over context features |
+
+The rule engine is self-contained and needs no training data — the right fit for a fork
+of a low-resource language. The learned models are trained from the labelled corpus and
+generalise better where enough data exists. `guess_sense` uses a **per-word ensemble**:
+each word is served by whichever engine scores at least as well on held-out data, so the
+combined system never does worse than the rules alone. Both are pure Python with no heavy
+runtime dependencies.
+
+The learned engine ships in two forms — a Naive-Bayes model and an averaged perceptron —
+and `guess_sense` loads the **averaged perceptron** by default. The perceptron leads on both
+the synthetic and the real-world benchmarks and avoids the per-word collapses that Naive-Bayes
+suffers when correlated features violate its independence assumption; it is warm-started from
+the Naive-Bayes log-odds, so its weights stay readable as per-sense lexicons. Load the other
+model explicitly with `SenseModel.load(path)` if you want to compare.
+
+## Accuracy
+
+Sense prediction, measured two ways:
+
+| approach | synthetic test | real-world (OOD) |
+|----------|:--------------:|:----------------:|
+| most-common baseline | 52.7% | 47.5% |
+| spaCy POS → sense | 65.7% | 81.4% |
+| Stanza POS → sense | 75.5% | 82.5% |
+| rules (no corpus) | 94.5% | 84.6% |
+| Naive-Bayes | 98.1% | 86.7% |
+| averaged perceptron | 99.0% | 89.6% |
+| **shipped ensemble** | **96.1%** | **90.5%** |
+
+The *synthetic* column is the held-out split of the generated training corpus, balanced
+across senses; the *OOD* column is real sentences from
+[`bifonia-pt-homographs-wild`](https://huggingface.co/datasets/TigreGotico/bifonia-pt-homographs-wild).
+The two columns answer different questions. The synthetic set is balanced, so it exposes
+how badly POS tagging handles minority readings (a tagger cannot separate two senses that
+share a part of speech — both score 0% on `sede`/thirst). Real text is skewed toward the
+majority readings POS taggers do get right, which lifts them to ~82% — yet the
+meaning-aware models still win, and the perceptron leads by ~7 points. Reproduce with
+`python benchmark_tagger.py` (synthetic) and `python benchmark_ood.py` (OOD).
+
+## Install
+
+```bash
+pip install -e . --no-deps
+```
+
+No dependencies — pure standard library.
+
+## API
+
+```python
+from bifonia import (tokenize, is_ambiguous, guess_sense, guess_pos,
+                     disambiguate, add_extra_diacritics)
+
+sentence = "Resolveu o problema desta forma simples."
+words = tokenize(sentence)
+i = words.index("forma")
+
+guess_sense(words, i)              # 'shape'
+guess_pos(words, i)                # 'NOUN'   (descriptive)
+disambiguate(words, i)             # 'ˈfɔɾmɐ'
+disambiguate(words, i, sense="mould")   # 'ˈfoɾmɐ'  (override)
+add_extra_diacritics(sentence)     # '...desta fórma simples.'  (acute = open vowel)
+```
+
+`add_extra_diacritics` rewrites each homograph with a disambiguating diacritic
+(acute → open vowel, circumflex → closed) that a downstream grapheme-to-phoneme stage
+can read directly.
+
+## Datasets
+
+Both on the Hugging Face Hub, schema `{word, sense, pos, ipa, sentence}`:
+
+- [`bifonia-pt-homographs`](https://huggingface.co/datasets/TigreGotico/bifonia-pt-homographs)
+  — 56,891 labelled sentences over 27 words, with stratified train/test splits, for
+  training and synthetic evaluation.
+- [`bifonia-pt-homographs-wild`](https://huggingface.co/datasets/TigreGotico/bifonia-pt-homographs-wild)
+  — real Wikipedia and web sentences, an out-of-distribution test set.
+
+## Word coverage
+
+27 homographs: `acordo`, `acerto`, `cerro`, `choro`, `colher`, `começo`, `conserto`,
+`coro`, `corte`, `forma`, `gosto`, `gozo`, `jogo`, `molho`, `olho`, `para`, `pelo`,
+`peso`, `porto`, `posto`, `rego`, `seco`, `sede`, `sobre`, `tola`, `torre`, `transtorno`.
+
+Per-word IPA, senses, and diacritized forms are in [`docs/words.md`](docs/words.md).
+
+## Project layout
+
+- `bifonia/data/corpus.jsonl` — the labelled corpus (single source of truth).
+- `bifonia/data/heterophonic_homographs.csv` — the `word,sense,pos,ipa` table.
+- `bifonia/data/sense_model_{nb,perceptron}.json` — trained models (JSON weights).
+- `bifonia/locale/<lang>/*.voc` — context wordlists, one term per line, editable.
+- `bifonia/features.py` — language-agnostic feature extraction (shared by train and inference).
+
+Porting to a related language means supplying a corpus and `.voc` files and retraining —
+the algorithm carries no hardcoded Portuguese.
+
+## See also
+
+- [`docs/methodology.md`](docs/methodology.md) — algorithm, features, and benchmarks
+- [`docs/usage.md`](docs/usage.md) — full API reference
+- [`docs/words.md`](docs/words.md) — per-word pronunciation notes
+- [`docs/diacritics_restoration.md`](docs/diacritics_restoration.md) — the diacritics-restoration task
+- [`examples/basic_usage.py`](examples/basic_usage.py) — runnable demo
+- [`train.py`](train.py) · [`benchmark_tagger.py`](benchmark_tagger.py) · [`benchmark_ood.py`](benchmark_ood.py)