update

config.ini

@@ -1,39 +1,84 @@
 [feature_store]
-reject_throttle = 0.2574108828701921
-embedding_model_path = "/workspace/models/bce-embedding-base_v1"
-reranker_model_path = "/workspace/models/bce-reranker-base_v1"
+# `feature_store.py` use this throttle to distinct `good_questions` and `bad_questions`
+reject_throttle = -1.0
+# text2vec model, support local relative path, huggingface repo and URL.
+# for example:
+#  "maidalun1020/bce-embedding-base_v1"
+#  "BAAI/bge-m3"
+#  "https://api.siliconflow.cn/v1/embeddings"
+embedding_model_path = "maidalun1020/bce-embedding-base_v1"
+
+# reranker model, support list:
+#  "maidalun1020/bce-reranker-base_v1"
+#  "BAAI/bge-reranker-v2-minicpm-layerwise"
+#  "https://api.siliconflow.cn/v1/rerank"
+reranker_model_path = "maidalun1020/bce-reranker-base_v1"
+
+# if using `siliconcloud` API as `embedding_model_path` or `reranker_model_path`, give the token
 api_token = ""
 api_rpm = 1000
 work_dir = "workdir"
 
 [web_search]
 engine = "serper"
-serper_x_api_key = "20a5c64aad423d6e916fab6459843c60546b372d"
+# web search engine support ddgs and serper
+# For ddgs, see https://pypi.org/project/duckduckgo-search
+# For serper, check https://serper.dev/api-key to get a free API key
+serper_x_api_key = "YOUR-API-KEY-HERE"
 domain_partial_order = ["arxiv.org", "openai.com", "pytorch.org", "readthedocs.io", "nvidia.com", "stackoverflow.com", "juejin.cn", "zhuanlan.zhihu.com", "www.cnblogs.com"]
 save_dir = "logs/web_search_result"
 
 [llm]
-enable_local = 0
-enable_remote = 1
-client_url = "http://127.0.0.1:8889/inference"
+enable_local = 1
+enable_remote = 0
+# hybrid llm service address
+client_url = "http://127.0.0.1:8888/inference"
 
 [llm.server]
+# local LLM configuration
+# support "internlm/internlm2-chat-7b", "internlm2_5-7b-chat" and "qwen/qwen-7b-chat-int8"
+# support local path, for example
+# local_llm_path = "/path/to/your/internlm2_5"
+
 local_llm_path = "internlm/internlm2_5-7b-chat"
 local_llm_max_text_length = 3000
-local_llm_bind_port = 8889
-remote_type = "puyu"
-remote_api_key = "eyJ0eXBlIjoiSldUIiwiYWxnIjoiSFM1MTIifQ.eyJqdGkiOiIwMzAzMjQiLCJyb2wiOiJST0xFX1JFR0lTVEVSIiwiaXNzIjoiT3BlblhMYWIiLCJpYXQiOjE3MjMwMjIwNTIsImNsaWVudElkIjoibXF6a3BsbW53OTdvcGtvMzZqcWoiLCJwaG9uZSI6IiIsInV1aWQiOiI3MWFlMDY0ZC00ZDRmLTQyMjUtOWZjMS0wNmE0ZTRkZTY1YjEiLCJlbWFpbCI6ImtvbmdodWFuanVuQHBqbGFiLm9yZy5jbiIsImV4cCI6MTczODU3NDA1Mn0.jyeIfDTN15ALG3D000Bxjlo5rWWlmalYqTuj0Nn5CT4MFUvTU-StDF17DCxDANHpKpooVO5DsS-3RJAQ29a9cg"
-remote_llm_max_text_length = 40000
-remote_llm_model = "internlm2-latest"
+# llm server listen port
+local_llm_bind_port = 8888
+
+# remote LLM service configuration
+# support "gpt", "kimi", "deepseek", "zhipuai", "step", "internlm", "xi-api" and "alles-apin"
+# support "siliconcloud", see https://siliconflow.cn/zh-cn/siliconcloud
+# xi-api and alles-apin is chinese gpt proxy
+# for internlm, see https://internlm.intern-ai.org.cn/api/document
+
+remote_type = "kimi"
+remote_api_key = "YOUR-API-KEY-HERE"
+# max text length for remote LLM.
+# use 128000 for kimi, 192000 for gpt/xi-api, 16000 for deepseek, 128000 for zhipuai, 40000 for internlm2
+remote_llm_max_text_length = 128000
+# openai API model type, support model list:
+# "auto" for kimi. To save money, we auto select model name by prompt length.
+# "auto" for step to save money, see https://platform.stepfun.com/
+# "gpt-4-0613" for gpt/xi-api,
+# "deepseek-chat" for deepseek,
+# "glm-4" for zhipuai,
+# "gpt-4-1106-preview" for alles-apin or OpenAOE
+# "internlm2-latest" for internlm
+# for example "alibaba/Qwen1.5-110B-Chat", see https://siliconflow.readme.io/reference/chat-completions-1
+remote_llm_model = "auto"
+# request per minute
 rpm = 500
 
 [coreference_resolution]
-base_url = "http://127.0.0.1:9999/v1"
-api_key = "token-abc123"
+base_url = 'http://127.0.0.1:9999/v1'
+api_key = 'token-abc123'
 
 [worker]
+# enable web search or not
 enable_web_search = 1
+# enable search enhancement or not
 enable_sg_search = 0
+# enable coreference resolution in `PreprocNode`
 enable_cr = 0
 save_path = "logs/work.txt"
 
