Setting up issue template

Author: xusenlin

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE_ZH.yml

@@ -0,0 +1,66 @@
+name: 中文提问模板
+description: 与本项目相关的问题提问，我们会优先查阅内容相对完整的issue。
+
+body:
+  - type: checkboxes
+    id: mustchecks
+    attributes:
+      label: 提交前必须检查以下项目
+      description: 请在提问前检查以下项目，善用搜索功能查找与自己问题相关的issue。
+      options:
+        - label: 请确保使用的是仓库最新代码（git pull），一些问题已被解决和修复。
+          required: true
+        - label: 我已阅读[项目文档](https://github.com/xusenlinzy/api-for-open-llm/blob/master/README.md)和[FAQ章节](https://github.com/xusenlinzy/api-for-open-llm/blob/master/docs/FAQ.md)并且已在Issue中对问题进行了搜索，没有找到相似问题和解决方案
+          required: true
+  - type: dropdown
+    id: question-type
+    attributes:
+      label: 问题类型
+      description: 请选择最符合的问题类型
+      options:
+        - 安装环境
+        - 启动命令
+        - 模型推理和部署
+        - 效果问题
+        - 其他问题
+  - type: dropdown
+    id: model-type
+    attributes:
+      label: 基础模型
+      description: 请提供问题涉及的具体模型。
+  - type: dropdown
+    id: operating-system
+    attributes:
+      label: 操作系统
+      description: 请提供操作系统类型
+      options:
+        - Windows
+        - macOS
+        - Linux
+  - type: textarea
+    id: question-detailed
+    attributes:
+      label: 详细描述问题
+      description: 请尽量具体地描述遇到的问题，**代码程序类问题务必给出完整运行命令**，这将有助于快速定位问题所在。
+      value: |
+        ```
+        # 请在此处粘贴运行代码（如没有可删除该代码块）
+        ```
+  - type: textarea
+    id: dependencies
+    attributes:
+      label: 依赖情况（代码类问题务必提供）
+      description: 请提供transformers, peft, torch等常规依赖库的版本：`pip list | grep -E 'transformers|peft|torch'`
+      value: |
+        ```
+        # 请在此处粘贴依赖情况
+        ```
+  - type: textarea
+    id: logs
+    attributes:
+      label: 运行日志或截图
+      description: 请优先提供文本形式的log（过长内容请上传文件），粘贴内容放在markdown代码块。或者提供截图形式的运行记录。
+      value: |
+        ```
+        # 请在此处粘贴运行日志
+        ```

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

docs/FAQ.md

@@ -0,0 +1,82 @@
+# FAQ
+
+## 安装&环境
+
+###  docker 环境
+
+构建镜像的命令为
+
+```shell
+docker build -f docker/Dockerfile -t llm-api:pytorch .
+```
+
+如果想要提高推理效率和处理并发请求，推荐使用 [vLLM](https://github.com/vllm-project/vllm) 
+
+构建镜像的命令为
+
+```shell
+docker build -f docker/Dockerfile.vllm -t llm-api:vllm .
+```
+
+### 本地环境
+
+**`vLLM` 环境需要将 `torch` 版本升级到 `2.0.0` 以上，再安装 `vllm`**
+
+```shell
+pip install -r requirements.txt
+pip install torch -U
+pip install git+https://github.com/vllm-project/vllm.git
+```
+
+如不需要安装 `vLLM`，则只需要
+
+```shell
+pip install torch==1.14
+pip install -r requirements.txt
+```
+
+## 模型启动命令
+
+### 不使用 vllm
+
+模型启动命令及参数含义见 [script](./SCRIPT.md)
+
+### 使用 vllm
+
+模型启动命令及参数含义见 [vllm_script](./VLLM_SCRIPT.md)
+
+### 模型挂载
+
+如果使用 `docker` 方式启动模型，且模型权重不在该项目下，需要将模型权重挂载到容器中，添加如下命令
+
+```shell
+-v {local_model_path}:/workspace/{container_model_path}
+```
+
+## 接口调用方式
+
+### 可用的接口
+
++ `/v1/models`: 查询模型信息
+
+
++ `/v1/chat/completions`: 聊天
+
+
++ `/v1/completions`: 文字接龙
+
+
++ `/v1/embeddings`: 句子嵌入
+
+
+具体使用方式兼容 [openai](https://github.com/openai/openai-python)
+
+### 接入其他 `web` 项目
+
+接入到其他基于 `chatgpt` 的前后端项目，只需要修改环境变量
+
+
++ `OPENAI_API_KEY`: 此处随意填一个字符串即可
+
+
++ `OPENAI_API_BASE`: 后端启动的接口地址，如：http://192.168.0.xx:80/v1