Upload folder using huggingface_hub

.ipynb_checkpoints/README-checkpoint.md

@@ -0,0 +1,102 @@
+---
+language:
+- en
+- ar
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.ar-en
+model-index:
+- name: quickmt-en-ar
+  results:
+  - task:
+      name: Translation eng-ara
+      type: translation
+      args: eng-ara
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: eng_Latn ara_Arab devtest
+    metrics:
+    - name: CHRF
+      type: chrf
+      value: 61.59
+    - name: BLEU
+      type: bleu
+      value: 29.61
+    - name: COMET
+      type: comet
+      value: 86.28 	
+---
+
+
+# `quickmt-en-ar` Neural Machine Translation Model 
+
+`quickmt-en-ar` is a reasonably fast and reasonably accurate neural machine translation model for translation from `en` into `ar`.
+
+
+## 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.ar-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-ar ./quickmt-en-ar
+```
+
+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-ar/", 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)
+
+> 'حذر الدكتور إيهود أور ، أستاذ الطب في جامعة دالهوزي في هاليفاكس ، نوفا سكوتيا ورئيس القسم السريري والعلمي للجمعية الكندية للسكري من أن البحث لا يزال في أيامه الأولى.'
+
+# 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)
+
+> 'وقال دكتور إيهود أور، استاذ الطب في جامعة دالهوزي في هاليفاكس، نوفا سكوشيا ورئيس القسم السريري والعلمي للجمعية الكندية للسكري، إن هذا البحث لا يزال في أيامه الأولى، وأضاف أن هذه المعلومات تعتبر دليلاً ضرورياً للإنجاز.'
+
+```
+
+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) ("kor_Hang"->"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 (using `ctranslate2`) the flores-devtest dataset (1012 sentences) on an RTX 4070s GPU with batch size 32 (faster speed is possible using a large batch size).
+
+
+|                                  |   bleu |   chrf2 |   comet22 |   Time (s) |
+|:---------------------------------|-------:|--------:|----------:|-----------:|
+| quickmt/quickmt-en-ar            |  29.61 |   61.59 |     86.28 |       1    |
+| Helsink-NLP/opus-mt-en-ar        |  23.02 |   54.74 |     83.21 |       4.37 |
+| facebook/nllb-200-distilled-600M |  23.03 |   55.13 |     84.84 |      28.4  |
+| facebook/nllb-200-distilled-1.3B |  26.48 |   58.1  |     86.23 |      48.8  |
+| facebook/m2m100_418M             |  19.4  |   51.52 |     81.36 |      22.23 |
+| facebook/m2m100_1.2B             |  13.56 |   43.43 |     75.32 |      45.77 |
+
+`quickmt-en-ar` is the fastest and highest quality.

.ipynb_checkpoints/config-checkpoint.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>"
+}

.ipynb_checkpoints/eole-config-checkpoint.yaml

@@ -0,0 +1,104 @@
+## IO
+save_data: en-ar/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: ar.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.ar-en/en
+        path_tgt: hf://quickmt/quickmt-train.ar-en/ar
+        path_sco: hf://quickmt/quickmt-train.ar-en/sco
+    valid:
+        path_src: flores-dev.en
+        path_tgt: flores-dev.ar
+
+transforms: [sentencepiece, filtertoolong]
+transforms_configs:
+  sentencepiece:
+    src_subword_model: "en.spm.model"
+    tgt_subword_model: "ar.spm.model"
+    src_subword_alpha: 0.5
+    src_subword_nbest: -1
+  filtertoolong:
+    src_seq_length: 256
+    tgt_seq_length: 256
+
+training:
+    # Run configuration
+    model_path: model
+    # train_from: model
+    keep_checkpoint: 4
+    save_checkpoint_steps: 1000
+    train_steps: 200000
+    valid_steps: 1000
+    
+    # Train on a single GPU
+    world_size: 1
+    gpu_ranks: [0]
+
+    # Batching
+    batch_type: "tokens"
+    batch_size: 8192
+    valid_batch_size: 8192
+    batch_size_multiple: 8
+    accum_count: [16]
+    accum_steps: [0]
+
+    # Optimizer & Compute
+    compute_dtype: "fp16"
+    #use_amp: true
+    optim: "pagedadamw8bit"
+    learning_rate: 2.0
+    warmup_steps: 5000
+    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]
+    max_grad_norm: 2
+    label_smoothing: 0.1
+    average_decay: 0.0001
+    param_init_method: xavier_uniform
+    normalization: "tokens"
+
+model:
+    architecture: "transformer"
+    layer_norm: standard
+    share_embeddings: false
+    share_decoder_embeddings: true
+    add_ffnbias: true
+    mlp_activation_fn: gelu
+    add_estimator: false
+    add_qkvbias: false
+    norm_eps: 1e-6
+    hidden_size: 1024
+    encoder:
+        layers: 8
+    decoder:
+        layers: 2
+    heads: 8
+    transformer_ff: 4096
+    embeddings:
+        word_vec_size: 1024
+        position_encoding_type: "SinusoidalInterleaved"
+