@@ -44,16 +89,21 @@ end = "23:59:59"
 has_weekday = 1
 
 [sg_search]
+# download `src` from https://github.com/sourcegraph/src-cli#installation
 binary_src_path = "/usr/local/bin/src"
 src_access_token = "YOUR-SRC-ACCESS-TOKEN"
 
+# add your repo here, we just take opencompass and lmdeploy as example
 [sg_search.opencompass]
 github_repo_id = "open-compass/opencompass"
 introduction = "用于评测大型语言模型（LLM）. 它提供了完整的开源可复现的评测框架，支持大语言模型、多模态模型的一站式评测，基于分布式技术，对大参数量模型亦能实现高效评测。评测方向汇总为知识、语言、理解、推理、考试五大能力维度，整合集纳了超过70个评测数据集，合计提供了超过40万个模型评测问题，并提供长文本、安全、代码3类大模型特色技术能力评测。"
+# introduction = "For evaluating Large Language Models (LLMs). It provides a fully open-source, reproducible evaluation framework, supporting one-stop evaluation for large language models and multimodal models. Based on distributed technology, it can efficiently evaluate models with a large number of parameters. The evaluation directions are summarized in five capability dimensions: knowledge, language, understanding, reasoning, and examination. It integrates and collects more than 70 evaluation datasets, providing in total over 400,000 model evaluation questions. Additionally, it offers evaluations for three types of capabilities specific to large models: long text, security, and coding."
 
 [sg_search.lmdeploy]
 github_repo_id = "internlm/lmdeploy"
 introduction = "lmdeploy 是一个用于压缩、部署和服务 LLM（Large Language Model）的工具包。是一个服务端场景下，transformer 结构 LLM 部署工具，支持 GPU 服务端部署，速度有保障，支持 Tensor Parallel，多并发优化，功能全面，包括模型转换、缓存历史会话的 cache feature 等. 它还提供了 WebUI、命令行和 gRPC 客户端接入。"
+# introduction = "lmdeploy is a toolkit for compressing, deploying, and servicing Large Language Models (LLMs). It is a deployment tool for transformer-structured LLMs in server-side scenarios, supporting GPU server-side deployment, ensuring speed, and supporting Tensor Parallel along with optimizations for multiple concurrent processes. It offers comprehensive features including model conversion, cache features for caching historical sessions and more. Additionally, it provides access via WebUI, command line, and gRPC clients."
+# add your repo here, we just take opencompass and lmdeploy as example
 
 [sg_search.mmpose]
 github_repo_id = "open-mmlab/mmpose"
@@ -84,30 +134,58 @@ github_repo_id = "open-mmlab/mmcv"
 introduction = "MMCV is a foundational library for computer vision research and it provides image/video processing, image and annotation visualization, image transformation, various CNN architectures and high-quality implementation of common CPU and CUDA ops"
 
 [frontend]
+# chat group assistant type, support "lark_group", "wechat_personal", "wechat_wkteam" and "none"
+# for "lark_group", open https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process to create one
+# for "wechat_personal", read ./docs/add_wechat_group_zh.md to setup gateway
+# for "wkteam", see https://wkteam.cn/
 type = "none"
+
+# for "lark", it is chat group webhook url, send reply to group, for example "https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxx"
+# for "lark_group", it is the url to fetch chat group message, for example "http://101.133.161.20:6666/fetch", `101.133.161.20` is your own public IPv4 addr
+# for "wechat_personal", it is useless
 webhook_url = "https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxx"
+
+# when a new group chat message is received, should it be processed immediately or wait for 18 seconds in case the user hasn't finished speaking?
+# support "immediate"
 message_process_policy = "immediate"
 
 [frontend.lark_group]
+# "lark_group" configuration examples, use your own app_id and secret !!!
 app_id = "cli_a53a34dcb778500e"
 app_secret = "2ajhg1ixSvlNm1bJkH4tJhPfTCsGGHT1"
 encrypt_key = "abc"
 verification_token = "def"
 
 [frontend.wechat_personal]
+# "wechat_personal" listen port
 bind_port = 9527
 
 [frontend.wechat_wkteam]
+# wechat message callback server ip
 callback_ip = "101.133.161.11"
 callback_port = 9528
+
+# public redis config
 redis_host = "101.133.161.11"
 redis_port = "6380"
 redis_passwd = "hxd123"
+
+# wkteam
 account = ""
 password = ""
+# !!! `proxy` is very import parameter, it's your account location
+# 1：北京 2：天津 3：上海 4：重庆 5：河北
+# 6：山西 7：江苏 8：浙江 9：安徽 10：福建
+# 11：江西 12：山东 13：河南 14：湖北 15：湖南
+# 16：广东 17：海南 18：四川 20：陕西
+# bad proxy would cause account deactivation !!!
 proxy = -1
+
+# save dir
 dir = "wkteam"
 
+# 群号和介绍
+# 茴香豆相关
 [frontend.wechat_wkteam.43925126702]
 name = "茴香豆群（大暑）"
 introduction = "github https://github.com/InternLM/HuixiangDou 用户体验群"
@@ -128,6 +206,7 @@ introduction = "github https://github.com/InternLM/HuixiangDou 用户体验群"
 name = "茴香豆群（雨水）"
 introduction = "github https://github.com/InternLM/HuixiangDou 用户体验群"
 
+# github.com/tencent/ncnn contributors
 [frontend.wechat_wkteam.18356748488]
 name = "卷卷群"
-introduction = "ncnn contributors group"
+introduction = "ncnn contributors group"