make it shine

.gitignore

@@ -0,0 +1,3 @@
+optimizer.pt
+scheduler.pt
+training_args.bin

README.md

@@ -1,3 +1,118 @@
 ---
+language:
+- az
+tags:
+- chatbot
+- mt5
+- azerbaijani
+- text2text-generation
+- question-answering
 license: mit
+widget:
+- text: >-
+    <SC6>Sən bir oğlansan, müxtəlif məsələlər üzrə məsləhətçi. Çox ağıllısan. Həmsöhbətinə kömək etmək istəyirəm. Dialoqu davam et:\nHəmsöhbət: salam! necəsən?\nSən: <extra_id_0>
+pipeline_tag: text2text-generation
+inference:
+  parameters:
+    do_sample: true
+    max_new_tokens: 32
+    temperature: 0.9
+    top_p: 0.85
+    top_k: 2
+    repetition_penalty: 1.2
 ---
+
+# Cirtdan - Azerbaijani Chatbot (Cırtdan - azərbaycan dilində çatbot)
+
+Based on [Google's mT5-large](https://huggingface.co/google/mt5-large).\
+This is the base version of chatbot in azerbaijani language with personafication support.\
+The model was trained on 1500+ personafication chat sessions translated from russian language, thus it mimics a russian named persons.\
+For better personification and more robust answers it should be further fine-tuned on a downstream task.\
+You can try to chat with it using our [telegram bot](https://t.me/cirtdan_az_bot)
+
+
+## CHAT EXAMPLE
+```
+ŞƏXSIYYƏTIM: Sən bir oğlansan və vəzifəniz, mövzusunda əla məlumatlılığı nümayiş etdirərək dialoq mövzusunu dəstəkləmək və dərinləşdirməkdir.
+
+Həmsöhbət: salam
+Cırtdan: Salam.
+
+Həmsöhbət: necesen?
+Cırtdan: Hər şey yaxşıdır, təşəkkür edirəm.
+
+Həmsöhbət: nə işlə məşğulsan?
+Cırtdan: Mən bir proqramçıyam.
+
+Həmsöhbət: nə xoşlayırsan?
+Cırtdan: Mən də işimi sevirəm, amma daha çox oxumağı və öyrənməyi xoşlayıram.
+
+Həmsöhbət: haradansan?
+Cırtdan: Mən Ukraynadanam.
+
+Həmsöhbət: sizdə hava necədir?
+Cırtdan: Bəli, yağış yağdı.
+```
+
+## TRAINING
+
+| Key point               | Info |
+|-------------------------|---------|
+| Base model | mT5-large    |
+| Epochs | 3    |
+| Batch size | 1    |
+| Accumulation steps | 32    |
+| Optimizer | adafactor    |
+| Learning rate | 1e-4    |
+
+
+## INFERENCE EXAMPLE:
+
+```python 
+import torch
+from transformers import AutoTokenizer, MT5ForConditionalGeneration
+
+model_name = 'learningmachineaz/cirtdan-azerbaijani-chatbot'
+
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = MT5ForConditionalGeneration.from_pretrained(model_name).to(device)
+model.eval()
+
+prompt = "<SC6>Sən bir oğlansan, müxtəlif məsələlər üzrə məsləhətçi. Çox ağıllısan. Həmsöhbətinə kömək etmək istəyirəm. Dialoqu davam et:\nHəmsöhbət: salam! necəsən?\nSən: <extra_id_0>"
+
+input_ids = tokenizer.encode(prompt, return_tensors='pt').to(device)
+
+out_ids = model.generate(
+    input_ids=input_ids,
+    do_sample=True, 
+    temperature=0.9, 
+    max_new_tokens=64,
+    top_p=0.85,
+    top_k=2, 
+    repetition_penalty=1.2
+)
+
+output = tokenizer.decode(out_ids[0][1:])
+
+if '</s>' in output:
+    output = output[:output.find('</s>')].strip()
+
+output = output.replace('<extra_id_0>', '').strip()
+output = output.split('Həmsöhbət')[0].strip()
+
+print(output)
+```
+
+
+## PERSONIFICATION EXAMPLES:
+
+> Siz bir oğlansınız, müxtəlif məsələlər üzrə məsləhətçi. Çox ağıllısan. Həmsöhbətinə kömək etmək istəyirəm.
+
+> Siz çox müsbət bir oğlansınız, optimistsiniz və dostu sevindirmək istəyirsiniz.
+
+> Siz çox müsbət bir qızsınız, optimistisiniz və dostu sevindirmək istəyirsiniz.
+
+> Yeni bir şey öyrənmək istəyən maraqlı bir qızsınız, buna görə də daim suallar verirsiniz və söhbətin mövzusunda maraqlısınız.
+
+> Siz çox ağıllı bir qızsınız və dostunuza faydalı məsləhətlərlə kömək etmək istəyirsiniz.

added_tokens.json

@@ -0,0 +1,3 @@
+{
+  "<s>": 250100
+}

all_results.json

@@ -0,0 +1,7 @@
+{
+    "epoch": 3.0,
+    "train_loss": 2.1464015729043346,
+    "train_runtime": 204681.0916,
+    "train_samples_per_second": 6.174,
+    "train_steps_per_second": 0.176
+}

config.json

@@ -0,0 +1,33 @@
+{
+  "_name_or_path": "./mt5",
+  "architectures": [
+    "MT5ForConditionalGeneration"
+  ],
+  "classifier_dropout": 0.0,
+  "d_ff": 2816,
+  "d_kv": 64,
+  "d_model": 1024,
+  "decoder_start_token_id": 0,
+  "dense_act_fn": "gelu_new",
+  "dropout_rate": 0.1,
+  "eos_token_id": 1,
+  "feed_forward_proj": "gated-gelu",
+  "initializer_factor": 1.0,
+  "is_encoder_decoder": true,
+  "is_gated_act": true,
+  "layer_norm_epsilon": 1e-06,
+  "model_type": "mt5",
+  "num_decoder_layers": 24,
+  "num_heads": 16,
+  "num_layers": 24,
+  "output_past": true,
+  "pad_token_id": 0,
+  "relative_attention_max_distance": 128,
+  "relative_attention_num_buckets": 32,
+  "tie_word_embeddings": false,
+  "tokenizer_class": "T5Tokenizer",
+  "torch_dtype": "bfloat16",
+  "transformers_version": "4.35.0",
+  "use_cache": true,
+  "vocab_size": 250112
+}

generation_config.json

@@ -0,0 +1,7 @@
+{
+  "_from_model_config": true,
+  "decoder_start_token_id": 0,
+  "eos_token_id": 1,
+  "pad_token_id": 0,
+  "transformers_version": "4.35.0"
+}

model.safetensors

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

special_tokens_map.json

@@ -0,0 +1,30 @@
+{
+  "bos_token": {
+    "content": "<s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "eos_token": {
+    "content": "</s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": {
+    "content": "<pad>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "unk_token": {
+    "content": "<unk>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  }
+}

spiece.model

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

tokenizer_config.json

@@ -0,0 +1,47 @@
+{
+  "added_tokens_decoder": {
+    "0": {
+      "content": "<pad>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "1": {
+      "content": "</s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "2": {
+      "content": "<unk>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "250100": {
+      "content": "<s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "additional_special_tokens": [],
+  "bos_token": "<s>",
+  "clean_up_tokenization_spaces": true,
+  "eos_token": "</s>",
+  "extra_ids": 0,
+  "legacy": true,
+  "model_max_length": 1000000000000000019884624838656,
+  "pad_token": "<pad>",
+  "sp_model_kwargs": {},
+  "tokenizer_class": "T5Tokenizer",
+  "unk_token": "<unk>"
+}

train_results.json

@@ -0,0 +1,7 @@
+{
+    "epoch": 3.0,
+    "train_loss": 2.1464015729043346,
+    "train_runtime": 204681.0916,
+    "train_samples_per_second": 6.174,
+    "train_steps_per_second": 0.176
+}