README.md

@@ -1,3 +1,102 @@
----
-license: cc-by-4.0
----
+---
+language:
+- en
+- ar
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.ar-en
+model-index:
+- name: quickmt-en-ar
+  results:
+  - task:
+      name: Translation eng-ara
+      type: translation
+      args: eng-ara
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: eng_Latn ara_Arab devtest
+    metrics:
+    - name: CHRF
+      type: chrf
+      value: 61.59
+    - name: BLEU
+      type: bleu
+      value: 29.61
+    - name: COMET
+      type: comet
+      value: 86.28 	
+---
+
+
+# `quickmt-en-ar` Neural Machine Translation Model 
+
+`quickmt-en-ar` is a reasonably fast and reasonably accurate neural machine translation model for translation from `en` into `ar`.
+
+
+## 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.ar-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-ar ./quickmt-en-ar
+```
+
+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-ar/", 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)
+
+> 'حذر الدكتور إيهود أور ، أستاذ الطب في جامعة دالهوزي في هاليفاكس ، نوفا سكوتيا ورئيس القسم السريري والعلمي للجمعية الكندية للسكري من أن البحث لا يزال في أيامه الأولى.'
+
+# 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)
+
+> 'وقال دكتور إيهود أور، استاذ الطب في جامعة دالهوزي في هاليفاكس، نوفا سكوشيا ورئيس القسم السريري والعلمي للجمعية الكندية للسكري، إن هذا البحث لا يزال في أيامه الأولى، وأضاف أن هذه المعلومات تعتبر دليلاً ضرورياً للإنجاز.'
+
+```
+
+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) ("kor_Hang"->"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 (using `ctranslate2`) the flores-devtest dataset (1012 sentences) on an RTX 4070s GPU with batch size 32 (faster speed is possible using a large batch size).
+
+
+|                                  |   bleu |   chrf2 |   comet22 |   Time (s) |
+|:---------------------------------|-------:|--------:|----------:|-----------:|
+| quickmt/quickmt-en-ar            |  29.61 |   61.59 |     86.28 |       1    |
+| Helsink-NLP/opus-mt-en-ar        |  23.02 |   54.74 |     83.21 |       4.37 |
+| facebook/nllb-200-distilled-600M |  23.03 |   55.13 |     84.84 |      28.4  |
+| facebook/nllb-200-distilled-1.3B |  26.48 |   58.1  |     86.23 |      48.8  |
+| facebook/m2m100_418M             |  19.4  |   51.52 |     81.36 |      22.23 |
+| facebook/m2m100_1.2B             |  13.56 |   43.43 |     75.32 |      45.77 |
+
+`quickmt-en-ar` is the fastest and highest quality.

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,104 @@
+## IO
+save_data: en-ar/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: ar.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.ar-en/en
+        path_tgt: hf://quickmt/quickmt-train.ar-en/ar
+        path_sco: hf://quickmt/quickmt-train.ar-en/sco
+    valid:
+        path_src: flores-dev.en
+        path_tgt: flores-dev.ar
+
+transforms: [sentencepiece, filtertoolong]
+transforms_configs:
+  sentencepiece:
+    src_subword_model: "en.spm.model"
+    tgt_subword_model: "ar.spm.model"
+    src_subword_alpha: 0.5
+    src_subword_nbest: -1
+  filtertoolong:
+    src_seq_length: 256
+    tgt_seq_length: 256
+
+training:
+    # Run configuration
+    model_path: model
+    # train_from: model
+    keep_checkpoint: 4
+    save_checkpoint_steps: 1000
+    train_steps: 200000
+    valid_steps: 1000
+    
+    # Train on a single GPU
+    world_size: 1
+    gpu_ranks: [0]
+
+    # Batching
+    batch_type: "tokens"
+    batch_size: 8192
+    valid_batch_size: 8192
+    batch_size_multiple: 8
+    accum_count: [16]
+    accum_steps: [0]
+
+    # Optimizer & Compute
+    compute_dtype: "fp16"
+    #use_amp: true
+    optim: "pagedadamw8bit"
+    learning_rate: 2.0
+    warmup_steps: 5000
+    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]
+    max_grad_norm: 2
+    label_smoothing: 0.1
+    average_decay: 0.0001
+    param_init_method: xavier_uniform
+    normalization: "tokens"
+
+model:
+    architecture: "transformer"
+    layer_norm: standard
+    share_embeddings: false
+    share_decoder_embeddings: true
+    add_ffnbias: true
+    mlp_activation_fn: gelu
+    add_estimator: false
+    add_qkvbias: false
+    norm_eps: 1e-6
+    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/ar.spm.model

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

eole-model/config.json

