upload model

README.md

@@ -1,3 +1,82 @@
----
-license: gpl-3.0
----
+---
+license: gpl-3.0
+datasets:
+- wmt/wmt19
+language:
+- en
+- zh
+base_model: Mxode/NanoLM-0.5B-Base
+pipeline_tag: translation
+tags:
+- text-generation-inference
+---
+# NanoTranslator-immersive_translate-0.5B
+
+English | [简体中文](README_zh-CN.md)
+
+## Introduction
+
+NanoTranslator-immersive_translate-0.5B is a model specifically designed for **Chinese-English bilingual** translation, trained on [wmt-19](https://huggingface.co/datasets/wmt/wmt19) and [BiST](https://huggingface.co/datasets/Mxode/BiST), based on [Qwen2-0.5B-Instruct](https://huggingface.co/Qwen/Qwen2-0.5B-Instruct).
+
+This model is trained following the [Immersive Translate](https://immersivetranslate.com/) prompt format and can be deployed as an OpenAI format interface using tools like vllm and lmdeploy for utilization.
+
+## How to use
+
+Below is a method to call the model using transformers. The prompt follows the immersive translation format to ensure optimal results.
+
+```python
+import torch
+from typing import Literal
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model_path = 'Mxode/NanoTranslator-immersive_translate-0.5B'
+
+model = AutoModelForCausalLM.from_pretrained(model_path).to('cuda:0', torch.bfloat16)
+tokenizer = AutoTokenizer.from_pretrained(model_path)
+
+def translate(
+    text: str,
+    to: Literal["chinese", "english"] = "chinese",
+    **kwargs
+):
+    generation_args = dict(
+        max_new_tokens = kwargs.pop("max_new_tokens", 512),
+        do_sample = kwargs.pop("do_sample", True),
+        temperature = kwargs.pop("temperature", 0.55),
+        top_p = kwargs.pop("top_p", 0.8),
+        top_k = kwargs.pop("top_k", 40),
+        **kwargs
+    )
+
+    prompt = """Translate the following source text to {to}. Output translation directly without any additional text.
+    Source Text: {text}
+
+    Translated Text:"""
+
+    messages = [
+        {"role": "system", "content": "You are a professional, authentic machine translation engine."},
+        {"role": "user", "content": prompt.format(to=to, text=text)}
+    ]
+    inputs = tokenizer.apply_chat_template(
+        messages,
+        tokenize=False,
+        add_generation_prompt=True
+    )
+    model_inputs = tokenizer([inputs], return_tensors="pt").to(model.device)
+
+    generated_ids = model.generate(model_inputs.input_ids, **generation_args)
+    generated_ids = [
+        output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+    ]
+
+    response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+    return response
+
+text = "After a long day at work, I love to unwind by cooking a nice dinner and watching my favorite TV series. It really helps me relax and recharge for the next day."
+response = translate(text=text, to='chinese')
+print(f'Translation: {response}')
+
+"""
+Translation: 工作了一天，我喜欢吃一顿美味的晚餐，看我最喜欢的电视剧，这样做有助于我放松，补充能量。
+"""
+```

README_zh-CN.md

@@ -0,0 +1,70 @@
+# NanoTranslator-immersive_translate-365M
+
+[English](README.md) | 简体中文
+
+## Introduction
+
+NanoTranslator-immersive_translate-365M 是由 [NanoLM-365M-Base](https://huggingface.co/Mxode/NanoLM-365M-Base) 在 [wmt-19](https://huggingface.co/datasets/wmt/wmt19) 数据集上训练了 600 万数据得来的专门用于**中英双语**的翻译模型。
+
+此模型遵循[沉浸式翻译](https://immersivetranslate.com/)（Immersive Translate）的 prompt 格式进行训练，可以通过 vllm、lmdeploy 等方式部署为 OpenAI 格式接口，从而完成调用。
+
+## How to use
+
+下面是一个用 transformers 调用的方式，prompt 遵循沉浸式翻译以保持最佳效果。
+
+```python
+import torch
+from typing import Literal
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model_path = 'Mxode/NanoTranslator-immersive_translate-365M'
+
+model = AutoModelForCausalLM.from_pretrained(model_path).to('cuda:0', torch.bfloat16)
+tokenizer = AutoTokenizer.from_pretrained(model_path)
+
+def translate(
+    text: str,
+    to: Literal["chinese", "english"] = "chinese",
+    **kwargs
+):
+    generation_args = dict(
+        max_new_tokens = kwargs.pop("max_new_tokens", 512),
+        do_sample = kwargs.pop("do_sample", True),
+        temperature = kwargs.pop("temperature", 0.35),
+        top_p = kwargs.pop("top_p", 0.8),
+        top_k = kwargs.pop("top_k", 40),
+        **kwargs
+    )
+
+    prompt = """Translate the following source text to {to}. Output translation directly without any additional text.
+    Source Text: {text}
+
+    Translated Text:"""
+
+    messages = [
+        {"role": "system", "content": "You are a professional, authentic machine translation engine."},
+        {"role": "user", "content": prompt.format(to=to, text=text)}
+    ]
+    inputs = tokenizer.apply_chat_template(
+        messages,
+        tokenize=False,
+        add_generation_prompt=True
+    )
+    model_inputs = tokenizer([inputs], return_tensors="pt").to(model.device)
+
+    generated_ids = model.generate(model_inputs.input_ids, **generation_args)
+    generated_ids = [
+        output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+    ]
+
+    response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+    return response
+
+text = "After a long day at work, I love to unwind by cooking a nice dinner and watching my favorite TV series. It really helps me relax and recharge for the next day."
+response = translate(text=text, to='chinese')
+print(f'Translation: {response}')
+
+"""
+Translation: 工作了一天，我喜欢吃一顿美味的晚餐，看我最喜欢的电视剧，这样做有助于我放松，补充能量。
+"""
+```

added_tokens.json

@@ -0,0 +1,5 @@
+{
+  "<|endoftext|>": 151643,
+  "<|im_end|>": 151645,
+  "<|im_start|>": 151644
+}

config.json

@@ -0,0 +1,28 @@
+{
+  "_name_or_path": "Mxode/NanoTranslator-immersive_translate-0.5B",
+  "architectures": [
+    "Qwen2ForCausalLM"
+  ],
+  "attention_dropout": 0.0,
+  "bos_token_id": 151643,
+  "eos_token_id": 151645,
+  "hidden_act": "silu",
+  "hidden_size": 896,
+  "initializer_range": 0.02,
+  "intermediate_size": 4864,
+  "max_position_embeddings": 32768,
+  "max_window_layers": 24,
+  "model_type": "qwen2",
+  "num_attention_heads": 14,
+  "num_hidden_layers": 24,
+  "num_key_value_heads": 2,
+  "rms_norm_eps": 1e-06,
+  "rope_theta": 1000000.0,
+  "sliding_window": 32768,
+  "tie_word_embeddings": true,
+  "torch_dtype": "bfloat16",
+  "transformers_version": "4.42.0",
+  "use_cache": false,
+  "use_sliding_window": false,
+  "vocab_size": 151936
+}

generation_config.json

@@ -0,0 +1,12 @@
+{
+  "bos_token_id": 151643,
+  "do_sample": true,
+  "eos_token_id": 151645,
+  "max_new_tokens": 2048,
+  "pad_token_id": 151643,
+  "repetition_penalty": 1.1,
+  "temperature": 0.7,
+  "top_k": 20,
+  "top_p": 0.8,
+  "transformers_version": "4.42.0"
+}

model.safetensors

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

special_tokens_map.json

@@ -0,0 +1,20 @@
+{
+  "additional_special_tokens": [
+    "<|im_start|>",
+    "<|im_end|>"
+  ],
+  "eos_token": {
+    "content": "<|im_end|>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": {
+    "content": "<|endoftext|>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  }
+}

tokenizer_config.json

@@ -0,0 +1,43 @@
+{
+  "add_prefix_space": false,
+  "added_tokens_decoder": {
+    "151643": {
+      "content": "<|endoftext|>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "151644": {
+      "content": "<|im_start|>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "151645": {
+      "content": "<|im_end|>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "additional_special_tokens": [
+    "<|im_start|>",
+    "<|im_end|>"
+  ],
+  "bos_token": null,
+  "chat_template": "{% for message in messages %}{% if loop.first and messages[0]['role'] != 'system' %}{{ '<|im_start|>system\nYou are a helpful assistant.<|im_end|>\n' }}{% endif %}{{'<|im_start|>' + message['role'] + '\n' + message['content'] + '<|im_end|>' + '\n'}}{% endfor %}{% if add_generation_prompt %}{{ '<|im_start|>assistant\n' }}{% endif %}",
+  "clean_up_tokenization_spaces": false,
+  "eos_token": "<|im_end|>",
+  "errors": "replace",
+  "model_max_length": 32768,
+  "pad_token": "<|endoftext|>",
+  "split_special_tokens": false,
+  "tokenizer_class": "Qwen2Tokenizer",
+  "unk_token": null
+}