netra-nmt 0.1.0__tar.gz

netra_nmt-0.1.0/.gitignore

@@ -0,0 +1,259 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.myenv
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+myenv/
+./myenv/
+./myenv
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+
+./data
+data/
+data
+corpus.txt
+
+./checkpoints 
+checkpoints/
+checkpoints
+
+checkpoints_distill
+
+checkpoints_human_finetune
+
+checkpoints_finetune/
+
+archived/
+
+tokenizer/corpus.txt
+tokenizer/*.model
+tokenizer/*.vocab
+# netra-nmt release export (weights go to Hugging Face Hub)
+export/
+
+DESIGN_SYSTEM.md
+# Standalone Streamlit Space (not part of the package; deployed separately)
+streamlit_space/
+
+# Benchmark scripts and generated chart / result images (local, not versioned)
+scripts/benchmark_speed*.py
+scripts/chart_speed.py
+results/benchmark_speed*.json
+
+scripts/training/
+
+test.py

netra_nmt-0.1.0/08_test_tokenizer.py

@@ -0,0 +1,11 @@
+import sentencepiece as spm
+
+model = spm.SentencePieceProcessor()
+
+model.load("tokenizer/spm_32k.model")
+
+text = "ខ្ញុំទៅសាលារៀន I go to school"
+
+print("INPUT:", text)
+print("TOKENS:", model.encode(text, out_type=str))
+print("IDS:", model.encode(text, out_type=int))

netra_nmt-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Netra Lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

netra_nmt-0.1.0/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: netra-nmt
+Version: 0.1.0
+Summary: A compact, from-scratch English↔Khmer neural machine translation model.
+Project-URL: Homepage, https://github.com/NDarayut/netra-nmt
+Author-email: Darayut Nhem <darayutnhem009@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: english,khmer,nmt,seq2seq,transformer,translation
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: huggingface-hub>=0.20.0
+Requires-Dist: numpy
+Requires-Dist: safetensors>=0.4.0
+Requires-Dist: sentencepiece>=0.1.99
+Requires-Dist: torch>=2.0
+Provides-Extra: train
+Requires-Dist: accelerate; extra == 'train'
+Requires-Dist: bert-score>=0.3.13; extra == 'train'
+Requires-Dist: datasets; extra == 'train'
+Requires-Dist: fasttext-wheel; extra == 'train'
+Requires-Dist: khmercut; extra == 'train'
+Requires-Dist: langdetect; extra == 'train'
+Requires-Dist: pandas; extra == 'train'
+Requires-Dist: pyarrow; extra == 'train'
+Requires-Dist: sacrebleu>=2.3.1; extra == 'train'
+Requires-Dist: unbabel-comet>=2.2.0; extra == 'train'
+Provides-Extra: web
+Requires-Dist: fastapi>=0.110; extra == 'web'
+Requires-Dist: uvicorn[standard]>=0.27; extra == 'web'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img
+    src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/logo.png"
+    width="20%"
+    alt="Netra Lab"
+    style="vertical-align: middle; margin-right: 30px;"
+  />
+  <img
+    src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/wordmark.png"
+    width="20%"
+    alt="Netra Lab"
+    style="vertical-align: middle;"
+  />
+</div>
+
+<hr>
+
+<p align="center">
+ <a href="https://github.com/netra-ai-lab/Netra-NMT"><b>GitHub</b></a> |
+  <a href="https://huggingface.co/Darayut/netra-nmt-small"><b>Model Download</b></a> |
+    <a href="https://huggingface.co/datasets/Darayut/bilingual-en-km"><b>Dataset Download</b></a> |
+    <a href="https://huggingface.co/spaces/Darayut/Netra-NMT"><b>Inference Space</b></a> |
+</p>
+
+<h2>
+<p align="center">
+  <a href="">A Compact Bidirectional Encoder-Decoder Transformer-Based Model for English-Khmer Translation</a>
+</p>
+</h2>
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/inference_benchmark.png" style="width: 1000px" align=center>
+</p>
+
+<p align="center">
+<a href="">Inference Speed Benchmark on CPU Using Greedy, and Beam Search Decoding Strategy</a>       
+</p>
+
+## 1. Abstract
+This repository present Netra-NMT a 90M-parameter encoder-decoder transformer-based model trained on **220 million tokens** of English-Khmer parallel text (4.2M bidirectional examples). The encoder uses bidirectional self-attention, much like BERT, to capture global contextual representation. The decoder perform autoregressive generation through causal self-attention and encoder-decoder cross attention.
+
+Unlike traditional transformer block, Netra-NMT incorporates several architectural improvements, including Pre-Layer Normalization (Pre-LN) for stable optimization, SwiGLU feed-forward networks for enhanced representational capacity, and weight tying between the decoder embedding layer and output projection head to reduce parameter redundancy.
+
+## 2. Dataset
+
+Netra-NMT was trained on **220 million tokens** drawn from approximately **2.4 million unique English-Khmer sentence pairs** (4.2 million examples after bidirectional augmentation). The corpus combines LLM-generated synthetic data with web-crawled parallel text, spanning legal, literary, medical, technical, and conversational domains.
+
+### 2.1 Sources
+
+| Dataset | Type | Pairs | Domains |
+|---------|------|------:|---------|
+| [Darayut/khmer-english-pairs-raw](https://huggingface.co/datasets/Darayut/khmer-english-pairs-raw) | Synthetic | 200K | Legal, Literary, Governmental |
+| [lyfeyvutha/nllb-en-km-316K](https://huggingface.co/datasets/lyfeyvutha/nllb-en-km-316K) | Synthetic | 316K | General |
+| [KrorngAI/ParaCrawl-English-Khmer-v2](https://huggingface.co/datasets/KrorngAI/ParaCrawl-English-Khmer-v2) | Web crawl (ParaCrawl) | 1.5M | Web / general |
+| [SeyhaLite/Translate-English-Khmer-All](https://huggingface.co/datasets/SeyhaLite/Translate-English-Khmer-All) | --- | 366K | General |
+| **Total** | | **2.4M** | |
+
+### 2.2 Preprocessing
+
+Raw data was cleaned through the following pipeline:
+
+1. **Deduplication**: exact duplicate pairs removed across all sources.
+2. **Length filtering**: pairs with extreme source/target length mismatches were discarded.
+3. **Empty/null removal**: pairs where either side was empty or below a minimum token count were dropped.
+
+After cleaning, each surviving pair is duplicated in both directions (`EN→KM` and `KM→EN`) with a direction prefix token (`<2km>` / `<2en>`), yielding ~4.2 million training examples.
+
+## 3. Model Architecture
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/model_architecture.png" width="70%" alt="Netra-NMT Architecture" />
+  <p><em>Figure 1: Overview of the Netra-NMT encoder-decoder architecture. The encoder (left) processes the source sentence with bidirectional self-attention; the decoder (right) generates the target sentence autoregressively via causal self-attention and cross-attention over the encoder output. Both sides share a 32K SentencePiece tokenizer.</em></p>
+</div>
+
+Netra-NMT follows a standard encoder-decoder transformer architecture with several modifications for training stability and parameter efficiency.
+
+**Encoder**  takes the source sentence tokenized by the shared 32K SentencePiece tokenizer, adds learned positional embeddings, and passes the sequence through 6 transformer layers with *bidirectional* self-attention (every token attends to every other token, similar to BERT). A final Pre-LN layer norm is applied to the encoder output before it is passed to the decoder via cross-attention.
+
+**Decoder** takes the (partially generated) target sentence through the same tokenizer, adds positional embeddings, and passes it through 6 transformer layers. Each decoder layer applies three sub-layers in order: (1) *causal* (masked) self-attention over previously generated tokens, (2) cross-attention over the full encoder output, and (3) a feed-forward block. A final Pre-LN layer norm feeds into the tied linear projection head to produce output token probabilities.
+
+**Architectural improvements over the vanilla transformer:**
+
+| Feature | Detail |
+|---------|--------|
+| Pre-Layer Normalization | Layer norm applied *before* each sub-layer (Pre-LN) rather than after, improving gradient flow and training stability |
+| SwiGLU FFN | Feed-forward blocks use the SwiGLU activation instead of ReLU, providing richer representational capacity at no parameter cost |
+| Weight tying | The decoder input embedding matrix is shared with the output linear projection head, reducing redundant parameters |
+
+**Hyperparameters:**
+
+| | |
+|---|---|
+| d_model | 512 |
+| Encoder / Decoder layers | 6 / 6 |
+| Attention heads | 8 |
+| FFN hidden size | 2048 |
+| Vocabulary | 32K (SentencePiece unigram, shared) |
+| Total parameters | ~89.7M |
+
+## 4. Evaluation Results
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/metrics_benchmark.png" style="width: 1000px" align=center>
+</p>
+
+## Install
+
+```bash
+pip install netra-nmt              # core (Python API + CLI)
+pip install "netra-nmt[web]"       # + FastAPI web app & REST API
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/NDarayut/netra-nmt
+cd netra-nmt
+pip install -e ".[web]"
+```
+
+The first translation downloads the weights (~180 MB fp16) from the Hugging Face Hub and caches them
+under `~/.cache/huggingface`.
+
+## Usage
+
+### 1. Python API
+
+```python
+from netra_nmt import NetraTranslator
+
+t = NetraTranslator()                       # auto-detect GPU/CPU; downloads weights once
+t.translate("Hello, how are you?", direction="en2km")   # → "សួស្តី សុខសប្បាយអត់?"
+t.translate("ខ្ញុំស្រឡាញ់ប្រទេសរបស់ខ្ញុំ។", direction="km2en")
+
+# Batch + decoding options
+t.translate_batch(["Good morning.", "See you tomorrow."], direction="en2km")
+t.translate("Good morning, my friend.", direction="en2km", mode="beam", beam_size=5)
+```
+
+One-shot helper (caches a default translator):
+
+```python
+from netra_nmt import translate
+translate("Hello", direction="en2km")
+```
+
+`direction` is `"en2km"` (English→Khmer) or `"km2en"` (Khmer→English).
+`mode` is `"greedy"` (default), `"beam"`, or `"sample"`.
+
+### 2. CLI
+
+```bash
+# Single sentence (default direction en2km):
+netra-translate --text "Hello, how are you?"
+
+# Khmer → English with beam search:
+netra-translate --text "សួស្តី, តើអ្នកសុខសប្បាយទេ?" --direction km2en --mode beam
+
+# Translate a file (one sentence per line):
+netra-translate --file input.txt --output output.txt --direction en2km
+
+# Interactive REPL (omit --text / --file):
+netra-translate
+```
+
+### 3. Web app + REST API (FastAPI)
+
+```bash
+netra-web                      # serves the web UI + API at http://127.0.0.1:8000
+netra-web --port 8080 --device cpu
+netra-web --local-dir export   # load weights from a local export dir
+```
+
+A two-pane translation site (source left, output right, EN⇄KM swap button) plus a JSON API:
+
+```bash
+curl -X POST http://127.0.0.1:8000/api/translate \
+  -H 'Content-Type: application/json' \
+  -d '{"text": "Hello, how are you?", "direction": "en2km"}'
+# {"translation": "...", "direction": "en2km"}
+```
+
+Requires the `web` extra (`pip install "netra-nmt[web]"`).

netra_nmt-0.1.0/README.md

@@ -0,0 +1,183 @@
+<div align="center">
+  <img
+    src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/logo.png"
+    width="20%"
+    alt="Netra Lab"
+    style="vertical-align: middle; margin-right: 30px;"
+  />
+  <img
+    src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/wordmark.png"
+    width="20%"
+    alt="Netra Lab"
+    style="vertical-align: middle;"
+  />
+</div>
+
+<hr>
+
+<p align="center">
+ <a href="https://github.com/netra-ai-lab/Netra-NMT"><b>GitHub</b></a> |
+  <a href="https://huggingface.co/Darayut/netra-nmt-small"><b>Model Download</b></a> |
+    <a href="https://huggingface.co/datasets/Darayut/bilingual-en-km"><b>Dataset Download</b></a> |
+    <a href="https://huggingface.co/spaces/Darayut/Netra-NMT"><b>Inference Space</b></a> |
+</p>
+
+<h2>
+<p align="center">
+  <a href="">A Compact Bidirectional Encoder-Decoder Transformer-Based Model for English-Khmer Translation</a>
+</p>
+</h2>
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/inference_benchmark.png" style="width: 1000px" align=center>
+</p>
+
+<p align="center">
+<a href="">Inference Speed Benchmark on CPU Using Greedy, and Beam Search Decoding Strategy</a>       
+</p>
+
+## 1. Abstract
+This repository present Netra-NMT a 90M-parameter encoder-decoder transformer-based model trained on **220 million tokens** of English-Khmer parallel text (4.2M bidirectional examples). The encoder uses bidirectional self-attention, much like BERT, to capture global contextual representation. The decoder perform autoregressive generation through causal self-attention and encoder-decoder cross attention.
+
+Unlike traditional transformer block, Netra-NMT incorporates several architectural improvements, including Pre-Layer Normalization (Pre-LN) for stable optimization, SwiGLU feed-forward networks for enhanced representational capacity, and weight tying between the decoder embedding layer and output projection head to reduce parameter redundancy.
+
+## 2. Dataset
+
+Netra-NMT was trained on **220 million tokens** drawn from approximately **2.4 million unique English-Khmer sentence pairs** (4.2 million examples after bidirectional augmentation). The corpus combines LLM-generated synthetic data with web-crawled parallel text, spanning legal, literary, medical, technical, and conversational domains.
+
+### 2.1 Sources
+
+| Dataset | Type | Pairs | Domains |
+|---------|------|------:|---------|
+| [Darayut/khmer-english-pairs-raw](https://huggingface.co/datasets/Darayut/khmer-english-pairs-raw) | Synthetic | 200K | Legal, Literary, Governmental |
+| [lyfeyvutha/nllb-en-km-316K](https://huggingface.co/datasets/lyfeyvutha/nllb-en-km-316K) | Synthetic | 316K | General |
+| [KrorngAI/ParaCrawl-English-Khmer-v2](https://huggingface.co/datasets/KrorngAI/ParaCrawl-English-Khmer-v2) | Web crawl (ParaCrawl) | 1.5M | Web / general |
+| [SeyhaLite/Translate-English-Khmer-All](https://huggingface.co/datasets/SeyhaLite/Translate-English-Khmer-All) | --- | 366K | General |
+| **Total** | | **2.4M** | |
+
+### 2.2 Preprocessing
+
+Raw data was cleaned through the following pipeline:
+
+1. **Deduplication**: exact duplicate pairs removed across all sources.
+2. **Length filtering**: pairs with extreme source/target length mismatches were discarded.
+3. **Empty/null removal**: pairs where either side was empty or below a minimum token count were dropped.
+
+After cleaning, each surviving pair is duplicated in both directions (`EN→KM` and `KM→EN`) with a direction prefix token (`<2km>` / `<2en>`), yielding ~4.2 million training examples.
+
+## 3. Model Architecture
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/model_architecture.png" width="70%" alt="Netra-NMT Architecture" />
+  <p><em>Figure 1: Overview of the Netra-NMT encoder-decoder architecture. The encoder (left) processes the source sentence with bidirectional self-attention; the decoder (right) generates the target sentence autoregressively via causal self-attention and cross-attention over the encoder output. Both sides share a 32K SentencePiece tokenizer.</em></p>
+</div>
+
+Netra-NMT follows a standard encoder-decoder transformer architecture with several modifications for training stability and parameter efficiency.
+
+**Encoder**  takes the source sentence tokenized by the shared 32K SentencePiece tokenizer, adds learned positional embeddings, and passes the sequence through 6 transformer layers with *bidirectional* self-attention (every token attends to every other token, similar to BERT). A final Pre-LN layer norm is applied to the encoder output before it is passed to the decoder via cross-attention.
+
+**Decoder** takes the (partially generated) target sentence through the same tokenizer, adds positional embeddings, and passes it through 6 transformer layers. Each decoder layer applies three sub-layers in order: (1) *causal* (masked) self-attention over previously generated tokens, (2) cross-attention over the full encoder output, and (3) a feed-forward block. A final Pre-LN layer norm feeds into the tied linear projection head to produce output token probabilities.
+
+**Architectural improvements over the vanilla transformer:**
+
+| Feature | Detail |
+|---------|--------|
+| Pre-Layer Normalization | Layer norm applied *before* each sub-layer (Pre-LN) rather than after, improving gradient flow and training stability |
+| SwiGLU FFN | Feed-forward blocks use the SwiGLU activation instead of ReLU, providing richer representational capacity at no parameter cost |
+| Weight tying | The decoder input embedding matrix is shared with the output linear projection head, reducing redundant parameters |
+
+**Hyperparameters:**
+
+| | |
+|---|---|
+| d_model | 512 |
+| Encoder / Decoder layers | 6 / 6 |
+| Attention heads | 8 |
+| FFN hidden size | 2048 |
+| Vocabulary | 32K (SentencePiece unigram, shared) |
+| Total parameters | ~89.7M |
+
+## 4. Evaluation Results
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/netra-ai-lab/Netra-NMT/main/assets/metrics_benchmark.png" style="width: 1000px" align=center>
+</p>
+
+## Install
+
+```bash
+pip install netra-nmt              # core (Python API + CLI)
+pip install "netra-nmt[web]"       # + FastAPI web app & REST API
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/NDarayut/netra-nmt
+cd netra-nmt
+pip install -e ".[web]"
+```
+
+The first translation downloads the weights (~180 MB fp16) from the Hugging Face Hub and caches them
+under `~/.cache/huggingface`.
+
+## Usage
+
+### 1. Python API
+
+```python
+from netra_nmt import NetraTranslator
+
+t = NetraTranslator()                       # auto-detect GPU/CPU; downloads weights once
+t.translate("Hello, how are you?", direction="en2km")   # → "សួស្តី សុខសប្បាយអត់?"
+t.translate("ខ្ញុំស្រឡាញ់ប្រទេសរបស់ខ្ញុំ។", direction="km2en")
+
+# Batch + decoding options
+t.translate_batch(["Good morning.", "See you tomorrow."], direction="en2km")
+t.translate("Good morning, my friend.", direction="en2km", mode="beam", beam_size=5)
+```
+
+One-shot helper (caches a default translator):
+
+```python
+from netra_nmt import translate
+translate("Hello", direction="en2km")
+```
+
+`direction` is `"en2km"` (English→Khmer) or `"km2en"` (Khmer→English).
+`mode` is `"greedy"` (default), `"beam"`, or `"sample"`.
+
+### 2. CLI
+
+```bash
+# Single sentence (default direction en2km):
+netra-translate --text "Hello, how are you?"
+
+# Khmer → English with beam search:
+netra-translate --text "សួស្តី, តើអ្នកសុខសប្បាយទេ?" --direction km2en --mode beam
+
+# Translate a file (one sentence per line):
+netra-translate --file input.txt --output output.txt --direction en2km
+
+# Interactive REPL (omit --text / --file):
+netra-translate
+```
+
+### 3. Web app + REST API (FastAPI)
+
+```bash
+netra-web                      # serves the web UI + API at http://127.0.0.1:8000
+netra-web --port 8080 --device cpu
+netra-web --local-dir export   # load weights from a local export dir
+```
+
+A two-pane translation site (source left, output right, EN⇄KM swap button) plus a JSON API:
+
+```bash
+curl -X POST http://127.0.0.1:8000/api/translate \
+  -H 'Content-Type: application/json' \
+  -d '{"text": "Hello, how are you?", "direction": "en2km"}'
+# {"translation": "...", "direction": "en2km"}
+```
+
+Requires the `web` extra (`pip install "netra-nmt[web]"`).