Update README.md

README.md

@@ -56,7 +56,7 @@ qa_datasets = load_dataset('FreedomIntelligence/CMB','qa')
 
 ### 组成部分
 - CMB-main: 全方位多层次测评模型医疗知识;
-   - 结构: 6大项28小项，详见[目录](catalog.md);
+   - 结构: 6大项28小项，详见[目录](https://github.com/FreedomIntelligence/CMB/blob/main/catalog.md);
    - CMB-test: 11200道题目，每一小项400道题目; 
    - CMB-val: 280道附带详细解析的题目; Few Shot数据集;
    - CMB-train: 304743道题目; 模型医疗知识注入;
@@ -64,7 +64,7 @@ qa_datasets = load_dataset('FreedomIntelligence/CMB','qa')
 - CME-qa: 测评复杂临床问诊能力
    - 数据: 73例复杂病例问诊;
 - CMB-exampaper: 测评模型是否通过考试
-   - 数据: 9小项，25套共6571道题目，详见[套题目录](exam-catalog.md);
+   - 数据: 9小项，25套共6571道题目，详见[套题目录](https://github.com/FreedomIntelligence/CMB/blob/main/exam-catalog.md);
 
 
 ### CMB-main & CME-exampaper Item 
@@ -120,194 +120,8 @@ qa_datasets = load_dataset('FreedomIntelligence/CMB','qa')
 
 
 
-## ℹ️ 如何进行评测和提交
+## ℹ️ 如何进行评测和提交详见[github官网](https://github.com/FreedomIntelligence/CMB)
 
-### 修改模型配置文件
-`configs/model_config.yaml` 示例如下：
-```
-my_model:
-    model_id: 'my_model'
-    load:
-        # HuggingFace模型权重文件夹
-        config_dir: "path/to/full/model"
-
-        # 使用peft加载LoRA模型
-        # llama_dir: "path/to/base"
-        # lora_dir: "path/to/lora"
-
-        device: 'cuda'          # 当前仅支持cuda推理
-        precision: 'fp16'       # 推理精度，支持 fp16, fp32
-
-    # inference解码超参,支持 transformers.GenerationConfig 的所有参数
-    generation_config: 
-        max_new_tokens: 512     
-        min_new_tokens: 1          
-        do_sample: False         
-
-```
-
-
-### 添加模型加载代码及prompt格式
-在 `workers/mymodel.py`中修改以下部分：
-1. 加载 model 和 tokenizer
-   ```
-   def load_model_and_tokenizer(self, load_config):
-        # TODO: load your model here
-        hf_model_config = {"pretrained_model_name_or_path": load_config['config_dir'],'trust_remote_code': True, 'low_cpu_mem_usage': True}
-        hf_tokenizer_config = {"pretrained_model_name_or_path": load_config['config_dir'], 'padding_side': 'left', 'trust_remote_code': True}
-        precision = load_config.get('precision', 'fp16')
-        device = load_config.get('device', 'cuda')
-
-        if precision == 'fp16':
-            hf_model_config.update({"torch_dtype": torch.float16})
-
-        model = AutoModelForCausalLM.from_pretrained(**hf_model_config)
-        tokenizer = AutoTokenizer.from_pretrained(**hf_tokenizer_config)
-
-        model.eval()
-        return model, tokenizer # cpu
-   ```
-2. system prompt
-    ```
-    @property
-    def system_prompt(self):
-        return "你是一个人工智能助手。"
-    ```
-3. 指令模板
-    ```
-    @property
-    def instruction_template(self):
-        return self.system_prompt + '问：{instruction}\n答：' # 必须带有{instruction}的placeholder
-    ```
-4. fewshot指令模板
-    ```
-    @property
-    def instruction_template_with_fewshot(self,):
-        return self.system_prompt + '{fewshot_examples}问：{instruction}\n答：'  # 必须带有 {instruction} 和 {fewshot_examples} 的placeholder
-    ```
-5. 单轮对话模板，用于生成模型fewshot数据
-    ```
-    @property
-    def fewshot_template(self):
-        return "问：{user}\n答：{gpt}\n" # 必须带有 {user} 和 {gpt} 的placeholder
-    ```
-
-
-
-
-### 修改运行配置文件
-`generate_answers.sh` 示例如下：
-
-```
-# # 输入文件路径
-# test_data_path='./data/CMB-main/CMB-test/CMB-test-choice-question-merge.json'   # 医疗模型能力测评数据集
-# test_data_path='./data/CMB-test-exampaper/CMB-test-exam-merge.json'             # 真题测评数据集
-# test_data_path='./data/CMB-test-qa/CMB-test-qa.json'                            # 真实病例诊断能力测评数据集
-
-
-task_name='Zero-test-cot'   
-port_id=27272
-
-model_id="my_model"                                                      # 模型id，应与`./configs/model_config.yaml` 中添加的model_id保持一致
-
-accelerate launch \
-    --gpu_ids='all' \                                                   # 使用所有可用GPU
-    --main_process_port $port_id \                                      # 端口
-    --config_file ./configs/accelerate_config.yaml  \                   # accelerate 配置文件路径
-    ./src/generate_answers.py \                                         # 主程序
-    --model_id=$model_id \                                              # 模型ID
-    --cot_flag \                                                        # 是否使用CoT prompt模板                                   
-    --batch_size 3\                                                      # 推理的batch size                                 
-    --input_path=$test_data_path \                                      # 输入文件路径
-    --output_path=./result/${task_name}/${model_id}/answers.json \      # 输出文件路径
-    --model_config_path="./configs/model_config.yaml"                   # 模型配置文件路径
-```
-
-
-### 开始评测
-
-Step 1: 生成回答 + 抽取答案
-```
-bash generate_answers.sh
-```
-
-Step 2: 计算得分
-CMB-Exampaper:
-```
-bash score_exam.sh # Exam数据集
-```
-CMB-test:
-将**Step 1**的输出文件提交至cmedbenchmark@163.com，我们将在第一时间返回详细测评结果。
-
-### 提交结果   
-将 [开始评测](#开始评测) 中 **Step 2** 输出文件提交至cmedbenchmark@163.com，我们将在第一时间更新排行榜。
-
-
-
-
-## ✅  CMB评测细节
-Generate参数: 为了减少方差，一致将Sample设置为False进行Greedy Decoding。
-### CMB Test & Train & Exampaper Prompt
-[CMB-main Item](#cmb-main--cme-exampaper-item)
-#### Answer-only Prompt
-```
-{System_prompt}
-
-<{Role_1}>：以下是中国{exam_type}中{exam_class}考试的一道{question_type}，不需要做任何分析和解释，直接输出答案选项。。
-{题目}
-A. {选项A}
-B. {选项B}
-...
-<{Role_2}>：A
-
-[n-shot demo, n is 0 for the zero-shot case]
-
-<{Role_1}>：以下是中国{exam_type}中{exam_class}考试的一道{question_type}，不需要做任何分析和解释，直接输出答案选项。
-{题目}
-A. {选项A}
-B. {选项B}
-...
-<{Role_2}>：
-```
-#### Chain-of-thought Prompt
-
-```
-{System_prompt}
-
-<{Role_1}>：以下是中国{exam_type}中{exam_class}考试的一道{question_type}，请分析每个选项，并最后给出答案。
-{题目}
-A. {选项A}
-B. {选项B}
-...
-<{Role_2}>：.......所以答案是A
-
-[n-shot demo, n is 0 for the zero-shot case]
-
-<{Role_1}>：以下是中国{exam_type}中{exam_class}考试的一道{question_type}，请分析每个选项，并最后给出答案。
-{题目}
-A. {选项A}
-B. {选项B}
-...
-<{Role_2}>：
-```
-
-### CMB-qa Prompt
-[CMB-qa Item](#cmb-qa-item) 
-```
-{System_prompt}
-
-<{Role_1}>：以下是一位病人的病例：
-{description}
-{QA_pairs[0]['question']}
-<{Role_2}>：..........
-[n-question based on the len(QA_pairs)]
-```
-
-## 局限性
-```
-1. 没有采用真正的多轮对话评估，而是将多轮对话转化为CoT的形式（也可以说：这样对只经过指令微调的模型更公平）
-2. 答案提取方式有bias。
-```
 
 
 ## 😘  引用