Update README.md

README.md

@@ -3,110 +3,88 @@ license: apache-2.0
 base_model: kaist-ai/mpa-Mistral-7b-v0.2-hf-sft-66k
 tags:
 - axolotl
-- dpo
 - trl
-- dpo
 - generated_from_trainer
+- dpo
 model-index:
-- name: mpa-Mistral-7b-v0.2-hf-66k-dpo-5e-7
+- name: janus-dpo-7b
   results: []
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
-[<img src="https://raw.githubusercontent.com/OpenAccess-AI-Collective/axolotl/main/image/axolotl-badge-web.png" alt="Built with Axolotl" width="200" height="32"/>](https://github.com/OpenAccess-AI-Collective/axolotl)
-<details><summary>See axolotl config</summary>
-
-axolotl version: `0.4.0`
-```yaml
-base_model: kaist-ai/mpa-Mistral-7b-v0.2-hf-sft-66k
-model_type: MistralForCausalLM
-tokenizer_type: LlamaTokenizer
-
-load_in_8bit: false
-load_in_4bit: false
-strict: false
-
-rl: dpo
-datasets:
-  - path: kaist-ai/mpa-train-dpo-66k
-    type: chatml.argilla
-    # conversation: mistral
-      
-dataset_prepared_path:
-hub_model_id: kaist-ai/mpa-Mistral-7b-v0.2-hf-66k-dpo-5e-7
-hub_strategy: checkpoint
-# val_set_size: 0
-output_dir: /mnt/nas/seongyun/axolotl/outputs/mpa_66k_dpo-5e-7
-
-sequence_len: 2048
-sample_packing: false
-pad_to_sequence_len: true
-eval_sample_packing: false
-
-wandb_project: mpa
-wandb_entity: seongyun
-wandb_watch:
-wandb_name: mpa_mistral-7b-v0.2-hf-66k-dpo-5e-7
-wandb_log_model:
-
-gradient_accumulation_steps: 4
-micro_batch_size: 1
-num_epochs: 2
-optimizer: adamw_bnb_8bit
-lr_scheduler: cosine
-learning_rate: 0.0000005
-
-train_on_inputs: false
-group_by_length: false
-bf16: auto
-fp16:
-tf32: false
-
-gradient_checkpointing: true
-early_stopping_patience:
-resume_from_checkpoint:
-local_rank:
-logging_steps: 1
-xformers_attention:
-flash_attention: true
-
-warmup_steps: 10
-# evals_per_epoch: 4
-eval_table_size:
-# eval_max_new_tokens: 128
-saves_per_epoch: 1
-debug:
-deepspeed:
-weight_decay: 0.0
-fsdp:
-fsdp_config:
-special_tokens:
-
-```
-
-</details><br>
-
-# mpa-Mistral-7b-v0.2-hf-66k-dpo-5e-7
-
-This model is a fine-tuned version of [kaist-ai/mpa-Mistral-7b-v0.2-hf-sft-66k](https://huggingface.co/kaist-ai/mpa-Mistral-7b-v0.2-hf-sft-66k) on the None dataset.
+## Links for Reference
 
-## Model description
+- **Homepage: In Progress** 
+- **Repository: https://github.com/kaistAI/Janus** 
+- **Paper:** 
+- **Point of Contact:seongyun@kaist.ac.kr**
 
-More information needed
+# TL; DR
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6550c4f27bbfce1878f5f280/vrQl8D8FV3vqUJYbPgsiG.png)
 
-## Intended uses & limitations
+Janus is a model trained using [Mistral-7B-v0.2](https://huggingface.co/mistral-community/Mistral-7B-v0.2) as its base model. Janus has been trained on [Multifaceted Collection](https://huggingface.co/datasets/kaist-ai/Multifaceted-Collection-SFT), a preference dataset containing 192k unique system messages for aligning LLMs to diverse human preferences. Janus not only excels at generating personalized responses that cater to various human preferences but is also adept at producing responses that are generally preferred for being helpful and harmless.
 
-More information needed
+# Model Details
+Janus-DPO-7B is a model created by applying DPO to Janus-66k-7B using the Multifaceted-Collection-DPO.
 
-## Training and evaluation data
+## Model Description
 
-More information needed
+- **Model type:** Language model
+- **Language(s) (NLP):** English
+- **License:** Apache 2.0
+- **Related Models:** [Janus-66k-7B]() [Janus-7B](), [Janus-ORPO-7B](), [Janus-RM-7B]()
+- **Training Datasets**: [Multifaceted-Collection-SFT](https://huggingface.co/datasets/kaist-ai/Multifaceted-Collection-SFT)
+- **Resources for more information:**
+  - [Research paper]()
+  - [GitHub Repo](https://github.com/kaistAI/Janus)
 
-## Training procedure
-
-### Training hyperparameters
+# Usage
+Janus is a model generalized for various system messages, allowing users to control the model's response by inputting the desired system message. The input prompt format is as follows:
+```
+[INST]{system_message}\n{instruction}[/INST]
+```
+Additionally, an example of the inference code applying this is as follows:
+```
+from transformers import AutoTokenizer, AutoModelForCausalLM
+import torch
+
+model_name = "kaist-ai/janus-dpo-7b"
+device = "cuda:0"
+
+# Load the model and tokenizer
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+
+dtype = "float16"
+if torch.cuda.is_bf16_supported():
+    dtype = "bfloat16"
+    
+model = AutoModelForCausalLM.from_pretrained(model_name, torch_dtype=getattr(torch, dtype))
+model.eval()
+model.to(device)
+
+# Prepare inputs
+system = "As a financial news headline writer with a flair for the dramatic, you have taken on the role of crafting compelling headlines about the integration of AI into the financial sector. Your expertise allows you to weave industry-specific terminology seamlessly into each headline, striking a balance between capturing attention and providing meaningful insights into the transformative benefits of AI in finance. With each headline, you focus on elucidating the key advantages AI brings to financial operations, making complex information accessible and immediately impactful. While your headlines are designed to engage and inform an audience of finance and technology professionals, you navigate the fine line of excitement and accuracy with care, ensuring that the promises made are grounded in reality, thus avoiding any form of sensationalism. Your mission is to distill the essence of AI's impact on finance into a single, powerful line that speaks volumes to the informed reader."
+prompt = "Write a headline for an article about the benefits of using AI in the finance sector."
+
+def apply_template_mistral_instruct(system_message, content):
+    prompt = f"{system_message}\n{content}".strip()
+    return f"[INST] {prompt} [/INST] "
+
+input_str = apply_template_mistral_instruct(system, prompt)
+input_ids = tokenizer.encode(input_str, return_tensors="pt")
+print(input_str)
+
+model_inputs = input_ids.to(device)
+
+# Generate text
+output_ids = model.generate(model_inputs, max_new_tokens=1024)
+decoded = tokenizer.batch_decode(output_ids, skip_special_tokens=True)
+print(decoded[0][len(input_str):])
+# Revolutionary Trends: How AI Is Redefining Efficiency and Accuracy in the Financial Realm
+```
+To train Janus and evaluate the responses it generates, please refer to the [GitHub Repo](https://github.com/kaistAI/Janus).
+Additionally, refer to the [Multifaceted Bench](https://huggingface.co/datasets/kaist-ai/Multifaceted-Bench), which evaluates how well LLM generates personalized responses.
+# Training Details
+## Training hyperparameters
 
 The following hyperparameters were used during training:
 - learning_rate: 5e-07
@@ -123,13 +101,18 @@ The following hyperparameters were used during training:
 - lr_scheduler_warmup_steps: 10
 - training_steps: 8143
 
-### Training results
-
-
-
-### Framework versions
+## Framework versions
 
 - Transformers 4.40.0.dev0
 - Pytorch 2.1.1
 - Datasets 2.15.0
 - Tokenizers 0.15.0
+- 
+# Citation
+
+If you find the following model helpful, please consider citing our paper!
+
+**BibTeX:**
+
+```bibtex
+```