Additional syntax proofreading

README.md

@@ -8,14 +8,16 @@ language:
 - su
 license: llama3
 ---
-# Llama3 8B CPT Sahabat-AI v1 Instruct
+# Llama3 8B CPT Sahabat AI v1 Instruct
 
-**Sahabat-AI** (Indonesian language for “close friends”) is a collection of Large Language Models (LLMs) which has been pretrained and instruct-tuned for Indonesian language and its various dialects. Sahabat-AI ecosystem is co-initiated by Indonesian tech and telecommunication companies:  GoTo Group and Indosat Ooredoo Hutchison.
+Sahabat AI  is a collection of Large Language Models (LLMs) which has been pretrained and instruct-tuned for Indonesian languages.
 
-Llama3 8B CPT Sahabat-AI v1 Instruct is an Indonesian-focused model which has been fine-tuned with around **448,000 Indonesian instruction-completion pairs** alongside an Indonesian-dialect pool consisting of **96,000 instruction-completion pairs in Javanese** and **98,000 instruction-completion pairs in Sundanese**. Additionally, we added a pool of **129,000 instruction-completion pairs in English**.
+Llama3 8B CPT Sahabat AI v1 Instruct is an Indonesian-focused model which has been fine-tuned with around **448,000 Indonesian instruction-completion pairs** alongside an Indonesian-dialect pool consisting of **96,000 instruction-completion pairs in Javanese** and **98,000 instruction-completion pairs in Sundanese**. Additionally, we also included **129,000 instruction-completion pairs in English**.
+
+Sahabat is Indonesian for "Close Friends."
 
-- **Co-initiated by:**  PT GoTo Gojek Tokopedia Tbk, Indosat Ooredoo Hutchison
 - **Developed by:** PT GoTo Gojek Tokopedia Tbk,  AI Singapore
