Update README.md

README.md

@@ -9,6 +9,8 @@ base_model: mistralai/Mistral-7B-Instruct-v0.2
 model-index:
 - name: mistral_7b_paper_review_lora
   results: []
+language:
+- en
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -16,21 +18,51 @@ should probably proofread and complete it, then remove this comment. -->
 
 # mistral_7b_paper_review_lora
 
-This model is a fine-tuned version of [mistralai/Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2) on an unknown dataset.
+This model is a fine-tuned version of [mistralai/Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2) on the [dataset](travis0103/abstract_paper_review).
 
-## Model description
+## Model Description
 
-More information needed
+This model is specifically fine-tuned to assist in reviewing machine learning papers based on the abstracts provided. It serves as a useful tool for researchers preparing to submit papers or for reviewers tasked with evaluating submissions. For a detailed description of the model's functionalities and features, please visit our project's GitHub page at [MLPapersReviewGPT](https://github.com/yinuotxie/MLPapersReviewGPT).
 
-## Intended uses & limitations
+## Example Usage
 
-More information needed
+```python
+SYSTEM_PROMPT = """
+You are a professional machine learning conference reviewer who reviews a given paper and considers 4 criteria: [Significance and novelty], [Potential reasons for acceptance], [Potential reasons for rejection], and [Suggestions for improvement]. Please ensure that for each criterion, you summarize and provide random number of detailed supporting points from the content of the paper. And for each supporting point within each of criteria, use the format: '<title of supporting point>' followed by a detailed explanation. The criteria you need to focus on are:
 
-## Training and evaluation data
+1. [Significance and novelty]: Assess the importance of the paper in its research field and the innovation of its methods or findings。
+2. [Potential reasons for acceptance]: Summarize reasons that may support the acceptance of the paper, based on its quality, research results, experimental design, etc.
+3. [Potential reasons for rejection]: Identify and explain flaws or shortcomings that could lead to the paper's rejection.
+4. [Suggestions for improvement]: Provide specific suggestions to help the authors improve the paper and increase its chances of acceptance.
+
+After reading the content of the paper provided below, your response should only include your reviews only, which means always start with [Significance and novelty], dont' repeat the given paper and output things other than your reviews in required format, just extract and summarize information related to these criteria from the provided paper. The paper is given as follows:
+"""
+
+abstract_input = """"
+[TITLE]
+<Title of the paper you want to review>
+
+[ABSTRACT]
+<Abstract of the paper you want to review>
+
+# load the model
+model_id = "travis0103/mistral_7b_paper_review_lora"
+model = AutoPeftModelForCausalLM.from_pretrained(model_id)
+tokenizer = AutoTokenizer.from_pretrained(model_id)
 
-More information needed
+messages = [
+    {"role": "user", "content": SYSTEM_PROMPT},
+    {"role": "assistant", "content": abstract_input}
+]
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+encoded_input = tokenizer.apply_chat_template(messages, return_tensors="pt").to(device)
+generated_ids = model.generate(encoded_input, max_new_tokens=1024, do_sample=True, pad_token_id=tokenizer.eos_token_id, eos_token_id=tokenizer.eos_token_id)
+decoded_output = tokenizer.decode(generated_ids[0], skip_special_tokens=True)
+```
 
-## Training procedure
+## Training and evaluation data
+
+Abstract Paper Review: [Dataset](travis0103/abstract_paper_review)
 
 ### Training hyperparameters
 
@@ -50,10 +82,6 @@ The following hyperparameters were used during training:
 - training_steps: 1
 - mixed_precision_training: Native AMP
 
-### Training results
-
-
-
 ### Framework versions
 
 - PEFT 0.10.0