Upload folder using huggingface_hub

.ipynb_checkpoints/README-checkpoint.md

@@ -0,0 +1,110 @@
+---
+language:
+- en
+- el
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.el-en
+model-index:
+- name: quickmt-el-en
+  results:
+  - task:
+      name: Translation ell-eng
+      type: translation
+      args: ell-eng
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: ell_Grek eng_Latn devtest
+    metrics:
+    - name: BLEU
+      type: bleu
+      value: 34.93
+    - name: CHRF
+      type: chrf
+      value: 61.4
+    - name: COMET
+      type: comet
+      value: 87.09
+---
+
+
+# `quickmt-el-en` Neural Machine Translation Model 
+
+`quickmt-el-en` is a reasonably fast and reasonably accurate neural machine translation model for translation from `el` into `en`.
+
+
+## Try it on our Huggingface Space
+
+Give it a try before downloading here: https://huggingface.co/spaces/quickmt/QuickMT-Demo
+
+
+## Model Information
+
+* Trained using [`eole`](https://github.com/eole-nlp/eole) 
+* 195M parameter transformer 'big' with 8 encoder layers and 2 decoder layers
+* 20k separate Sentencepiece vocabs
+* Expested for fast inference to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format
+* Training data: https://huggingface.co/datasets/quickmt/quickmt-train.el-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-el-en ./quickmt-el-en
+```
+
+Finally use the model in python:
+
+```python
+from quickmt impest Translator
+
+# Auto-detects GPU, set to "cpu" to force CPU inference
+t = Translator("./quickmt-el-en/", device="auto")
+
+# Translate - set beam size to 1 for faster speed (but lower quality)
+sample_text = 'Ο Δρ Έχουντ Ουρ, καθηγητής ιατρικής του Πανεπιστημίου Νταλουζί στο Χάλιφαξ της Νέας Σκωτίας και πρόεδρος του κλινικού και επιστημονικού τμήματος της Καναδικής Ένωσης Διαβήτη επεσήμανε ότι η έρευνα βρίσκεται ακόμη σε αρχικό στάδιο.'
+
+t(sample_text, beam_size=5)
+```
+
+> 'Dr. Ehud Ur, a professor of medicine at Dalouzi University in Halifax, Nova Scotia and president of the clinical and scientific division of the Canadian Diabetes Association, said the research 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. Evet Ur, Professor of Medicine at Dalusi University in Halifax, Nova Scotia and Chairman of Clinical and Scientific Department of the Canadian Diabetes Association, said the research was still at an early stage.'
+
+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) ("ell_Grek"->"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).
+
+
+
+## el -> en flores-devtest metrics
+
+|                                   |   bleu |   chrf2 |   comet22 |   Time (s) |
+|:----------------------------------|-------:|--------:|----------:|-----------:|
+| quickmt/quickmt-el-en             |  34.93 |   61.4  |     87.09 |       1.55 |
+| Helsinki-NLP/opus-mt-tc-big-el-en |  34.3  |   61.45 |     86.86 |       3.92 |
+| facebook/nllb-200-distilled-600M  |  34.75 |   60.86 |     86.79 |      23.01 |
+| facebook/nllb-200-distilled-1.3B  |  37.59 |   63.22 |     87.85 |      41.7  |
+| facebook/m2m100_418M              |  27.26 |   55.95 |     83.17 |      20.67 |
+| facebook/m2m100_1.2B              |  33.21 |   60.22 |     86.35 |      38.88 |

README.md

@@ -1,3 +1,110 @@
----
-license: cc-by-4.0
----
+---
+language:
+- en
+- el
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.el-en
+model-index:
+- name: quickmt-el-en
+  results:
+  - task:
+      name: Translation ell-eng
+      type: translation
+      args: ell-eng
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: ell_Grek eng_Latn devtest
+    metrics:
+    - name: BLEU
+      type: bleu
+      value: 34.93
+    - name: CHRF
+      type: chrf
+      value: 61.4
+    - name: COMET
+      type: comet
+      value: 87.09
+---
+
+
+# `quickmt-el-en` Neural Machine Translation Model 
+
+`quickmt-el-en` is a reasonably fast and reasonably accurate neural machine translation model for translation from `el` into `en`.
+
+
+## Try it on our Huggingface Space
+
+Give it a try before downloading here: https://huggingface.co/spaces/quickmt/QuickMT-Demo
+
+
+## Model Information
+
+* Trained using [`eole`](https://github.com/eole-nlp/eole) 
+* 195M parameter transformer 'big' with 8 encoder layers and 2 decoder layers
+* 20k separate Sentencepiece vocabs
+* Expested for fast inference to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format
+* Training data: https://huggingface.co/datasets/quickmt/quickmt-train.el-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-el-en ./quickmt-el-en
+```
+
+Finally use the model in python:
+
+```python
+from quickmt impest Translator
+
+# Auto-detects GPU, set to "cpu" to force CPU inference
+t = Translator("./quickmt-el-en/", device="auto")
+
+# Translate - set beam size to 1 for faster speed (but lower quality)
+sample_text = 'Ο Δρ Έχουντ Ουρ, καθηγητής ιατρικής του Πανεπιστημίου Νταλουζί στο Χάλιφαξ της Νέας Σκωτίας και πρόεδρος του κλινικού και επιστημονικού τμήματος της Καναδικής Ένωσης Διαβήτη επεσήμανε ότι η έρευνα βρίσκεται ακόμη σε αρχικό στάδιο.'
+
+t(sample_text, beam_size=5)
+```
+
+> 'Dr. Ehud Ur, a professor of medicine at Dalouzi University in Halifax, Nova Scotia and president of the clinical and scientific division of the Canadian Diabetes Association, said the research 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. Evet Ur, Professor of Medicine at Dalusi University in Halifax, Nova Scotia and Chairman of Clinical and Scientific Department of the Canadian Diabetes Association, said the research was still at an early stage.'
+
+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) ("ell_Grek"->"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).
+
+
+
+## el -> en flores-devtest metrics
+
+|                                   |   bleu |   chrf2 |   comet22 |   Time (s) |
+|:----------------------------------|-------:|--------:|----------:|-----------:|
+| quickmt/quickmt-el-en             |  34.93 |   61.4  |     87.09 |       1.55 |
+| Helsinki-NLP/opus-mt-tc-big-el-en |  34.3  |   61.45 |     86.86 |       3.92 |
+| facebook/nllb-200-distilled-600M  |  34.75 |   60.86 |     86.79 |      23.01 |
+| facebook/nllb-200-distilled-1.3B  |  37.59 |   63.22 |     87.85 |      41.7  |
+| facebook/m2m100_418M              |  27.26 |   55.95 |     83.17 |      20.67 |
+| facebook/m2m100_1.2B              |  33.21 |   60.22 |     86.35 |      38.88 |

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>"
+}

ct2-elen/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>"
+}

ct2-elen/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: el.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.el-en/el
+        # path_tgt: hf://quickmt/quickmt-train.el-en/en
+        # path_sco: hf://quickmt/quickmt-train.el-en/sco
+        path_src: train.el
+        path_tgt: train.en
+    valid:
+        path_src: valid.el
+        path_tgt: valid.en
+
+transforms: [sentencepiece, filtertoolong]
+transforms_configs:
+  sentencepiece:
+    src_subword_model: "el.spm.model"
+    tgt_subword_model: "en.spm.model"
+  filtertoolong:
+    src_seq_length: 256
+    tgt_seq_length: 256
+
+training:
+    # Run configuration
+    model_path: quickmt-el-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"
+

ct2-elen/model.bin

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

ct2-elen/src.spm.model

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

ct2-elen/tgt.spm.model

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

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

eole-model/el.spm.model

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

eole-model/en.spm.model

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

eole-model/model.00.safetensors

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

model.bin

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

src.spm.model

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

tgt.spm.model

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