+- **Funded by:** PT GoTo Gojek Tokopedia Tbk, AI Singapore  
 - **Model type:** Decoder
 - **Languages:** English, Indonesian, Javanese, Sundanese
 - **License:** [Llama3 Community License](https://huggingface.co/meta-llama/Meta-Llama-3-8B/blob/main/LICENSE)
@@ -23,12 +25,12 @@ Llama3 8B CPT Sahabat-AI v1 Instruct is an Indonesian-focused model which has be
 ## Model Details
 
 ### Model Description
-We performed instruction tuning in Indonesian, Javanese, Sundanese as well as English on our [continued pre-trained Llama3 8B CPT Sahabat-AI v1 base](https://huggingface.co/GoToCompany/llama3-8b-cpt-sahabatai-v1-base), a decoder model using the Llama3 architecture, to create Llama3 8B CPT Sahabat-AI v1 Instruct.
+We performed instruction tuning in Indonesian, Javanese, Sundanese as well as English on our [continued pre-trained Llama3 8B CPT Sahabat AI v1 base](https://huggingface.co/GoToCompany/llama3-8b-cpt-sahabatai-v1-base), a decoder model using the Llama3 architecture, to create Llama3 8B CPT Sahabat AI v1 Instruct.
 
 For tokenisation, the model employs the default tokenizer used in Llama-3-8B. The model has a context length of 8192.
 
 ### Benchmark Performance
-We evaluated Llama3 8B CPT Sahabat-AI V1 Instruct on both general language capabilities and instruction-following capabilities.
+We evaluated Llama3 8B CPT Sahabat AI v1 Instruct on general language capabilities.
 
 #### General Language Capabilities
 For the evaluation of general language capabilities, we employed the 
@@ -37,150 +39,22 @@ For the evaluation of general language capabilities, we employed the
   - We also added support for Javanese and Sundanese for the BHASA tasks whenever applicable
 - [IndoMMLU](https://arxiv.org/pdf/2310.04928)
   - These tasks include examination questions on Humanities, Indonesian language, Local languages and cultures, Social science and STEM across primary, middle, and high school levels.
-- and the common English tasks from the [HuggingFace LLM Leaderboard](https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard).
-  - These tasks consist of [IFEval, BBH, Math Lvl 5, GPQA, MuSR, and MMLU-PRO.](https://huggingface.co/docs/leaderboards/open_llm_leaderboard/about)
-  - **Caveat**: Our results differ from the HuggingFace LLM Leaderboard because we have used [VLLM](https://docs.vllm.ai/en/latest/) as our inference platform. VLLM caps the context size at **4096 tokens** while HuggingFace was set to **8192 tokens**.
+- and the well known [English MMLU](https://arxiv.org/pdf/2009.03300)
 
 Note: SEA HELM is implemented using prompts to elicit answers in a strict format. For all tasks, the model is expected to provide an answer tag from which the answer is automatically extracted. For tasks where options are provided, the answer should comprise one of the pre-defined options. The scores for each task is normalised to account for baseline performance due to random chance.
 
 The evaluation was done **zero-shot** with native prompts on a sample of 100-1000 instances for each dataset.
 
 
-#### Instruction-following Capabilities
-Since Llama3 8B CPT Sahabat-AI v1 Instruct is an instruction-following model, we also evaluated it on instruction-following capabilities with the [IFEval](https://arxiv.org/abs/2311.07911) dataset.
-
-  As this dataset was in English, the linguists and native speakers in the team worked together to filter, localize and translate the dataset into the respective target languages to ensure that the examples remained reasonable, meaningful and natural.
-
-**IFEval**
-
-IFEval evaluates a model's ability to adhere to constraints provided in the prompt, for example beginning a response with a specific word/phrase or answering with a certain number of sections. Additionally, accuracy is normalized by the proportion of responses in the correct language (if the model performs the task correctly but responds in the wrong language, it is judged to have failed the task).
-
-*Note*: IFEval was only used on Bahasa Indonesia. We are currently working on adding it for Javanese and Sundanese for our upcoming releases.
-
-#### Results
-
-#### Indonesian Results
-
-#### SEA HELM (also known as BHASA)
-<table style="border-collapse: collapse; width: 100%; font-size: 10px">
-  <tr>
-    <th style="border: 2px solid black; padding: 8px; font-weight: bold;">Language / Model Name [Instruct]</th>
-    <th style="border: 1px solid gray; padding: 8px;">Qwen2-7B</th>
-    <th style="border: 1px solid gray; padding: 8px;">Qwen2.5-7B</th>
-    <th style="border: 1px solid gray; padding: 8px;">Llama-3-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">Llama-3.1-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">sea-lionv2.1-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">gemma-2-9B</th>
-    <th style="border: 2px solid black; padding: 8px;">sahabatai-v1-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">sahabatai-v1-9B</th>
-  </tr>
-  <tr>
-    <td style="border: 2px solid black; padding: 8px; font-weight: bold;">Overall (Bahasa Indonesia + Javanese + Sundanese)</td>
-    <td style="border: 1px solid gray; padding: 8px;">36.963</td>
-    <td style="border: 1px solid gray; padding: 8px;">42.988</td>
-    <td style="border: 1px solid gray; padding: 8px;">37.805</td>
-    <td style="border: 1px solid gray; padding: 8px;">45.866</td>
-    <td style="border: 1px solid gray; padding: 8px;">46.880</td>
-    <td style="border: 1px solid gray; padding: 8px;">56.359</td>
-    <td style="border: 2px solid black; padding: 8px;">53.725</td>
-    <td style="border: 1px solid gray; padding: 8px; background-color: lightgreen;">61.169</td>
-  </tr>
-  <tr>
-    <td style="border: 2px solid black; padding: 8px; font-weight: bold;">Bahasa Indonesia</td>
-    <td style="border: 1px solid gray; padding: 8px;">46.760</td>
-    <td style="border: 1px solid gray; padding: 8px;">60.372</td>
-    <td style="border: 1px solid gray; padding: 8px;">42.022</td>
-    <td style="border: 1px solid gray; padding: 8px;">51.944</td>
-    <td style="border: 1px solid gray; padding: 8px;">54.579</td>
-    <td style="border: 1px solid gray; padding: 8px;">63.394</td>
-    <td style="border: 2px solid black; padding: 8px;">57.221</td>
-    <td style="border: 1px solid gray; padding: 8px; background-color: lightgreen;">64.154</td>
-  </tr>
-  <tr>
-    <td style="border: 2px solid black; padding: 8px; font-weight: bold;">Javanese</td>
-    <td style="border: 1px solid gray; padding: 8px;">33.956</td>
-    <td style="border: 1px solid gray; padding: 8px;">40.625</td>
-    <td style="border: 1px solid gray; padding: 8px;">41.739</td>
-    <td style="border: 1px solid gray; padding: 8px;">47.587</td>
-    <td style="border: 1px solid gray; padding: 8px;">48.012</td>
-    <td style="border: 1px solid gray; padding: 8px;">56.468</td>
-    <td style="border: 2px solid black; padding: 8px;">56.460</td>
-    <td style="border: 1px solid gray; padding: 8px; background-color: lightgreen;">64.439</td>
-  </tr>
-  <tr>
-    <td style="border: 2px solid black; padding: 8px; font-weight: bold;">Sundanese</td>
-    <td style="border: 1px solid gray; padding: 8px;">30.173</td>
-    <td style="border: 1px solid gray; padding: 8px;">27.969</td>
-    <td style="border: 1px solid gray; padding: 8px;">29.654</td>
-    <td style="border: 1px solid gray; padding: 8px;">38.068</td>
-    <td style="border: 1px solid gray; padding: 8px;">38.050</td>
-    <td style="border: 1px solid gray; padding: 8px;">49.216</td>
-    <td style="border: 2px solid black; padding: 8px;">47.495</td>
-    <td style="border: 1px solid gray; padding: 8px; background-color: lightgreen;">54.913</td>
-  </tr>
-</table>
-
-#### IndoMMLU
-<table style="border-collapse: collapse; width: 100%; font-size: 10px">
-  <tr>
-    <th style="border: 2px solid black; padding: 8px; font-weight: bold;">Model Name [Instruct]</th>
-    <th style="border: 1px solid gray; padding: 8px;">Qwen2-7B</th>
-    <th style="border: 1px solid gray; padding: 8px;">Qwen2.5-7B</th>
-    <th style="border: 1px solid gray; padding: 8px;">Meta-Llama-3-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">Llama-3.1-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">sea-lionv2.1-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">gemma-2-9B</th>
-    <th style="border: 2px solid black; padding: 8px;">sahabatai-v1-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">sahabatai-v1-9B</th>
-  </tr>
-  <tr>
-    <td style="border: 2px solid black; padding: 8px; font-weight: bold;">Overall Results</td>
-    <td style="border: 1px solid gray; padding: 8px;">53.0%</td>
-    <td style="border: 1px solid gray; padding: 8px;">56.0%</td>
-    <td style="border: 1px solid gray; padding: 8px;">51.9%</td>
-    <td style="border: 1px solid gray; padding: 8px;">53.8%</td>
-    <td style="border: 1px solid gray; padding: 8px;">54.4%</td>
-    <td style="border: 1px solid gray; padding: 8px;">61.4%</td>
-    <td style="border: 2px solid black; padding: 8px;">55.6%</td>
-    <td style="border: 1px solid gray; padding: 8px; background-color: lightgreen;">62.6%</td>
-  </tr>
-</table>
-
-#### English Results
-<table style="border-collapse: collapse; width: 100%; font-size: 10px">
-  <tr>
-    <th style="border: 2px solid black; padding: 8px;">Model Name [Instruct]</th>
-    <th style="border: 1px solid gray; padding: 8px;">Qwen2-7B</th>
-    <th style="border: 1px solid gray; padding: 8px;">Qwen2.5-7B</th>
-    <th style="border: 1px solid gray; padding: 8px;">Llama-3-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">Llama-3.1-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">sea-lionv2.1-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">gemma-2-9B</th>
-    <th style="border: 2px solid black; padding: 8px;">sahabatai-v1-8B</th>
-    <th style="border: 1px solid gray; padding: 8px;">sahabatai-v1-9B</th>
-  </tr>
-  <tr>
-    <td style="border: 2px solid black; padding: 8px; font-weight: bold;">Average</td>
-    <td style="border: 1px solid gray; padding: 8px;">24.48</td>
-    <td style="border: 1px solid gray; padding: 8px;">27.75</td>
-    <td style="border: 1px solid gray; padding: 8px;">23.91</td>
-    <td style="border: 1px solid gray; padding: 8px;">27.98</td>
-    <td style="border: 1px solid gray; padding: 8px;">24.52</td>
-    <td style="border: 1px solid gray; padding: 8px;">26.44</td>
-    <td style="border: 2px solid black; padding: 8px;">24.43</td>
-    <td style="border: 1px solid gray; padding: 8px; background-color: lightgreen;">33.67</td>
-  </tr>
-</table>
-
-
-Llama3 8B CPT Sahabat-AI v1 Instruct can be run using the 🤗 Transformers library 
+### Usage
+Llama3 8B CPT Sahabat AI v1 Instruct can be run using the 🤗 Transformers library 
 ```python
-# Please use transformers==4.45.0
+# Please use transformers==4.45.2
 
-import torch
 import transformers
+import torch
 
-model_id = "GoToCompany/llama3-8b-cpt-sahabatai-v1-instruct"
+model_id =  # PLACEHOLDER 
 
 pipeline = transformers.pipeline(
     "text-generation",
@@ -188,36 +62,13 @@ pipeline = transformers.pipeline(
     model_kwargs={"torch_dtype": torch.bfloat16},
     device_map="auto",
 )
-
-terminators = [
-    pipeline.tokenizer.eos_token_id,
-    pipeline.tokenizer.convert_tokens_to_ids("<|eot_id|>")
-]
-
-# Javanese
 messages = [
-   {"role": "system", "content": "You are a helpful assistant"},
-   {"role": "user", "content": "Sopo wae sing ana ing Punakawan?"}
+    {"role": "user", "content": "Apa sentimen dari kalimat berikut ini?\nKalimat: Buku ini sangat membosankan.\nJawaban: "},
 ]
 
 outputs = pipeline(
     messages,
     max_new_tokens=256,
-    eos_token_id=terminators,
-)
-print(outputs[0]["generated_text"][-1])
-
-
-# Sundanese
-messages = [
-    {"role": "system", "content": "You are a helpful assistant"},
-    {"role": "user", "content": "Kumaha caritana si Kabayan?"},
-]
-
-outputs = pipeline(
-    messages,
-    max_new_tokens=256,
-    eos_token_id=terminators,
 )
 print(outputs[0]["generated_text"][-1])
 ```
@@ -228,38 +79,23 @@ It is important for users to be aware that our model exhibits certain limitation
 ## Limitations
 ### Safety
 
-Current Sahabat-AI models, including this commercially permissive release, have not been aligned for safety. Developers and users should perform their own safety fine-tuning and related security measures. In no event shall the authors be held liable for any claim, damages, or other liability arising from the use of the released weights and codes.
+Current Sahabat models, including this commercially permissive release, have not been aligned for safety. Developers and users should perform their own safety fine-tuning and related security measures. In no event shall the authors be held liable for any claim, damages, or other liability arising from the use of the released weights and codes.
 
 ## Technical Specifications
 ### Fine-Tuning Details
-Llama3 8B CPT Sahabat-AI v1 Instruct was built using a combination of a full parameter fine-tune, on-policy alignment, and model merges of the best performing checkpoints. The training process for fine-tuning was approximately 4 hours, with alignment taking 2 hours, both on 8x H100-80GB GPUs.
+Llama3 8B CPT Sahabat AI v1 Instruct was built using a combination of a full parameter fine-tune, on-policy alignment, and model merges of the best performing checkpoints. The training process for fine-tuning was approximately 4 hours, with alignment taking 2 hours, both on 8x H100-80GB GPUs.
 
 ## Data
-Llama3 8B CPT Sahabat-AI v1 Instruct was trained on a wide range of synthetic instructions, alongside publicly available instructions hand-curated by the team with the assistance of native speakers. In addition, special care was taken to ensure that the datasets used had commercially permissive licenses through verification with the original data source. 
-
-## Call for Collaboration 
-Sahabat-AI (Indonesian language for “close friends”) a **local open source Large Language Model (LLM) ecosystem in Indonesian language**, co-initiated by Indonesian tech and telecommunication companies:  GoTo Group and Indosat Ooredoo Hutchison. 
-Sahabat-AI ecosystem aims to empower Indonesians who want to develop AI-based services and applications using Bahasa Indonesia and its various local dialects. 
-
-We are supported by research centers and global tech experts such as AI Singapore and Tech Mahendra to train the model to gain general language understanding.
+Llama3 8B CPT Sahabat AI v1 Instruct was trained on a wide range of synthetic instructions, alongside publicly available instructions hand-curated by the team with the assistance of native speakers. In addition, special care was taken to ensure that the datasets used had commercially permissive licenses through verification with the original data source. 
 
-We also collaborate with key top Indonesia universities such as University of Indonesia, Gadjah Mada University, Bogor Institute of Agriculture, Bandung Institute of Technology, including top Indonesia media groups, such as Kompas Gramedia Group and Republika to train and enrich the model in Bahasa Indonesia, ensuring optimum provision of local context and cultural relevance.
+## Call for Contributions
+We encourage researchers, developers, and language enthusiasts to actively contribute to the enhancement and expansion of Sahabat. Contributions can involve identifying and reporting bugs, sharing pre-training, instruction, and preference data, improving documentation usability, proposing and implementing new model evaluation tasks and metrics, or training versions of the model in additional Indonesian languages. Join us in shaping the future of Sahabat by sharing your expertise and insights to make these models more accessible, accurate, and versatile.
 
-We would like to invite **researchers, developers, and language enthusiasts** to actively contribute to the enhancement and expansion of Sahabat-AI. 
-Your collaborations can involve:
-- Identifying and reporting technical issues
-- Sharing pre-training, instruction, and preference data
-- Improving documentation usability
-- Proposing and implementing new model evaluation tasks and metrics 
-
-Join us in shaping the future of Sahabat-AI by sharing your expertise and insights to make these models more accessible, accurate, and versatile.
-
-You can contribute your ideas through [this form.](https://docs.google.com/forms/d/1_us969eQtEooYOn4XkvGkdP5VHOyCbO6L_sd9kTMnaA/edit)
-
-## The Development Team (in ascending alphabetical order)
+## The Team (by ascending alphabetical order)
 
 ### AI Singapore
 Chan Adwin<br>
+Chau Shiau Ching<br>
 Cheng Nicholas<br>
 Choa Esther<br>
 Huang Yuli<br>
@@ -290,7 +126,6 @@ Yong Xianbin<br>
 
 ### PT GoTo Gojek Tokopedia Tbk
 Anissa Dininta<br>
-Chau Shiau Ching<br>
 Choiri Hendra Hadhil<br>
 Goel Priyank<br>
 Saini Ajay Kumar<br>
@@ -300,16 +135,16 @@ Tep Kilian Rithi<br>
 Tiwari Anupam<br>
 Widjojo Daniel<br>
 
-## Acknowledgements
+<!--## Acknowledgements
 
  [AI Singapore](​​https://aisingapore.org/) is a national programme supported by the National Research Foundation, Singapore and hosted by the National University of Singapore. 
 
-Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not reflect the views of the National Research Foundation or the National University of Singapore.
+Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not reflect the views of the National Research Foundation or the National University of Singapore.  -->
 
 
 ## Contact
 
-For more info, please contact us using this [Sahabat-AI Inquiry Form.](https://docs.google.com/forms/d/1_us969eQtEooYOn4XkvGkdP5VHOyCbO6L_sd9kTMnaA/edit)
+For more info, please contact us using this [Sahabat Inquiry Form.](https://docs.google.com/forms/d/1_us969eQtEooYOn4XkvGkdP5VHOyCbO6L_sd9kTMnaA/edit)
 
 ## Disclaimer