adalat-ai-tech · janaab11 · May 5, 2026 · Apr 24, 2026 · Apr 24, 2026 · Apr 24, 2026
diff --git a/.gitignore b/.gitignore
@@ -24,6 +24,10 @@ ENV/
 .coverage
 htmlcov/
 
+# Lint / type-check caches
+.ruff_cache/
+.mypy_cache/
+
 # Jupyter Notebook
 .ipynb_checkpoints
 
@@ -32,5 +36,21 @@ htmlcov/
 *.swp
 .DS_Store
 
-# Root-level test files (kept locally for development)
-/test*.py
+# AI/dev harness configuration (kept local, not in public repo)
+CLAUDE.md
+AGENTS.md
+.claude/
+
+# Internal-only documentation
+docs/internal/
+
+# Benchmark / evaluation outputs
+# Only examples/ SUBDIRECTORIES are ignored; top-level example scripts stay tracked.
+examples/*/
+# User-specific domain configs sitting flat in examples/ or src/scribe/config/
+examples/custom_*.txt
+src/scribe/config/custom_*.txt
+# Ad-hoc test scripts dropped in examples/ (separate from the tests/ tree)
+examples/test_*.py
+# Root-level eval result directory
+malayalam-model-results/
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,201 @@
+                                 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 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 Support. 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 support.
+
+   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 2026 Adalat AI
+
+   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.
diff --git a/README.md b/README.md
@@ -1,24 +1,32 @@
-# DictErrors — Dictation Error Analysis for Indic Languages
+# SCRIBE — Diagnostic Evaluation for Indic & Domain-Specific ASR
 
-[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/scribe-eval.svg)](https://pypi.org/project/scribe-eval/)
+[![Python](https://img.shields.io/pypi/pyversions/scribe-eval.svg)](https://pypi.org/project/scribe-eval/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
 
-DictErrors is a specialized tool for analyzing ASR (Automatic Speech Recognition) transcription errors in Indic languages (Malayalam, Kannada). It provides fine-grained error metrics by categorizing tokens into base categories (WORD, NUMERAL, PUNCT) and optional domain-specific categories (LEGAL, MEDICAL, TECH, or custom).
+`scribe-eval` is the open-source evaluation framework introduced in the SCRIBE
+paper (*Diagnostic Evaluation and Rich Transcription Models for Indic ASR*,
+under review at Interspeech 2026). It provides fine-grained error metrics for
+ASR systems on Indic languages (Malayalam, Kannada, Hindi, ...) and on
+domain-specific transcription (legal, medical, technical).
 
-Domain-critical terminology is shielded from incorrect splitting and tracked separately — so a single misrecognized legal term doesn't inflate your general WER.
+Token categories are decomposed into base classes (WORD, NUMERAL, PUNCT) and
+optional domain classes (LEGAL, MEDICAL, TECH, or custom). Domain-critical
+terminology is shielded from incorrect splitting and tracked separately — so a
+single misrecognized legal term doesn't inflate your general WER.
 
 ## Installation
 
 ```bash
-git clone https://github.com/adalat-ai-tech/dict-errors.git
-cd dict-errors
-uv sync && uv pip install -e .
+pip install scribe-eval                # core library
+pip install 'scribe-eval[visualizer]'  # adds Streamlit UI
+pip install 'scribe-eval[charts]'      # adds matplotlib charts
 ```
 
 ## Quick Start
 
 ```python
-from dicterrors import text_error_rates, DomainConfig
+from scribe import text_error_rates, DomainConfig
 
 ref = "charged u/s 302 IPC on 22.05.2023"
 hyp = "charged u/s 303 IPC on 22.05.2023"
@@ -47,7 +55,7 @@ print(f"NER: {report['NUMERAL']['error_rate']:.2%}")
 | PUNCT | base | PER | Punctuation marks |
 | LEGAL | domain | LER | Indian legal terminology (u/s, r/w, PW1, Ext.A) |
 | MEDICAL | domain | MER | Medical units and dosages (mg, ml, 500mg) |
-| TECH | domain | TER | Technical abbreviations (API, SDK, v1.0) |
+| TECH | domain | TchER | Technical abbreviations (API, SDK, v1.0) |
 | Custom | domain | configurable | Define your own with lists or regex patterns |
 
 ## Domain Configuration
@@ -56,26 +64,79 @@ Factory methods for bundled domains: `DomainConfig.legal()`, `DomainConfig.medic
 
 File-based and custom inline configs are also supported. See [docs/domain-configuration.md](docs/domain-configuration.md).
 
+## Examples
+
+Runnable scripts under [`examples/`](examples/) demonstrate alignment,
+single-sample reports, domain-config patterns, and full batch evaluation.
+See [`examples/README.md`](examples/README.md) for the full index.
+
 ## Batch Processing
 
 ```bash
-cd examples/
-uv run batch_evaluate.py --input predictions.jsonl --domain-config config/legal_terms.txt --analysis --chart
+uv run examples/batch_evaluate.py --analysis --chart
 ```
 
 See [docs/batch-processing.md](docs/batch-processing.md) for the Python API, CLI arguments, and output schema.
 
 ## Interactive Visualizer
 
 ```bash
-streamlit run visualizer.py
+pip install 'scribe-eval[visualizer]'
+scribe-visualizer
 ```
 
 See [docs/visualizer.md](docs/visualizer.md).
 
 ## Dependencies
 
-- `levenshtein>=0.27.1`, `jiwer>=4.0.0`, `streamlit>=1.53.0`, `tabulate>=0.9.0`
+Core: `jiwer>=4.0.0`, `levenshtein>=0.27.1`, `tabulate>=0.9.0`
+
+Optional extras: `matplotlib` (for `[charts]`), `streamlit` and `pandas` (for `[visualizer]`).
+
+## Development
+
+```bash
+git clone https://github.com/adalat-ai-tech/scribe-eval.git
+cd scribe-eval
+uv sync --all-extras --dev    # core + [charts] + [visualizer] + [dev]
+```
+
+### Running tests
+
+```bash
+uv run pytest                              # full suite
+uv run pytest tests/test_analysis.py       # one file
+uv run pytest -k sandhi                    # name pattern (-k matches by substring)
+uv run pytest -v                           # verbose, with each test name
+uv run pytest --cov=scribe                 # with coverage
+```
+
+Tests are organised one file per library module under [`tests/`](tests/), plus
+[`tests/test_paper_cases.py`](tests/test_paper_cases.py) for end-to-end golden
+cases from the SCRIBE paper. `pytest` itself ships with the `[dev]` extra, so
+`uv sync --all-extras --dev` (above) is required first.
+
+### Lint and format
+
+```bash
+uv run ruff check src tests examples       # lint
+uv run ruff format src tests examples      # auto-format
+```
+
+See [`docs/architecture.md`](docs/architecture.md) for the module map and a
+glossary of project-specific terminology (sandhi, combined denominator, TER,
+Accuracy, ...).
+
+## Citation
+
+The SCRIBE paper is currently under anonymous review at Interspeech 2026. A
+BibTeX entry will be added here once the proceedings or arXiv preprint are
+publicly available. Until then, please cite this repository directly via the
+"Cite this repository" button on GitHub.
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE).
 
 ## Acknowledgements