quickmt-en-id / README.md
radinplaid's picture
Upload folder using huggingface_hub
caa6821 verified
---
language:
- en
- id
tags:
- translation
license: cc-by-4.0
datasets:
- quickmt/quickmt-train.id-en
model-index:
- name: quickmt-en-id
results:
- task:
name: Translation eng-ind
type: translation
args: eng-ind
dataset:
name: flores101-devtest
type: flores_101
args: eng_Latn ind_Latn devtest
metrics:
- name: BLEU
type: bleu
value: 48.69
- name: CHRF
type: chrf
value: 71.95
- name: COMET
type: comet
value: 91.02
---
# `quickmt-en-id` Neural Machine Translation Model
`quickmt-en-id` is a reasonably fast and reasonably accurate neural machine translation model for translation from `en` into `id`.
## Model Information
* Trained using [`eole`](https://github.com/eole-nlp/eole)
* 185M parameter transformer 'big' with 8 encoder layers and 2 decoder layers
* 20k sentencepiece vocabularies
* Exported for fast inference to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format
* Training data: https://huggingface.co/datasets/quickmt/quickmt-train.id-en/tree/main
See the `eole` model configuration in this repository for further details and the `eole-model` for the raw `eole` (pytorch) model.
## Usage with `quickmt`
You must install the Nvidia cuda toolkit first, if you want to do GPU inference.
Next, install the `quickmt` python library and download the model:
```bash
git clone https://github.com/quickmt/quickmt.git
pip install ./quickmt/
quickmt-model-download quickmt/quickmt-en-id ./quickmt-en-id
```
Finally use the model in python:
```python
from quickmt import Translator
# Auto-detects GPU, set to "cpu" to force CPU inference
t = Translator("./quickmt-en-id/", device="auto")
# Translate - set beam size to 5 for higher quality (but slower speed)
sample_text = 'Dr. Ehud Ur, professor of medicine at Dalhousie University in Halifax, Nova Scotia and chair of the clinical and scientific division of the Canadian Diabetes Association cautioned that the research is still in its early days.'
t(sample_text, beam_size=5)
```
> 'Dr Ehud Ur, profesor kedokteran di Universitas Dalhousie di Halifax, Nova Scotia dan ketua divisi klinis dan ilmiah dari Asosiasi Diabetes Kanada memperingatkan bahwa penelitian ini masih dalam hari-hari awal.'
```python
# Get alternative translations by sampling
# You can pass any cTranslate2 `translate_batch` arguments
t([sample_text], sampling_temperature=1.2, beam_size=1, sampling_topk=50, sampling_topp=0.9)
```
> 'Prof. Ehud Ur, Profesor kedokteran di Dalhousie University, Halifax, Nova Scotia dan pimpinan divisi klinis dan ilmiah di Canadian Diabetes Association, memperingatkan bahwa penelitian ini masih belum mencapai tahap awal perkembangannya.'
The model is in `ctranslate2` format, and the tokenizers are `sentencepiece`, so you can use `ctranslate2` directly instead of through `quickmt`. It is also possible to get this model to work with e.g. [LibreTranslate](https://libretranslate.com/) which also uses `ctranslate2` and `sentencepiece`.
## Metrics
`bleu` and `chrf2` are calculated with [sacrebleu](https://github.com/mjpost/sacrebleu) on the [Flores200 `devtest` test set](https://huggingface.co/datasets/facebook/flores) ("eng_Latn"->"ind_Latn"). `comet22` with the [`comet`](https://github.com/Unbabel/COMET) library and the [default model](https://huggingface.co/Unbabel/wmt22-comet-da). "Time (s)" is the time in seconds to translate (using `ctranslate2`) the flores-devtest dataset (1012 sentences) on an RTX 4070s GPU with batch size 32 (faster speed is possible with a larger batch size).
| | bleu | chrf2 | comet22 | Time (s) |
|:---------------------------------|-------:|--------:|----------:|-----------:|
| quickmt/quickmt-en-id | 48.69 | 71.95 | 91.02 | 1.13 |
| Helsinki-NLP/opus-mt-en-id | 39.71 | 66.5 | 88.24 | 3.08 |
| facebook/nllb-200-distilled-600M | 43.74 | 69.06 | 90.47 | 19.16 |
| facebook/nllb-200-distilled-1.3B | 46.14 | 70.7 | 91.39 | 33.09 |
| facebook/m2m100_418M | 36.77 | 63.8 | 87.13 | 16.93 |
| facebook/m2m100_1.2B | 42.62 | 68.04 | 89.76 | 32.4 |