Initial Commit

.gitattributes

@@ -1,35 +1,9 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin.* filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
 *.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
 *.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
 *.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text
+*.tar.gz filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.spm filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,112 @@
+
+---
+tags:
+- ctranslate2
+- translation
+license: apache-2.0
+---
+# Repository General Information
+## Inspired by and derived from the work of [Helsinki-NLP](https://huggingface.co/Helsinki-NLP), [CTranslate2](https://github.com/OpenNMT/CTranslate2), and [michaelfeil](https://huggingface.co/michaelfeil)!
+- Link to Original Model ([Helsinki-NLP](https://huggingface.co/Helsinki-NLP)): [Model Link](https://huggingface.co/Helsinki-NLP/opus-mt-en-xh)
+- This respository was based on the work of [CTranslate2](https://github.com/OpenNMT/CTranslate2).
+- This repository was based on the work of [michaelfeil](https://huggingface.co/michaelfeil).
+
+# What is CTranslate2?
+[CTranslate2](https://opennmt.net/CTranslate2/) is a C++ and Python library for efficient inference with Transformer models.
+
+CTranslate2 implements a custom runtime that applies many performance optimization techniques such as weights quantization, layers fusion, batch reordering, etc., to accelerate and reduce the memory usage of Transformer models on CPU and GPU.
+
+CTranslate2 is SOTA and is one of the most performant ways of hosting translation models at scale. Current supported models include:
+- Encoder-decoder models: Transformer base/big, M2M-100, NLLB, BART, mBART, Pegasus, T5, Whisper
+- Decoder-only models: GPT-2, GPT-J, GPT-NeoX, OPT, BLOOM, MPT, Llama, Mistral, Gemma, CodeGen, GPTBigCode, Falcon
+- Encoder-only models: BERT, DistilBERT, XLM-RoBERTa
+
+Speed up inference times by about **2x-8x** using **int8** inference in C++. CTranslate2 is SOTA for hosting translation models at scale.
+# CTranslate2 Benchmarks
+Please note that the results presented below are only valid for the configuration used during this benchmark: absolute and relative performance may change with different settings. Tested against `newstest2014` (En -> De) dataset.
+
+The benchmark reports the number of target tokens generated per second (higher is better). The results are aggregated over multiple runs. See the benchmark scripts for more details and reproduce these numbers.
+
+Please note that the results presented below are only valid for the configuration used during this benchmark: absolute and relative performance may change with different settings.
+
+## CPU Benchmarks for Generic Opus-MT Models
+| Library | Tokens per Second | Max Memory Usage | BLEU |
+| :----: | :----: | :----: | :----: |
+| Transformers 4.26.1 (with PyTorch 1.13.1) | 147.3 | 2332MB | 27.90 |
+| Marian 1.11.0 (int16) | 330.2 | 5901MB | 27.65 |
+| Marian 1.11.0 (int8) | 355.8 | 4763MB | 27.27 |
+| CTranslate2 3.6.0 (int16) | 596.1 | 660MB | 27.53 |
+| CTranslate2 3.6.0 (int8) | 696.1 | 516MB | 27.65 |
+
+## GPU Benchmarks for Generic Opus-MT Models
+| Library | Tokens per Second | Max GPU Memory Usage  | Max Memory Usage | BLEU |
+| :----: | :----: | :----: | :----: | :----: |
+| Transformers 4.26.1 (with PyTorch 1.13.1) | 1022.9 | 4097MB | 2109MB | 27.90 |
+| Marian 1.11.0 (float16) | 3962.4 | 3239MB | 1976MB | 27.94 |
+| CTranslate2 3.6.0 (float16) | 9296.7 | 909MB | 814MB | 27.9 |
+| CTranslate2 3.6.0 (int8 + float16) | 8362.7 | 813MB | 766MB | 27.9 |
+
+`Executed with 4 threads on a c5.2xlarge Amazon EC2 instance equipped with an Intel(R) Xeon(R) Platinum 8275CL CPU.`
+
+**Source to benchmark information can be found [here](https://github.com/OpenNMT/CTranslate2).**<br />
+**Original model BLEU scores can be found [here](https://huggingface.co/Helsinki-NLP/opus-mt-en-xh).**
+
+# CTranslate2 Installation
+```bash
+pip install hf-hub-ctranslate2>=1.0.0 ctranslate2>=3.13.0
+```
+### ct2-transformers-converter Command Used:
+```
+ct2-transformers-converter --model Helsinki-NLP/opus-mt-en-xh --output_dir ./ctranslate2/opus-mt-en-xh-ctranslate2 --force --copy_files README.md generation_config.json tokenizer_config.json vocab.json source.spm .gitattributes target.spm --quantization float16
+```
+# CTranslate2 Converted Checkpoint Information:
+**Compatible With:**
+- [ctranslate2](https://github.com/OpenNMT/CTranslate2)
+- [hf-hub-ctranslate2](https://github.com/michaelfeil/hf-hub-ctranslate2)
+
+**Compute Type:**
+- `compute_type=int8_float16` for `device="cuda"` 
+- `compute_type=int8`  for `device="cpu"`
+
+# Sample Code - ctranslate2
+```python
+from ctranslate2 import Translator
+import transformers
+
+model_name = "gaudi/opus-mt-en-xh-ctranslate2"
+translator = Translator(
+            model_path=model_name,
+            device="cuda",
+            inter_threads=1,
+            intra_threads=4,
+            compute_type="int8_float16",
+)
+
+tokenizer = transformers.AutoTokenizer.from_pretrained(model_name)
+
+source = tokenizer.convert_ids_to_tokens(tokenizer.encode("XXXXXX, XXX XX XXXXXX."))
+results = translator.translate_batch([source])
+target = results[0].hypotheses[0]
+
+print(tokenizer.decode(tokenizer.convert_tokens_to_ids(target)))
+```
+# Sample Code - hf-hub-ctranslate2
+**Derived From [michaelfeil](https://huggingface.co/michaelfeil):**
+```python
+from hf_hub_ctranslate2 import TranslatorCT2fromHfHub, GeneratorCT2fromHfHub
+from transformers import AutoTokenizer
+
+model_name = "gaudi/opus-mt-en-xh-ctranslate2"
+model = TranslatorCT2fromHfHub(
+        model_name_or_path=model_name, 
+        device="cuda",
+        compute_type="int8_float16" # load in int8 on CUDA,
+        tokenizer=AutoTokenizer.from_pretrained(model_name)
+)
+outputs = model.generate(
+    text=["XXX XX XXX XXXXXXX XXXX?", "XX XX XXXX XX XXX!"],
+)
+print(outputs)
+```
+# License and other remarks:
+License conditions are intended to be idential to [original huggingface repository](https://huggingface.co/Helsinki-NLP/opus-mt-en-xh) by Helsinki-NLP.

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": null,
+  "unk_token": "<unk>",
+  "model_type": "marian"
+}

generation_config.json

@@ -0,0 +1,16 @@
+{
+  "bad_words_ids": [
+    [
+      61284
+    ]
+  ],
+  "bos_token_id": 0,
+  "decoder_start_token_id": 61284,
+  "eos_token_id": 0,
+  "forced_eos_token_id": 0,
+  "max_length": 512,
+  "num_beams": 4,
+  "pad_token_id": 61284,
+  "renormalize_logits": true,
+  "transformers_version": "4.32.0.dev0"
+}

model.bin

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

source.spm

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

target.spm

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

tokenizer_config.json

@@ -0,0 +1 @@
+{"target_lang": "xh", "source_lang": "en"}