@@ -0,0 +1,151 @@
+{
+  "tensorboard_log_dir": "tensorboard",
+  "transforms": [
+    "sentencepiece",
+    "filtertoolong"
+  ],
+  "report_every": 100,
+  "tensorboard_log_dir_dated": "tensorboard/Mar-22_13-21-16",
+  "src_vocab_size": 20000,
+  "seed": 1234,
+  "tgt_vocab_size": 20000,
+  "overwrite": true,
+  "tgt_vocab": "ar.eole.vocab",
+  "tensorboard": true,
+  "src_vocab": "en.eole.vocab",
+  "valid_metrics": [
+    "BLEU"
+  ],
+  "share_vocab": false,
+  "save_data": "en-ar/data",
+  "vocab_size_multiple": 8,
+  "n_sample": 0,
+  "training": {
+    "dropout": [
+      0.1
+    ],
+    "bucket_size": 128000,
+    "prefetch_factor": 200,
+    "warmup_steps": 5000,
+    "accum_steps": [
+      0
+    ],
+    "accum_count": [
+      8
+    ],
+    "adam_beta2": 0.998,
+    "normalization": "tokens",
+    "batch_type": "tokens",
+    "attention_dropout": [
+      0.0
+    ],
+    "batch_size": 16384,
+    "learning_rate": 2.0,
+    "keep_checkpoint": 4,
+    "world_size": 1,
+    "optim": "pagedadamw8bit",
+    "average_decay": 0.0001,
+    "param_init_method": "xavier_uniform",
+    "decay_method": "noam",
+    "gpu_ranks": [
+      0
+    ],
+    "max_grad_norm": 2.0,
+    "valid_steps": 1000,
+    "train_steps": 200000,
+    "num_workers": 0,
+    "valid_batch_size": 16384,
+    "dropout_steps": [
+      0
+    ],
+    "model_path": "model",
+    "batch_size_multiple": 8,
+    "label_smoothing": 0.1,
+    "compute_dtype": "torch.float16",
+    "save_checkpoint_steps": 1000
+  },
+  "transforms_configs": {
+    "sentencepiece": {
+      "src_subword_nbest": -1,
+      "src_subword_alpha": 0.5,
+      "tgt_subword_model": "${MODEL_PATH}/ar.spm.model",
+      "src_subword_model": "${MODEL_PATH}/en.spm.model"
+    },
+    "filtertoolong": {
+      "src_seq_length": 256,
+      "tgt_seq_length": 256
+    }
+  },
+  "model": {
+    "add_ffnbias": true,
+    "hidden_size": 1024,
+    "heads": 8,
+    "share_embeddings": false,
+    "transformer_ff": 4096,
+    "share_decoder_embeddings": true,
+    "add_qkvbias": false,
+    "add_estimator": false,
+    "norm_eps": 1e-06,
+    "layer_norm": "standard",
+    "architecture": "transformer",
+    "mlp_activation_fn": "gelu",
+    "position_encoding_type": "SinusoidalInterleaved",
+    "embeddings": {
+      "position_encoding_type": "SinusoidalInterleaved",
+      "src_word_vec_size": 1024,
+      "word_vec_size": 1024,
+      "tgt_word_vec_size": 1024
+    },
+    "decoder": {
+      "norm_eps": 1e-06,
+      "add_ffnbias": true,
+      "layer_norm": "standard",
+      "hidden_size": 1024,
+      "decoder_type": "transformer",
+      "heads": 8,
+      "n_positions": null,
+      "transformer_ff": 4096,
+      "layers": 2,
+      "mlp_activation_fn": "gelu",
+      "position_encoding_type": "SinusoidalInterleaved",
+      "add_qkvbias": false,
+      "tgt_word_vec_size": 1024
+    },
+    "encoder": {
+      "encoder_type": "transformer",
+      "norm_eps": 1e-06,
+      "add_ffnbias": true,
+      "layer_norm": "standard",
+      "hidden_size": 1024,
+      "src_word_vec_size": 1024,
+      "heads": 8,
+      "n_positions": null,
+      "transformer_ff": 4096,
+      "layers": 8,
+      "mlp_activation_fn": "gelu",
+      "position_encoding_type": "SinusoidalInterleaved",
+      "add_qkvbias": false
+    }
+  },
+  "data": {
+    "corpus_1": {
+      "transforms": [
+        "sentencepiece",
+        "filtertoolong"
+      ],
+      "path_sco": "hf://quickmt/quickmt-train.ar-en/sco",
+      "path_src": "hf://quickmt/quickmt-train.ar-en/en",
+      "path_tgt": "hf://quickmt/quickmt-train.ar-en/ar",
+      "path_align": null
+    },
+    "valid": {
+      "transforms": [
+        "sentencepiece",
+        "filtertoolong"
+      ],
+      "path_src": "flores-dev.en",
+      "path_align": null,
+      "path_tgt": "flores-dev.ar"
+    }
+  }
+}

eole-model/en.spm.model

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

eole-model/model.00.safetensors

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

model.bin

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

src.spm.model

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

tgt.spm.model

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