afrizalha
/

Kancil-V0-llama3

@@ -4,199 +4,122 @@ tags:
 - unsloth
 - trl
 - sft
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
 ### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 - unsloth
 - trl
 - sft
+- llama3
+- llama
+- indonesia
+license: llama3
+datasets:
+- catinthebag/TumpengQA
+language:
+- id
 ---
+<center>
+    <img src="https://imgur.com/9nG5J1T.png" alt="Kancil" width="600" height="300">
+    <p><em>Kancil is a fine-tuned version of Llama 3 8B using synthetic QA dataset generated with Llama 3 70B.</em></p>
+</center>
+### Introducing the Kancil family of open models
+Selamat datang!
+If you're like me, you love models that are:
+🤏 Small, but capable!
+🔓 Open, free-to-use
+🇮🇩 Fluent in Indonesian
+That's why I'm proud to announce... the 🦌 Kancil! It's a fine-tuned version of Llama 3 8B with the TumpengQA, an instruction dataset of 28 million words. Both the model and dataset is openly available in Huggingface.
+What makes this model so cool? 🤨
+📚 The dataset is synthetically generated from Llama 3 70B. A big problem with existing Indonesian instruction dataset is they're really badly translated versions of English datasets. Llama 3 70B can generate fluent Indonesian! (with minor caveats 😔)
+🔨 Llama 3 8B can already respond in Indonesian... but it's highly inconsistent 😭 and needs lots of tedious prompt engineering. This model is highly consistent in responding in Indonesian!
+How did I go about it?
+✈  Scaling up synthetic data generation! Companies like Microsoft and Meta realized it is absolutely essential for developing LMs. From this and previous experience in creating Jawa Krama dataset, this is surprisingly useful for low-medium resource languages.
+🦚 This was highly inspired by last year's efforts from Merak-7B, a collection of open, fine-tuned Indonesian models. However, Kancil leveraged synthetic data in a very creative way, which makes it unique from Merak!
+### Version 0.0
+This is the very first working prototype, Kancil V0. It supports basic QA functionalities only. Currently, you cannot chat with it.
+This model was fine-tuned with QLoRA using the amazing Unsloth framework! It was built on top of [unsloth/llama-3-8b-bnb-4bit](https://huggingface.co/unsloth/llama-3-8b-bnb-4bit) and subsequently merged back to 4 bit (no visible difference with merging back to fp 16).
+## Uses
+### Direct Use
+This model is developed with research purposes for  researchers or general AI hobbyists. However, it has one big application: You can have lots of fun with it!
 ### Out-of-Scope Use
+This is a minimally-functional research preview model with no safety curation. Do not use this model for commercial or practical applications.
+You are also not allowed to use this model without having fun.
+## Getting started
+As mentioned, this model was trained with Unsloth. Please use its code for better experience.
+```
+# Install dependencies
+%%capture
+!pip install "unsloth[colab-new] @ git+https://github.com/unslothai/unsloth.git"
+!pip install --no-deps "xformers<0.0.26" trl peft accelerate bitsandbytes
+```
+```
+# Load the model
+from unsloth import FastLanguageModel
+import torch
+model, tokenizer = FastLanguageModel.from_pretrained(
+    model_name = "catinthebag/Kancil-V0-llama3",
+    max_seq_length = max_seq_length,
+    dtype = torch.bfloat16, # Will default to float 16 if not available
+    load_in_4bit = True,
+)
+```
+```
+# This model was trained on this specific prompt template. Changing it might lead to performance degradations.
+prompt_template = """User: {prompt}
+Asisten: {response}"""
+EOS_TOKEN = tokenizer.eos_token
+def formatting_prompts_func(examples):
+    inputs       = examples["prompt"]
+    outputs      = examples["response"]
+    texts = []
+    for input, output in zip(inputs, outputs):
+        text = prompt_template.format(prompt=input, response=output) + EOS_TOKEN
+        texts.append(text)
+    return { "text" : texts, }
+pass
+```
+```
+# Start generating!
+FastLanguageModel.for_inference(model)
+inputs = tokenizer(
+[
+    prompt_template.format(
+        prompt="Apa itu generative AI?",
+        response="",
+    )
+], return_tensors = "pt").to("cuda")
+outputs = model.generate(**inputs, max_new_tokens = 128, temperature=.8, use_cache = True)
+print(tokenizer.batch_decode(outputs)[0])
+```
+**Note:** There was an issue with the dataset such that newline characters are printed as string literals. Sorry about that!
+## Acknowledgments
+- **Developed by:** Afrizal Hasbi Azizy
+- **Funded by [optional]:** DF Labs (dflabs.id)
+- **License:** Llama 3 Community License