Update README.md

README.md

@@ -1,5 +1,6 @@
 ---
 license: apache-2.0
+pipeline_tag: text-generation
 ---
 <div style="width: 100%;">
     <img src="http://x-pai.algolet.com/bot/img/logo_core.png" alt="TigerBot" style="width: 20%; display: block; margin: auto;">
@@ -8,85 +9,68 @@ license: apache-2.0
 <font face="黑体" size=5"> A cutting-edge foundation for your very own LLM. </font>
 </p>
 <p align="center">
-   🌐 <a href="https://tigerbot.com/" target="_blank">TigerBot</a> • 🤗 <a href="https://huggingface.co/TigerResearch" target="_blank">Hugging Face</a>
+	💻<a href="https://github.com/TigerResearch/TigerBot" target="_blank">Github</a> • 🌐 <a href="https://tigerbot.com/" target="_blank">TigerBot</a> • 🤗 <a href="https://huggingface.co/TigerResearch" target="_blank">Hugging Face</a>
 </p>
+# 快速开始
 
-## Github
-
-https://github.com/TigerResearch/TigerBot
-
-## Usage
-
-```python
-import os
-
-import fire
-import torch
-from transformers import AutoTokenizer, AutoModelForCausalLM, GenerationConfig
-
-os.environ["TOKENIZERS_PARALLELISM"] = "false"
-
-tok_ins = "\n\n### Instruction:\n"
-tok_res = "\n\n### Response:\n"
-prompt_input = tok_ins + "{instruction}" + tok_res
-
-
-def main(
-        model_path: str,
-        max_input_length: int = 512,
-        max_generate_length: int = 1024,
-):
-    print(f"loading model: {model_path}...")
-
-    model = AutoModelForCausalLM.from_pretrained(model_path, torch_dtype=torch.bfloat16, device_map='auto')
-
-    generation_config = GenerationConfig.from_pretrained(model_path)
-    generation_config.max_length = max_generate_length
-    print(generation_config)
-
-    device = torch.cuda.current_device()
-
-    tokenizer = AutoTokenizer.from_pretrained(
-        model_path,
-        model_max_length=max_generate_length,
-        padding_side="left",
-        truncation_side='left',
-        padding=True,
-        truncation=True
-    )
-    if tokenizer.model_max_length is None or tokenizer.model_max_length > max_generate_length:
-        tokenizer.model_max_length = max_generate_length
-
-    sess_text = ""
-    while True:
-        raw_text = input("prompt(\"exit\" to end, \"clear\" to clear session) >>> ")
-        if not raw_text:
-            print('prompt should not be empty!')
-            continue
-        if raw_text.strip() == "exit":
-            print('session ended.')
-            break
-        if raw_text.strip() == "clear":
-            print('session cleared.')
-            sess_text = ""
-            continue
-
-        query_text = raw_text.strip()
-        sess_text += tok_ins + query_text
-        input_text = prompt_input.format_map({'instruction': sess_text.split(tok_ins, 1)[1]})
-        inputs = tokenizer(input_text, return_tensors='pt', truncation=True, max_length=max_input_length)
-        inputs = {k: v.to(device) for k, v in inputs.items()}
-        output = model.generate(**inputs, **generation_config.to_dict())
-        output_str = tokenizer.decode(output[0], skip_special_tokens=False, spaces_between_special_tokens=False)
-        answer = output_str.rsplit(tok_res, 1)[1].strip()
-        if answer.endswith(tokenizer.eos_token):
-            answer = answer.rsplit(tokenizer.eos_token, 1)[0].strip()
-
-        sess_text += tok_res + answer
-
-        print("=" * 100)
-        print(answer)
-        print("=" * 100)
-
-main('TigerResearch/tigerbot-7b-chat')
-```
+- 方法1，通过transformers使用
+
+  - 下载 TigerBot Repo
+
+     `git clone https://github.com/TigerResearch/TigerBot.git`
+
+  - 启动infer代码
+
+    `python infer.py --model_path TigerResearch/tigerbot-13b-chat`
+
+- 方法2:
+
+  - 下载 TigerBot Repo
+
+     `git clone https://github.com/TigerResearch/TigerBot.git`
+
+  - 安装git lfs： `git lfs install`
+
+  - 通过huggingface或modelscope平台下载权重
+
+    ```shell
+    GIT_LFS_SKIP_SMUDGE=0
+    
+    # From huggingface
+    git clone https://huggingface.co/TigerResearch/tigerbot-7b-chat
+    # From modelscope
+    git clone https://www.modelscope.cn/TigerResearch/tigerbot-7b-chat-v3.git
+    ```
+
+------
+
+# Quick Start
+
+- Method 1, use through transformers
+
+  - Clone TigerBot Repo
+
+     `git clone https://github.com/TigerResearch/TigerBot.git`
+
+  - Run infer script
+
+    `python infer.py --model_path TigerResearch/tigerbot-13b-chat`
+
+- Method 2:
+
+  - Clone TigerBot Repo
+
+     `git clone https://github.com/TigerResearch/TigerBot.git`
+
+  - install git lfs： `git lfs install`
+
+  - Download weights from huggingface or modelscope
+
+    ```shell
+    GIT_LFS_SKIP_SMUDGE=0
+    
+    # From huggingface
+    git clone https://huggingface.co/TigerResearch/tigerbot-7b-chat
+    # From modelscope
+    git clone https://www.modelscope.cn/TigerResearch/tigerbot-7b-chat-v3.git
+    ```