Upload folder using huggingface_hub

.ipynb_checkpoints/README-checkpoint.md

@@ -0,0 +1,102 @@
+---
+language:
+- en
+- lv
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.lv-en
+model-index:
+- name: quickmt-en-lv
+  results:
+  - task:
+      name: Translation eng-lav
+      type: translation
+      args: eng-lav
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: eng_Latn lvs_Latn devtest
+    metrics:
+    - name: BLEU
+      type: bleu
+      value: 35.3
+    - name: CHRF
+      type: chrf
+      value: 62.91
+    - name: COMET
+      type: comet
+      value: 86.98
+---
+
+
+# `quickmt-en-lv` Neural Machine Translation Model 
+
+`quickmt-en-lv` is a reasonably fast and reasonably accurate neural machine translation model for translation from `en` into `lv`.
+
+
+## Model Information
+
+* Trained using [`eole`](https://github.com/eole-nlp/eole)
+* 200M parameter transformer 'big' with 8 encoder layers and 2 decoder layers
+* 32k sentencepiece vocabularies
+* Exported for fast inference to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format
+* Training data: https://huggingface.co/datasets/quickmt/quickmt-train.lv-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-lv ./quickmt-en-lv
+```
+
+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-lv/", 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 Uhr, Professor of Medicine at Dalhuzy University in Halifax, Nova Scotia, and Chair of the Clinical and Scientific Department of the Canadian Diabetes Association, warned that the study is still in its early stages.'
+
+```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)
+```
+
+> 'Dr. Ehud Uurs, a professor of medicine at Dalhuzy University, Halifax, Nova Scotia, and chair of the clinical and scientific department of the Canadian Diabeta Association warned that the research was still under the start.'
+
+
+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"->"lvs_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-lv             |  31.46 |   60.49 |     86.22 |       1.39 |
+| Helsinki-NLP/opus-mt-tc-big-en-lv |  30.8  |   60.11 |     86.00 |       3.43 |
+| facebook/nllb-200-distilled-600M  |  18.9  |   49.28 |     79.11 |      24.48 |
+| facebook/nllb-200-distilled-1.3B  |  23.63 |   53.56 |     86.08 |      49.36 |
+| facebook/m2m100_418M              |  22.11 |   52.52 |     81.47 |      22.18 |
+| facebook/m2m100_1.2B              |  28.75 |   58.55 |     87.66 |      42.55 |
+

README.md

@@ -1,3 +1,102 @@
----
-license: cc-by-4.0
----
+---
+language:
+- en
+- lv
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.lv-en
+model-index:
+- name: quickmt-en-lv
+  results:
+  - task:
+      name: Translation eng-lav
+      type: translation
+      args: eng-lav
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: eng_Latn lvs_Latn devtest
+    metrics:
+    - name: BLEU
+      type: bleu
+      value: 35.3
+    - name: CHRF
+      type: chrf
+      value: 62.91
+    - name: COMET
+      type: comet
+      value: 86.98
+---
+
+
+# `quickmt-en-lv` Neural Machine Translation Model 
+
+`quickmt-en-lv` is a reasonably fast and reasonably accurate neural machine translation model for translation from `en` into `lv`.
+
+
+## Model Information
+
+* Trained using [`eole`](https://github.com/eole-nlp/eole)
+* 200M parameter transformer 'big' with 8 encoder layers and 2 decoder layers
+* 32k sentencepiece vocabularies
+* Exported for fast inference to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format
+* Training data: https://huggingface.co/datasets/quickmt/quickmt-train.lv-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-lv ./quickmt-en-lv
+```
+
+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-lv/", 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 Uhr, Professor of Medicine at Dalhuzy University in Halifax, Nova Scotia, and Chair of the Clinical and Scientific Department of the Canadian Diabetes Association, warned that the study is still in its early stages.'
+
+```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)
+```
+
+> 'Dr. Ehud Uurs, a professor of medicine at Dalhuzy University, Halifax, Nova Scotia, and chair of the clinical and scientific department of the Canadian Diabeta Association warned that the research was still under the start.'
+
+
+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"->"lvs_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-lv             |  31.46 |   60.49 |     86.22 |       1.39 |
+| Helsinki-NLP/opus-mt-tc-big-en-lv |  30.8  |   60.11 |     86.00 |       3.43 |
+| facebook/nllb-200-distilled-600M  |  18.9  |   49.28 |     79.11 |      24.48 |
+| facebook/nllb-200-distilled-1.3B  |  23.63 |   53.56 |     86.08 |      49.36 |
+| facebook/m2m100_418M              |  22.11 |   52.52 |     81.47 |      22.18 |
+| facebook/m2m100_1.2B              |  28.75 |   58.55 |     87.66 |      42.55 |
+

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: en.eole.vocab
+tgt_vocab: lv.eole.vocab
+src_vocab_size: 32000
+tgt_vocab_size: 32000
+vocab_size_multiple: 8
+share_vocab: false
+n_sample: 0
+
+data:
+    corpus_1:
+        # path_src: hf://quickmt/quickmt-train.lv-en/en
+        # path_tgt: hf://quickmt/quickmt-train.lv-en/lv
+        # path_sco: hf://quickmt/quickmt-train.lv-en/sco
+        path_src: train.en
+        path_tgt: train.lv
+    valid:
+        path_src: valid.en
+        path_tgt: valid.lv
+
+transforms: [sentencepiece, filtertoolong]
+transforms_configs:
+  sentencepiece:
+    src_subword_model: "en.spm.model"
+    tgt_subword_model: "lv.spm.model"
+  filtertoolong:
+    src_seq_length: 256
+    tgt_seq_length: 256
+
+training:
+    # Run configuration
+    model_path: quickmt-en-lv-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: 6000
+    valid_batch_size: 2048
+    batch_size_multiple: 8
+    accum_count: [15]
+    accum_steps: [0]
+
+    # Optimizer & Compute
+    compute_dtype: "fp16"
+    optim: "adamw"
+    #use_amp: False
+    learning_rate: 2.0
+    warmup_steps: 2000
+    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: true
+    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 @@
+{
+  "src_vocab": "en.eole.vocab",
+  "seed": 1234,
+  "tensorboard_log_dir_dated": "tensorboard/Oct-02_06-26-30",
+  "save_data": "data",
+  "valid_metrics": [
+    "BLEU"
+  ],
+  "tensorboard_log_dir": "tensorboard",
+  "tgt_vocab": "lv.eole.vocab",
+  "n_sample": 0,
+  "src_vocab_size": 32000,
+  "share_vocab": false,
+  "report_every": 100,
+  "tensorboard": true,
+  "transforms": [
+    "sentencepiece",
+    "filtertoolong"
+  ],
+  "tgt_vocab_size": 32000,
+  "vocab_size_multiple": 8,
+  "overwrite": true,
+  "training": {
+    "num_workers": 0,
+    "keep_checkpoint": 4,
+    "learning_rate": 2.0,
+    "optim": "adamw",
+    "valid_batch_size": 2048,
+    "gpu_ranks": [
+      0
+    ],
+    "train_steps": 100000,
+    "param_init_method": "xavier_uniform",
+    "batch_size": 6000,
+    "batch_type": "tokens",
+    "valid_steps": 5000,
+    "accum_steps": [
+      0
+    ],
+    "average_decay": 0.0001,
+    "accum_count": [
+      15
+    ],
+    "decay_method": "noam",
+    "world_size": 1,
+    "model_path": "quickmt-en-lv-eole-model",
+    "normalization": "tokens",
+    "dropout_steps": [
+      0
+    ],
+    "bucket_size": 128000,
+    "max_grad_norm": 0.0,
+    "save_checkpoint_steps": 5000,
+    "compute_dtype": "torch.float16",
+    "adam_beta2": 0.998,
+    "dropout": [
+      0.1
+    ],
+    "label_smoothing": 0.1,
+    "attention_dropout": [
+      0.1
+    ],
+    "batch_size_multiple": 8,
+    "prefetch_factor": 32,
+    "warmup_steps": 2000
+  },
+  "transforms_configs": {
+    "sentencepiece": {
+      "tgt_subword_model": "${MODEL_PATH}/lv.spm.model",
+      "src_subword_model": "${MODEL_PATH}/en.spm.model"
+    },
+    "filtertoolong": {
+      "src_seq_length": 256,
+      "tgt_seq_length": 256
+    }
+  },
+  "model": {
+    "share_embeddings": false,
+    "heads": 8,
+    "share_decoder_embeddings": true,
+    "transformer_ff": 4096,
+    "architecture": "transformer",
+    "position_encoding_type": "SinusoidalInterleaved",
+    "hidden_size": 1024,
+    "encoder": {
+      "heads": 8,
+      "layers": 8,
+      "n_positions": null,
+      "transformer_ff": 4096,
+      "encoder_type": "transformer",
+      "src_word_vec_size": 1024,
+      "position_encoding_type": "SinusoidalInterleaved",
+      "hidden_size": 1024
+    },
+    "embeddings": {
+      "word_vec_size": 1024,
+      "position_encoding_type": "SinusoidalInterleaved",
+      "tgt_word_vec_size": 1024,
+      "src_word_vec_size": 1024
+    },
+    "decoder": {
+      "heads": 8,
+      "layers": 2,
+      "decoder_type": "transformer",
+      "tgt_word_vec_size": 1024,
+      "n_positions": null,
+      "transformer_ff": 4096,
+      "position_encoding_type": "SinusoidalInterleaved",
+      "hidden_size": 1024
+    }
+  },
+  "data": {
+    "corpus_1": {
+      "transforms": [
+        "sentencepiece",
+        "filtertoolong"
+      ],
+      "path_align": null,
+      "path_src": "train.en",
+      "path_tgt": "train.lv"
+    },
+    "valid": {
+      "transforms": [
+        "sentencepiece",
+        "filtertoolong"
+      ],
+      "path_align": null,
+      "path_src": "valid.en",
+      "path_tgt": "valid.lv"
+    }
+  }
+}

eole-model/en.spm.model

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

eole-model/lv.spm.model

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

eole-model/model.00.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:581ddbf0cb97a7f6d02dab25398ebdcf55f30a5523b7bde3ef3e0fbdcc5e3670
+size 840314816

model.bin

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

src.spm.model

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

tgt.spm.model

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