Update README.md

README.md

@@ -2,9 +2,33 @@
 license: apache-2.0
 ---
 
-# Model summary
+# Kexer models
 
-This is CodeLlama model fine-tuned on Kotlin Exercices dataset. 
+Kexer models is a collection of fine-tuned open-source generative text models fine-tuned on Kotlin Exercices dataset. 
+This is a repository for fine-tuned CodeLlama-7b model in the Hugging Face Transformers format.
+
+# Model use
+
+```
+  from transformers import AutoModelForCausalLM, AutoTokenizer
+
+  # Load pre-trained model and tokenizer
+  model_name = 'JetBrains/CodeLlama-7B-Kexer'  # Replace with the desired model name
+  tokenizer = AutoTokenizer.from_pretrained(model_name)
+  model = AutoModelForCausalLM.from_pretrained(model_name).cuda()
+
+  # Encode input text
+  input_text = """This function takes an integer n and returns factorial of a number:
+  fun factorial(n: Int): Int {"""
+  input_ids = tokenizer.encode(input_text, return_tensors='pt').to('cuda')
+
+  # Generate text
+  output = model.generate(input_ids, max_length=150, num_return_sequences=1, no_repeat_ngram_size=2, early_stopping=True)
+
+  # Decode and print the generated text
+  generated_text = tokenizer.decode(output[0], skip_special_tokens=True)
+  print(generated_text)
+```
 
 # Training setup
 
@@ -20,7 +44,7 @@ The model was trained on one A100 GPU with following hyperparameters:
 
 # Fine-tuning data
 
-For this model we used 15K exmaples of Kotlin Exercices dataset. For more information about the dataset follow th link.
+For this model we used 15K exmaples of Kotlin Exercices dataset {TODO: link!}. For more information about the dataset follow th link.
 
 # Evaluation 
 
@@ -28,10 +52,7 @@ To evaluate we used Kotlin Humaneval (more infromation here)
 
 Fine-tuned model:
 
-**Kotlin Humaneval: 42.24**  
-**Kotlin Compleation: 0.344**   
-
-Base model:
-
-**Kotlin Humaneval: 26.89**  
-**Kotlin Compleation: 0.388** 
+|         **Model name**           |             **Kotlin HumanEval Pass Rate**              |             **Kotlin Completion**              |
+|:---------------------------:|:----------------------------------------:|:----------------------------------------:|
+|           `base model`            |           26.89            |           0.388            |
+|        `fine-tuned model`        |          42.24         |          0.344          |