Upload folder using huggingface_hub

.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
-*.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
+Vistral-7B-ChatML-Q3_K_L.gguf filter=lfs diff=lfs merge=lfs -text
+Vistral-7B-ChatML-Q3_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+Vistral-7B-ChatML-Q3_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+Vistral-7B-ChatML-Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+Vistral-7B-ChatML-Q4_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+Vistral-7B-ChatML-Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+Vistral-7B-ChatML-Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+Vistral-7B-ChatML-Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
+Vistral-7B-ChatML-Q8_0.gguf filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1 @@
+.ipynb_checkpoints

README.md

@@ -0,0 +1,70 @@
+---
+language:
+- vi
+library_name: transformers
+tags:
+- LLMs
+- NLP
+- Vietnamese
+license: mit
+---
+
+## Model Description 
+
+This model is finetuned from [Viet-Mistral/Vistral-7B-Chat](https://huggingface.co/Viet-Mistral/Vistral-7B-Chat). The dataset is taken from [bkai-foundation-models/vi-self-chat-sharegpt-format](https://huggingface.co/datasets/bkai-foundation-models/vi-self-chat-sharegpt-format)
+
+This is a **low rank** finetune to add support for chatml template. While the template does not affect model performance, it would be nice to support chatml since most of models based on Mistral already using it.
+
+The format looks like this:
+
+```
+<|im_start|>system 
+Provide some context and/or instructions to the model.
+<|im_end|> 
+<|im_start|>user 
+The user’s message goes here
+<|im_end|> 
+<|im_start|>assistant 
+```
+
+## How to use it
+
+The recommended way is to use the GGUF `vistral-7b-chatml-Q4_K_M.gguf` file included in this repository. Run it via llama.cpp (remember to pass `-cml` argument to use chatml template)
+
+```bash
+./main -m vistral-7b-chatml-Q4_K_M.gguf -p "Bạn là một trợ lí Tiếng Việt nhiệt tình và trung thực." -cml
+```
+
+Additionally, you can run the `python3 run.py` inside this repository to try the model using transformers library. This it not the recommended way since you may need to change some params inside in order to make it work.
+
+This is an example of a conversation using llama.cpp:
+
+- <|im_start|>system
+- Bạn là một trợ lí Tiếng Việt nhiệt tình và trung thực.<|im_end|>
+- <|im_start|>user
+- > xin chào 
+- Tôi là một trợ lý AI được tạo ra để hỗ trợ con người. Bạn có câu hỏi gì về chủ đề nào đó?<|im_end|>
+- > trợ lý AI là gì? bạn giải thích được không?
+- Trợ lý AI là một chương trình máy tính sử dụng trí tuệ nhân tạo và học máy để hỗ trợ con người trong nhiều công việc khác nhau. Nó có thể hiểu và xử lý ngôn ngữ tự nhiên, nhận biết hình ảnh và âm thanh cũng như đưa ra các đề xuất hay câu trả lời phù hợp cho các yêu cầu của bạn.<|im_end|>
+- > ồ, cảm ơn, vậy bạn có thể làm gì?
+- Tôi được thiết kế để giúp đỡ con người trong nhiều công việc như giải đáp các câu hỏi, trả lời những vấn đề liên quan đến cuộc sống hàng ngày của họ. Tôi cũng hỗ trợ nghiên cứu và phân tích dữ liệu để đưa ra dự đoán hay tư vấn cho doanh nghiệp hoặc cá nhân.<|im_end|>
+- > tức là sao?
+- Ví dụ, nếu bạn đang thắc mắc về một chủ đề nào đó và không biết phải bắt đầu tìm kiếm ở đâu hay làm thế nào để hiểu rõ hơn về nó thì tôi có thể giúp bạn. Tôi cũng có khả năng đọc và phân tích dữ liệu từ nhiều nguồn khác nhau như các tài liệu nghiên cứu khoa học hoặc thông tin trên mạng xã hội, sau đó đưa ra những giải thích chi tiết cho vấn đề của bạn.<|im_end|>
+
+## Training
+
+You can also look at the training code in the `finetune.py` file.
+
+For tokenizer, I changed these things:
+- Token `[INST]` to `<|im_start|>`, make it become special token
+- Token `[/INST]` to `<|im_end|>`, make it become special token
+- Change to `eos_token` to `<|im_end|>`
+- Update `chat_template` to chatml, taken from [this example](https://huggingface.co/teknium/OpenHermes-2.5-Mistral-7B/blob/main/tokenizer_config.json#L52)
+
+Additionally, there is a checkpoint file in my repository if you want to merge the LORA yourself.
+
+## More information
+
+Disclaimer: I'm not expert in machine learning, my background is from cybersecurity so the making of this model is a "hobby" to me. Training is done using a VPS on Google Cloud, I paid with my own money.
+
+If you want to discuss, feel free to contact me at `contact at ngxson dot com` - [ngxson.com](https://ngxson.com)

Vistral-7B-ChatML-Q3_K_L.gguf

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

Vistral-7B-ChatML-Q3_K_M.gguf

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

Vistral-7B-ChatML-Q3_K_S.gguf

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

Vistral-7B-ChatML-Q4_K_M.gguf

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

Vistral-7B-ChatML-Q4_K_S.gguf

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

Vistral-7B-ChatML-Q5_K_M.gguf

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

Vistral-7B-ChatML-Q5_K_S.gguf

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

Vistral-7B-ChatML-Q6_K.gguf

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

Vistral-7B-ChatML-Q8_0.gguf

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

finetune.py

@@ -0,0 +1,133 @@
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig, HfArgumentParser, TrainingArguments, pipeline, logging, TextStreamer
+from peft import LoraConfig, PeftModel, prepare_model_for_kbit_training, get_peft_model
+import os, torch, wandb, platform, warnings
+from datasets import load_dataset
+from trl import SFTTrainer
+
+hf_token = ''
+wnb_token = ''
+wnb_name = 'vistral-chatml'
+MODEL = 'Viet-Mistral/Vistral-7B-Chat'
+resume_from_checkpoint = False
+output_dir = 'vistral-chatml'
+tokenizer_path = '.'
+
+#######################################################
+## DATASET
+
+
+from datasets import load_dataset
+
+
+def generate_system_prompt(i):
+    system_prompt = "Bạn là một trợ lí Tiếng Việt nhiệt tình và trung thực. Hãy luôn trả lời một cách hữu ích nhất có thể, đồng thời giữ an toàn."
+    if i % 2 == 0:
+        system_prompt += "\nCâu trả lời của bạn không nên chứa bất kỳ nội dung gây hại, phân biệt chủng tộc, phân biệt giới tính, độc hại, nguy hiểm hoặc bất hợp pháp nào. Hãy đảm bảo rằng các câu trả lời của bạn không có thiên kiến xã hội và mang tính tích cực."
+    if i % 5 == 0:
+        system_prompt += "\nNếu một câu hỏi không có ý nghĩa hoặc không hợp lý về mặt thông tin, hãy giải thích tại sao thay vì trả lời một điều gì đó không chính xác. Nếu bạn không biết câu trả lời cho một câu hỏi, hãy trẳ lời là bạn không biết và vui lòng không chia sẻ thông tin sai lệch."
+    return system_prompt
+
+tokenizer = AutoTokenizer.from_pretrained(tokenizer_path)
+
+def tokenize_chat(input, i):
+    print(generate_system_prompt(i))
+    conversation = [{'role': 'system', 'content': generate_system_prompt(i)}]
+    for msg in input['conversations']:
+        output = {'role': 'user', 'content': msg['value']}
+        if msg['from'] == 'gpt':
+            output['role'] = 'assistant'
+        conversation.append(output)
+    formatted = tokenizer.apply_chat_template(conversation, tokenize=False)
+    return tokenizer(formatted)
+
+sharegpt_dataset = load_dataset('bkai-foundation-models/vi-self-chat-sharegpt-format')
+train_data = sharegpt_dataset['train'].shuffle(seed=42)\
+    .select(range(800))\
+    .map(lambda x, i: tokenize_chat(x, i), remove_columns=["conversations"], with_indices=True)
+
+
+#######################################################
+## SETUP
+
+wandb.login(key=wnb_token)
+wandb.init(name=wnb_name)
+# use custom tokenizer instead of one comes from the model
+#tokenizer = AutoTokenizer.from_pretrained(
+#  MODEL,
+#  add_eos_token=False,
+#  add_bos_token=False,
+#  token=hf_token,
+#)
+bnb_config = BitsAndBytesConfig(
+  load_in_4bit=True,
+  bnb_4bit_quant_type="nf4",
+  bnb_4bit_compute_dtype=torch.bfloat16,
+  bnb_4bit_use_double_quant=True,
+)
+model = AutoModelForCausalLM.from_pretrained(
+  MODEL,
+  device_map="auto",
+  token=hf_token,
+  quantization_config=bnb_config,
+  trust_remote_code=True,
+)
+
+
+#######################################################
+## LORA CONFIG
+
+model.gradient_checkpointing_enable()
+model = prepare_model_for_kbit_training(model)
+peft_config = LoraConfig(
+    r=8,
+    lora_alpha=16,
+    target_modules=[
+        "q_proj",
+        "k_proj",
+        "v_proj",
+        "o_proj",
+        "gate_proj",
+        "up_proj",
+        "down_proj",
+        "lm_head",
+    ],
+    bias="none",
+    lora_dropout=0.05,  # Conventional
+    task_type="CAUSAL_LM",
+)
+model = get_peft_model(model, peft_config)
+model.print_trainable_parameters()
+
+from accelerate import Accelerator
+accelerator = Accelerator()
+model = accelerator.prepare_model(model)
+
+
+#######################################################
+## TRAIN
+
+from transformers import Trainer, TrainingArguments, DataCollatorForLanguageModeling
+trainer = Trainer(
+    model=model,
+    train_dataset=train_data,
+    args=TrainingArguments(
+        report_to='wandb',
+        warmup_steps=1,
+        per_device_train_batch_size=1,
+        gradient_accumulation_steps=4,
+        gradient_checkpointing=True,
+        num_train_epochs=4,
+        learning_rate=2.5e-5,
+        logging_steps=1,
+        optim="paged_adamw_8bit",
+        save_strategy="steps",
+        save_steps=10,
+        save_total_limit=4,
+        output_dir=output_dir
+    ),
+    data_collator=DataCollatorForLanguageModeling(tokenizer, mlm=False)
+)
+model.config.use_cache = False
+
+trainer.train(resume_from_checkpoint=resume_from_checkpoint)

run.py

@@ -0,0 +1,64 @@
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig, HfArgumentParser, TrainingArguments, pipeline, logging, TextStreamer
+from peft import LoraConfig, PeftModel, prepare_model_for_kbit_training, get_peft_model
+import os, torch, wandb, platform, warnings
+from datasets import load_dataset
+from trl import SFTTrainer
+
+hf_token = '..........'
+
+tokenizer = AutoTokenizer.from_pretrained('./vistral-tokenizer')
+bnb_config = BitsAndBytesConfig(
+  load_in_4bit=True,
+  bnb_4bit_quant_type="nf4",
+  bnb_4bit_compute_dtype=torch.bfloat16,
+  bnb_4bit_use_double_quant=True,
+)
+model = AutoModelForCausalLM.from_pretrained(
+  'Viet-Mistral/Vistral-7B-Chat',
+  device_map="auto",
+  token=hf_token,
+  quantization_config=bnb_config,
+)
+ft_model = PeftModel.from_pretrained(model, CHECKPOINT_PATH)
+
+#torch.backends.cuda.enable_mem_efficient_sdp(False)
+#torch.backends.cuda.enable_flash_sdp(False)
+
+system_prompt = "Bạn là một trợ lí Tiếng Việt nhiệt tình và trung thực. Hãy luôn trả lời một cách hữu ích nhất có thể, đồng thời giữ an toàn."
+
+stop_tokens = [tokenizer.eos_token_id, tokenizer('<|im_end|>')['input_ids'].pop()]
+
+def chat_test():
+  conversation = [{"role": "system", "content": system_prompt }]
+  while True:
+    human = input("Human: ")
+    if human.lower() == "reset":
+      conversation = [{"role": "system", "content": system_prompt }]
+      print("The chat history has been cleared!")
+      continue
+
+    if human.lower() == "exit":
+      break
+
+    conversation.append({"role": "user", "content": human })
+    formatted = tokenizer.apply_chat_template(conversation, tokenize=False) + "<|im_start|>assistant"
+    tok = tokenizer(formatted, return_tensors="pt").to(ft_model.device)
+    input_ids = tok['input_ids']
+
+    out_ids = ft_model.generate(
+      input_ids=input_ids,
+      attention_mask=tok['attention_mask'],
+      eos_token_id=stop_tokens,
+      max_new_tokens=50,
+      do_sample=True,
+      top_p=0.95,
+      top_k=40,
+      temperature=0.1,
+      repetition_penalty=1.05,
+    )
+    assistant = tokenizer.batch_decode(out_ids[:, input_ids.size(1): ], skip_special_tokens=True)[0].strip()
+    print("Assistant: ", assistant)
+    conversation.append({"role": "assistant", "content": assistant })
+
+chat_test()