[Doc] Add Quick Start and Deployment (#1)

- [Doc] Add Quick Start and Deployment (5ebedaa7a21838e56f6e43cdce5931e3382c4377)


Co-authored-by: taozhang <RandomTao@users.noreply.huggingface.co>

README.md

@@ -52,6 +52,70 @@ For now, the standalone decoder is open-sourced and fully functional without hav
 
 This model is static, trained on an offline dataset. Future versions may be released to enhance its performance on specialized tasks.
 
+**Quickstart**
+
+Here provides a code snippet with apply_chat_template to show you how to load the tokenizer and model and how to generate contents.
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model_name = "tablegpt/TableGPT2-7B"
+
+model = AutoModelForCausalLM.from_pretrained(
+    model_name,
+    torch_dtype="auto",
+    device_map="auto"
+)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+
+prompt = "Hey, who are you?"
+messages = [
+    {"role": "system", "content": "You are a helpful assistant."},
+    {"role": "user", "content": prompt}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
+
+generated_ids = model.generate(
+    **model_inputs,
+    max_new_tokens=512
+)
+generated_ids = [
+    output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+]
+
+response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+```
+
+**Deployment**
+
+For deployment, we recommend using vLLM.
+* **Install vLLM**: You can install vLLM by running the following command.
+  ```bash
+  pip install "vllm>=0.4.3"
+  ```
+* **Model Deployment**: Use vLLM to deploy your model. For example, you can use the command to set up a server similar to openAI:
+  ```bash
+  python -m vllm.entrypoints.openai.api_server --served-model-name TableGPT2-7B --model path/to/weights
+  ```
+  Then you can access the Chat API by:
+
+  ```bash
+  curl http://localhost:8000/v1/chat/completions \
+      -H "Content-Type: application/json" \
+      -d '{
+      "model": "TableGPT2-7B",
+      "messages": [
+          {"role": "system", "content": "You are a helpful assistant."},
+          {"role": "user", "content": "Hey, who are you?"}
+      ]
+      }'
+  
+  ```
+
 **License**  
 
 The TableGPT2-7B license permits both research and commercial use, with further details available in the [GitHub repository](https://github.com/tablegpt/tablegpt-agent).