Upload folder using huggingface_hub

.ipynb_checkpoints/README-checkpoint.md

@@ -0,0 +1,105 @@
+---
+language:
+- en
+- is
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.is-en
+model-index:
+- name: quickmt-en-is
+  results:
+  - task:
+      name: Translation eng-isl
+      type: translation
+      args: isl-eng
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: eng_Latn isl_Latn
+    metrics:
+    - name: BLEU
+      type: bleu
+      value: 25.85
+    - name: CHRF
+      type: chrf
+      value: 53.31
+    - name: COMET
+      type: comet
+      value: 80.89
+---
+
+
+# `quickmt-en-is` Neural Machine Translation Model 
+
+`quickmt-en-is` is a reasonably fast and reasonably accurate neural machine translation model for translation from `en` into `is`.
+
+
+## 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) 
+* 200M parameter transformer 'big' with 8 encoder layers and 2 decoder layers
+* 32k separate Sentencepiece vocabs
+* Exported for fast inference to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format
+
+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-is ./quickmt-en-is
+```
+
+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-is/", device="auto")
+
+# Translate - set beam size to 1 for faster speed (but lower quality)
+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)
+```
+
+> 'Ehud Ur, prófessor í læknisfræði við Dalhousie háskólann í Halifax, Nova Scotia og formaður klínískrar og vísindalegrar deildar kanadísku sykursýkisamtakanna varaði við því að rannsóknin væri enn á fyrstu dögum.'
+
+```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)
+```
+
+> 'Ehud Ur, prófessor í lyflækninga við Dalhousie Háskólann í Halifax, Nova Scotia, og formaður klínískrar og vísindalegrar deildar kanadísku sykursýkisamtakanna varaði við því að rannsóknarinnar væri enn á frumdögum.'
+
+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`. A model in safetensors format to be used with `eole` is also provided.
+
+
+## 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"->"isl_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 Nvidia RTX 4070s GPU with batch size 32.
+
+|                                  |   bleu |   chrf2 |   comet22 |   Time (s) |
+|:---------------------------------|-------:|--------:|----------:|-----------:|
+| quickmt/quickmt-en-is            |  25.85 |   53.31 |     80.89 |       1.75 |
+| Helsinki-NLP/opus-mt-en-is       |  18.57 |   46.63 |     76.47 |       3.93 |
+| facebook/nllb-200-distilled-600M |  19.8  |   47.44 |     81.45 |      26.36 |
+| facebook/nllb-200-distilled-1.3B |  23.04 |   50.93 |     84.15 |      46.58 |
+| facebook/m2m100_418M             |  11.93 |   37.46 |     63.74 |      22.54 |
+| facebook/m2m100_1.2B             |  17.52 |   45.25 |     77.38 |      45.06 |

.ipynb_checkpoints/eole-config-checkpoint.yaml

@@ -0,0 +1,95 @@
+## 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: is.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.is-en/en
+        path_tgt: hf://quickmt/quickmt-train.is-en/is
+        path_sco: hf://quickmt/quickmt-train.is-en/sco
+    valid:
+        path_src: valid.en
+        path_tgt: valid.is
+
+transforms: [sentencepiece, filtertoolong]
+transforms_configs:
+  sentencepiece:
+    src_subword_model: "en.spm.model"
+    tgt_subword_model: "is.spm.model"
+  filtertoolong:
+    src_seq_length: 256
+    tgt_seq_length: 256
+
+training:
+    # Run configuration
+    model_path: quickmt-en-is-eole-model
+    keep_checkpoint: 4
+    train_steps: 60000
+    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: [20]
+    accum_steps: [0]
+
+    # Optimizer & Compute
+    compute_dtype: "fp16"
+    optim: "adamw"
+    #use_amp: False
+    learning_rate: 3.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.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"
+

README.md

@@ -1,3 +1,105 @@
----
-license: cc-by-4.0
----
+---
+language:
+- en
+- is
+tags:
+- translation
+license: cc-by-4.0
+datasets:
+- quickmt/quickmt-train.is-en
+model-index:
+- name: quickmt-en-is
+  results:
+  - task:
+      name: Translation eng-isl
+      type: translation
+      args: isl-eng
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: eng_Latn isl_Latn
+    metrics:
+    - name: BLEU
+      type: bleu
+      value: 25.85
+    - name: CHRF
+      type: chrf
+      value: 53.31
+    - name: COMET
+      type: comet
+      value: 80.89
+---
+
+
+# `quickmt-en-is` Neural Machine Translation Model 
+
+`quickmt-en-is` is a reasonably fast and reasonably accurate neural machine translation model for translation from `en` into `is`.
+
+
+## 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) 
+* 200M parameter transformer 'big' with 8 encoder layers and 2 decoder layers
+* 32k separate Sentencepiece vocabs
+* Exported for fast inference to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format
+
+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-is ./quickmt-en-is
+```
+
+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-is/", device="auto")
+
+# Translate - set beam size to 1 for faster speed (but lower quality)
+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)
+```
+
+> 'Ehud Ur, prófessor í læknisfræði við Dalhousie háskólann í Halifax, Nova Scotia og formaður klínískrar og vísindalegrar deildar kanadísku sykursýkisamtakanna varaði við því að rannsóknin væri enn á fyrstu dögum.'
+
+```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)
+```
+
+> 'Ehud Ur, prófessor í lyflækninga við Dalhousie Háskólann í Halifax, Nova Scotia, og formaður klínískrar og vísindalegrar deildar kanadísku sykursýkisamtakanna varaði við því að rannsóknarinnar væri enn á frumdögum.'
+
+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`. A model in safetensors format to be used with `eole` is also provided.
+
+
+## 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"->"isl_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 Nvidia RTX 4070s GPU with batch size 32.
+
+|                                  |   bleu |   chrf2 |   comet22 |   Time (s) |
+|:---------------------------------|-------:|--------:|----------:|-----------:|
+| quickmt/quickmt-en-is            |  25.85 |   53.31 |     80.89 |       1.75 |
+| Helsinki-NLP/opus-mt-en-is       |  18.57 |   46.63 |     76.47 |       3.93 |
+| facebook/nllb-200-distilled-600M |  19.8  |   47.44 |     81.45 |      26.36 |
+| facebook/nllb-200-distilled-1.3B |  23.04 |   50.93 |     84.15 |      46.58 |
+| facebook/m2m100_418M             |  11.93 |   37.46 |     63.74 |      22.54 |
+| facebook/m2m100_1.2B             |  17.52 |   45.25 |     77.38 |      45.06 |

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

eole-model/en.spm.model

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

eole-model/is.spm.model

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

eole-model/model.00.safetensors

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

model.bin

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

src.spm.model

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

tgt.spm.model

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