Update README.md and add logo

README.md

@@ -4,11 +4,22 @@ license: cc-by-nc-4.0
 co2_eq_emissions: 710
 ---
 
-# QUOKKA
+<img src="logo.png" alt="logo" style="width: 500px" />
+
+#  Table of Contents
+
+1. [Model description](#model-description)
+2. [Intended uses & limitations](#intended-uses--limitations)
+3. [Training data](#training-data)
+4. [Training procedure](#training-procedure)
+5. [Evaluation results](#evaluation-results)
+6. [Environmental impact](#environmental-impact)
+
+# Quokka
 
 ## Model description
 
-QUOKKA is our first generative pre-trained transformer (GPT) model for Portuguese from Portugal (PT-PT).
+Quokka is our first generative pre-trained transformer (GPT) model for Portuguese from Portugal (PT-PT).
 Our model is a fine-tuned version of [Phoenix](https://huggingface.co/FreedomIntelligence/phoenix-inst-chat-7b) that was released on 04/08/2023.
 The backbone of Phoenix is [BLOOMZ](https://huggingface.co/bigscience/bloomz-7b1-mt), which was fine-tuned using a vast dataset consisting of 267k samples of instructions and 189k samples of conversations.
 
@@ -85,7 +96,7 @@ generator(f"<human>{prompt}<bot>", max_new_tokens=512, temperature=0.0)
 
 ## Training data
 
-QUOKKA was fine-tuned on a dataset collected from different sources:
+Quokka was fine-tuned on a dataset collected from different sources:
 
 * Initially, we used the **[Cabrita](https://github.com/22-hours/cabrita)** dataset that consists of a translation of Alpaca's training data.
 The Portuguese translation was generated using ChatGPT. Therefore, it is important to note that these translations may not be of the highest quality.
@@ -119,9 +130,9 @@ Follows the results against GPT-3.5 and two of the highest performing open-sourc
 
 |                        | **Lose** | **Tie** | **Win** |
 |------------------------|----------|---------|---------|
-| QUOKKA vs. **GPT-3.5** | 63.8%    | 10.1%   | 26.1%   |
-| QUOKKA vs. **Vicuna**  | 66.2%    | 8.8%    | 25.0%   |
-| QUOKKA vs. **Falcon**  | 17.4%    | 1.4%    | 81.2%   |
+| Quokka vs. **GPT-3.5** | 63.8%    | 10.1%   | 26.1%   |
+| Quokka vs. **Vicuna**  | 66.2%    | 8.8%    | 25.0%   |
+| Quokka vs. **Falcon**  | 17.4%    | 1.4%    | 81.2%   |
 
 ## Environmental impact