traintogpb
/

llama-2-enko-translator-7b-qlora-adapter

@@ -1,7 +1,7 @@
 ---
 library_name: peft
 base_model: beomi/open-llama-2-ko-7b
-license: cc
 datasets:
 - traintogpb/aihub-flores-koen-integrated-sparta-30k
 language:
@@ -12,203 +12,80 @@ metrics:
 - comet
 pipeline_tag: translation
 ---
-# 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. -->
-- **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]
-### Framework versions
-- PEFT 0.8.2

 ---
 library_name: peft
 base_model: beomi/open-llama-2-ko-7b
+license: cc-by-sa-4.0
 datasets:
 - traintogpb/aihub-flores-koen-integrated-sparta-30k
 language:
 - comet
 pipeline_tag: translation
 ---
+### Pretrained LM
+- [beomi/open-llama-2-ko-7b](https://huggingface.co/beomi/open-llama-2-ko-7b) (MIT License)
+### Training Dataset
+- [traintogpb/aihub-flores-koen-integrated-sparta-30k](https://huggingface.co/datasets/traintogpb/aihub-flores-koen-integrated-sparta-30k)
+- Can translate in Enlgish-Korean (bi-directional)
+### Prompt
+- Template:
+  ```python
+  prompt = f"Translate this from {src_lang} to {tgt_lang}\n### {src_lang}: {src_text}\n### {tgt_lang}:"
+  >>> # src_lang can be 'English', '한국어'
+  >>> # tgt_lang can be '한국어', 'English'
+  ```
+- Issue:
+  The tokenizer of the model tokenizes the prompt below in different way with the prompt above.
+  Make sure to use the prompt proposed above.
+  ```python
+  prompt = f"""Translate this from {src_lang} to {tgt_lang}
+  ### {src_lang}: {src_text}
+  ### {tgt_lang}:"""
+  >>> # DO NOT USE this prompt.
+  ```
+  And mind that there is no "space (`_`)" at the end of the prompt.
+### Training
+- Trained with QLoRA
+  - PLM: NormalFloat 4-bit
+  - Adapter: BrainFloat 16-bit
+  - Adapted to all the linear layers (around 2.2%)
+### Usage (IMPORTANT)
+- Should remove the EOS token (`<|endoftext|>`, id=46332) at the end of the prompt.
+```python
+# MODEL
+plm_name = 'beomi/open-llama-2-ko-7b'
+adapter_name = 'traintogpb/llama-2-enko-translator-7b-qlora-adapter'
+model = LlamaForCausalLM.from_pretrained(
+    plm_name,
+    max_length=768,
+    quantization_config=bnb_config, # Use the QLoRA config above
+    attn_implementation='flash_attention_2',
+    torch_dtype=torch.bfloat16
+)
+model = PeftModel.from_pretrained(
+    model,
+    adapter_name,
+    torch_dtype=torch.bfloat16
+)
+# TOKENIZER
+tokenizer = LlamaTokenizer.from_pretrained(plm_name)
+tokenizer.pad_token = "</s>"
+tokenizer.pad_token_id = 2
+tokenizer.eos_token = "<|endoftext|>" # Must be differentiated from the PAD token
+tokenizer.eos_token_id = 46332
+tokenizer.add_eos_token = True
+tokenizer.model_max_length = 768
+# INFERENCE
+text = "NMIXX is the world-best female idol group, who came back with the new song 'DASH'."
+prompt = f"Translate this from {src_lang} to {tgt_lang}\n### {src_lang}: {src_text}\n### {tgt_lang}:"
+inputs = tokenizer(prompt, return_tensors="pt", max_length=max_length, truncation=True)
+# REMOVE EOS TOKEN IN THE PROMPT
+inputs['input_ids'] = inputs['input_ids'][0][:-1].unsqueeze(dim=0)
+inputs['attention_mask'] = inputs['attention_mask'][0][:-1].unsqueeze(dim=0)
+outputs = model.generate(**inputs, max_length=max_length, eos_token_id=46332)
+input_len = len(inputs['input_ids'].squeeze())
+translated_text = tokenizer.decode(outputs[0][input_len:], skip_special_tokens=True)
+print(translated_text)
+```