Upload folder using huggingface_hub

.ipynb_checkpoints/README-checkpoint.md

@@ -0,0 +1,99 @@
+---
+language:
+- en
+- pt
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.pt-en
+model-index:
+- name: quickmt-pt-en
+  results:
+  - task:
+      name: Translation por-eng
+      type: translation
+      args: por-eng
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: por_Latn eng_Latn devtest
+    metrics:
+    - name: BLEU
+      type: bleu
+      value: 48.67
+    - name: CHRF
+      type: chrf
+      value: 71.47
+    - name: COMET
+      type: comet
+      value: 89.09 
+---
+
+
+# `quickmt-pt-en` Neural Machine Translation Model 
+
+`quickmt-pt-en` is a reasonably fast and reasonably accurate neural machine translation model for translation from `pt` into `en`.
+
+
+## Model Information
+
+* Trained using [`eole`](https://github.com/eole-nlp/eole)
+* 185M parameter transformer 'big' with 8 encoder layers and 2 decoder layers
+* 50k joint Sentencepiece vocabulary
+* Exported for fast inference to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format
+* Training data: https://huggingface.co/datasets/quickmt/quickmt-train.pt-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-pt-en ./quickmt-pt-en
+```
+
+Finally use the model in python:
+
+```python
+from quickmt import Translator
+
+# Auto-detects GPU, set to "cpu" to force CPU inference
+t = Translator("./quickmt-pt-en/", device="auto")
+
+# Translate - set beam size to 1 for faster speed (but lower quality)
+sample_text = 'O Médico Ehud Ur, um professor de medicina na Universidade de Dalhousie em Halifax, Nova Escócia, e presidente da divisão clínica e científica da Canadian Diabetes Association disse que o estudo ainda está dando seus primeiros passos.'
+
+t(sample_text, beam_size=5)
+```
+
+> 'Doctor Ehud Ur, a professor of medicine at Dalhousie University in Halifax, Nova Scotia, and president of the clinical and scientific division of the Canadian Diabetes Association said the study is still taking its first steps.'
+
+```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)
+```
+
+> 'Doctor Ehud Ur, a professor of medicine at Dalhousie University in Halifax, Nova Scotia, and president of the clinical and scientific division of the Canadian Diabetes Association said the study is still giving it its first steps.'
+
+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) ("por_Latn"->"eng_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 the flores-devtest dataset (1012 sentences) on an RTX 4070s GPU with batch size 32 (faster speed is possible using a larger batch size).
+
+|                                  |   bleu |   chrf2 |   comet22 |   Time (s) |
+|:---------------------------------|-------:|--------:|----------:|-----------:|
+| quickmt/quickmt-pt-en            |  48.67 |   71.47 |     89.09 |       1.24 |
+| Helsink-NLP/opus-mt-roa-en       |  45.1  |   69.43 |     88.22 |       3.69 |
+| facebook/nllb-200-distilled-600M |  48.77 |   71.3  |     89.2  |      21.42 |
+| facebook/nllb-200-distilled-1.3B |  51.02 |   72.83 |     89.78 |      36.86 |
+| facebook/m2m100_418M             |  40.01 |   66.14 |     86.01 |      17.8  |
+| facebook/m2m100_1.2B             |  45.69 |   69.52 |     88.3  |      34.42 |

README.md

@@ -1,3 +1,99 @@
----
-license: cc-by-4.0
----
+---
+language:
+- en
+- pt
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.pt-en
+model-index:
+- name: quickmt-pt-en
+  results:
+  - task:
+      name: Translation por-eng
+      type: translation
+      args: por-eng
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: por_Latn eng_Latn devtest
+    metrics:
+    - name: BLEU
+      type: bleu
+      value: 48.67
+    - name: CHRF
+      type: chrf
+      value: 71.47
+    - name: COMET
+      type: comet
+      value: 89.09 
+---
+
+
+# `quickmt-pt-en` Neural Machine Translation Model 
+
+`quickmt-pt-en` is a reasonably fast and reasonably accurate neural machine translation model for translation from `pt` into `en`.
+
+
+## Model Information
+
+* Trained using [`eole`](https://github.com/eole-nlp/eole)
+* 185M parameter transformer 'big' with 8 encoder layers and 2 decoder layers
+* 50k joint Sentencepiece vocabulary
+* Exported for fast inference to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format
+* Training data: https://huggingface.co/datasets/quickmt/quickmt-train.pt-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-pt-en ./quickmt-pt-en
+```
+
+Finally use the model in python:
+
+```python
+from quickmt import Translator
+
+# Auto-detects GPU, set to "cpu" to force CPU inference
+t = Translator("./quickmt-pt-en/", device="auto")
+
+# Translate - set beam size to 1 for faster speed (but lower quality)
+sample_text = 'O Médico Ehud Ur, um professor de medicina na Universidade de Dalhousie em Halifax, Nova Escócia, e presidente da divisão clínica e científica da Canadian Diabetes Association disse que o estudo ainda está dando seus primeiros passos.'
+
+t(sample_text, beam_size=5)
+```
+
+> 'Doctor Ehud Ur, a professor of medicine at Dalhousie University in Halifax, Nova Scotia, and president of the clinical and scientific division of the Canadian Diabetes Association said the study is still taking its first steps.'
+
+```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)
+```
+
+> 'Doctor Ehud Ur, a professor of medicine at Dalhousie University in Halifax, Nova Scotia, and president of the clinical and scientific division of the Canadian Diabetes Association said the study is still giving it its first steps.'
+
+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) ("por_Latn"->"eng_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 the flores-devtest dataset (1012 sentences) on an RTX 4070s GPU with batch size 32 (faster speed is possible using a larger batch size).
+
+|                                  |   bleu |   chrf2 |   comet22 |   Time (s) |
+|:---------------------------------|-------:|--------:|----------:|-----------:|
+| quickmt/quickmt-pt-en            |  48.67 |   71.47 |     89.09 |       1.24 |
+| Helsink-NLP/opus-mt-roa-en       |  45.1  |   69.43 |     88.22 |       3.69 |
+| facebook/nllb-200-distilled-600M |  48.77 |   71.3  |     89.2  |      21.42 |
+| facebook/nllb-200-distilled-1.3B |  51.02 |   72.83 |     89.78 |      36.86 |
+| facebook/m2m100_418M             |  40.01 |   66.14 |     86.01 |      17.8  |
+| facebook/m2m100_1.2B             |  45.69 |   69.52 |     88.3  |      34.42 |

config.json

@@ -0,0 +1,10 @@
+{
+  "add_source_bos": false,
+  "add_source_eos": false,
+  "bos_token": "<s>",
+  "decoder_start_token": "<s>",
+  "eos_token": "</s>",
+  "layer_norm_epsilon": 1e-06,
+  "multi_query_attention": false,
+  "unk_token": "<unk>"
+}

eole-config.yaml

@@ -0,0 +1,98 @@
+## IO
+save_data: data
+overwrite: True
+seed: 1234
+report_every: 100
+valid_metrics: ["BLEU"]
+tensorboard: true
+tensorboard_log_dir: tensorboard
+
+### Vocab
+src_vocab: pt.eole.vocab
+tgt_vocab: en.eole.vocab
+src_vocab_size: 20000
+tgt_vocab_size: 20000
+vocab_size_multiple: 8
+share_vocab: false
+n_sample: 0
+
+data:
+    corpus_1:
+        # path_src: hf://quickmt/quickmt-train.pt-en/pt
+        # path_tgt: hf://quickmt/quickmt-train.pt-en/en
+        # path_sco: hf://quickmt/quickmt-train.pt-en/sco
+        path_src: train.pt
+        path_tgt: train.en
+    valid:
+        path_src: dev.pt
+        path_tgt: dev.en
+
+transforms: [sentencepiece, filtertoolong]
+transforms_configs:
+  sentencepiece:
+    src_subword_model: "pt.spm.model"
+    tgt_subword_model: "en.spm.model"
+  filtertoolong:
+    src_seq_length: 256
+    tgt_seq_length: 256
+
+training:
+    # Run configuration
+    model_path: quickmt-pt-en-eole-model
+    #train_from: model
+    keep_checkpoint: 4
+    train_steps: 100000
+    save_checkpoint_steps: 5000
+    valid_steps: 5000
+    
+    # Train on a single GPU
+    world_size: 1
+    gpu_ranks: [0]
+
+    # Batching 10240
+    batch_type: "tokens"
+    batch_size: 8000
+    valid_batch_size: 4096
+    batch_size_multiple: 8
+    accum_count: [10]
+    accum_steps: [0]
+
+    # Optimizer & Compute
+    compute_dtype: "fp16"
+    optim: "adamw"
+    #use_amp: False
+    learning_rate: 2.0
+    warmup_steps: 4000
+    decay_method: "noam"
+    adam_beta2: 0.998
+
+    # Data loading
+    bucket_size: 128000
+    num_workers: 4
+    prefetch_factor: 32
+    
+    # Hyperparams
+    dropout_steps: [0]
+    dropout: [0.1]
+    attention_dropout: [0.1]
+    max_grad_norm: 0
+    label_smoothing: 0.1
+    average_decay: 0.0001
+    param_init_method: xavier_uniform
+    normalization: "tokens"
+
+model:
+    architecture: "transformer"
+    share_embeddings: false
+    share_decoder_embeddings: false
+    hidden_size: 1024
+    encoder:
+        layers: 8
+    decoder:
+        layers: 2
+    heads: 8
+    transformer_ff: 4096
+    embeddings:
+        word_vec_size: 1024
+        position_encoding_type: "SinusoidalInterleaved"
+

eole-model/config.json

@@ -0,0 +1,132 @@
+{
+  "tensorboard": true,
+  "tensorboard_log_dir": "tensorboard",
+  "src_vocab_size": 20000,
+  "report_every": 100,
+  "tgt_vocab_size": 20000,
+  "transforms": [
+    "sentencepiece",
+    "filtertoolong"
+  ],
+  "seed": 1234,
+  "vocab_size_multiple": 8,
+  "overwrite": true,
+  "tensorboard_log_dir_dated": "tensorboard/May-12_17-49-06",
+  "save_data": "data",
+  "tgt_vocab": "en.eole.vocab",
+  "n_sample": 0,
+  "share_vocab": false,
+  "src_vocab": "pt.eole.vocab",
+  "valid_metrics": [
+    "BLEU"
+  ],
+  "training": {
+    "bucket_size": 128000,
+    "gpu_ranks": [
+      0
+    ],
+    "attention_dropout": [
+      0.1
+    ],
+    "normalization": "tokens",
+    "label_smoothing": 0.1,
+    "param_init_method": "xavier_uniform",
+    "save_checkpoint_steps": 5000,
+    "compute_dtype": "torch.float16",
+    "num_workers": 0,
+    "world_size": 1,
+    "dropout_steps": [
+      0
+    ],
+    "valid_steps": 5000,
+    "batch_size_multiple": 8,
+    "decay_method": "noam",
+    "batch_size": 8000,
+    "keep_checkpoint": 4,
+    "prefetch_factor": 32,
+    "adam_beta2": 0.998,
+    "warmup_steps": 4000,
+    "valid_batch_size": 4096,
+    "batch_type": "tokens",
+    "model_path": "quickmt-pt-en-eole-model",
+    "accum_count": [
+      10
+    ],
+    "optim": "adamw",
+    "average_decay": 0.0001,
+    "max_grad_norm": 0.0,
+    "train_steps": 100000,
+    "learning_rate": 2.0,
+    "dropout": [
+      0.1
+    ],
+    "accum_steps": [
+      0
+    ]
+  },
+  "model": {
+    "share_decoder_embeddings": false,
+    "position_encoding_type": "SinusoidalInterleaved",
+    "architecture": "transformer",
+    "transformer_ff": 4096,
+    "heads": 8,
+    "share_embeddings": false,
+    "hidden_size": 1024,
+    "embeddings": {
+      "position_encoding_type": "SinusoidalInterleaved",
+      "src_word_vec_size": 1024,
+      "tgt_word_vec_size": 1024,
+      "word_vec_size": 1024
+    },
+    "decoder": {
+      "n_positions": null,
+      "position_encoding_type": "SinusoidalInterleaved",
+      "transformer_ff": 4096,
+      "layers": 2,
+      "heads": 8,
+      "tgt_word_vec_size": 1024,
+      "decoder_type": "transformer",
+      "hidden_size": 1024
+    },
+    "encoder": {
+      "encoder_type": "transformer",
+      "n_positions": null,
+      "position_encoding_type": "SinusoidalInterleaved",
+      "transformer_ff": 4096,
+      "layers": 8,
+      "src_word_vec_size": 1024,
+      "heads": 8,
+      "hidden_size": 1024
+    }
+  },
+  "transforms_configs": {
+    "filtertoolong": {
+      "tgt_seq_length": 256,
+      "src_seq_length": 256
+    },
+    "sentencepiece": {
+      "src_subword_model": "${MODEL_PATH}/pt.spm.model",
+      "tgt_subword_model": "${MODEL_PATH}/en.spm.model"
+    }
+  },
+  "data": {
+    "corpus_1": {
+      "transforms": [
+        "sentencepiece",
+        "filtertoolong"
+      ],
+      "path_align": null,
+      "path_tgt": "train.en",
+      "path_src": "train.pt"
+    },
+    "valid": {
+      "transforms": [
+        "sentencepiece",
+        "filtertoolong"
+      ],
+      "path_align": null,
+      "path_tgt": "dev.en",
+      "path_src": "dev.pt"
+    }
+  }
+}

eole-model/en.spm.model

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:78491a281ebde4ebda824d711469fdaf02970c4d5d3a0ff55e4cbb73c6f6f888
+size 587171

eole-model/model.00.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:840efa28e2ce211b7db72ebc4c92703a55074c30f237615c5c481496cc248b57
+size 823882912

eole-model/pt.spm.model

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:582204569977759a46b4636cf0ead18bb981cd2ca7d9d42a15962072835b6d25
+size 600641

model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:280031a6870098ef8b80d7ffa7cd1c4ea77e6eb05fdb8a90fa46b60e11ba11fc
+size 401699775

src.spm.model

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:582204569977759a46b4636cf0ead18bb981cd2ca7d9d42a15962072835b6d25
+size 600641

tgt.spm.model

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:78491a281ebde4ebda824d711469fdaf02970c4d5d3a0ff55e4cbb73c6f6f888
+size 587171