From 2e5dc6f2bd402b7ce17aa26f1eeaabb726e710b7 Mon Sep 17 00:00:00 2001
From: Yunlin Mao
Date: Wed, 18 Dec 2024 12:31:59 +0800
Subject: [PATCH] add user group (#251)
* add user group
* use oss
---
.pre-commit-config_local.yaml | 49 -----------------------------------
README.md | 12 +++++++++
README_zh.md | 12 ++++++++-
linter.sh | 3 ---
4 files changed, 23 insertions(+), 53 deletions(-)
delete mode 100644 .pre-commit-config_local.yaml
delete mode 100644 linter.sh
diff --git a/.pre-commit-config_local.yaml b/.pre-commit-config_local.yaml
deleted file mode 100644
index 31f8a2ac..00000000
--- a/.pre-commit-config_local.yaml
+++ /dev/null
@@ -1,49 +0,0 @@
-repos:
- - repo: /home/admin/pre-commit/flake8
- rev: 4.0.0
- hooks:
- - id: flake8
- exclude: |
- (?x)^(
- thirdparty/|
- examples/
- )$
-# - repo: /home/admin/pre-commit/isort
-# rev: 4.3.21
-# hooks:
-# - id: isort
-# exclude: |
-# (?x)^(
-# thirdparty/|
-# examples/
-# )$
-# - repo: /home/admin/pre-commit/mirrors-yapf
-# rev: v0.30.0
-# hooks:
-# - id: yapf
-# exclude: |
-# (?x)^(
-# thirdparty/|
-# examples/
-# )$
- - repo: /home/admin/pre-commit/pre-commit-hooks
- rev: v3.1.0
- hooks:
- - id: trailing-whitespace
- exclude: thirdparty/
- - id: check-yaml
- exclude: thirdparty/
- - id: end-of-file-fixer
- exclude: thirdparty/
- - id: requirements-txt-fixer
- exclude: thirdparty/
- - id: double-quote-string-fixer
- exclude: thirdparty/
- - id: check-merge-conflict
- exclude: thirdparty/
- - id: fix-encoding-pragma
- exclude: thirdparty/
- args: ["--remove"]
- - id: mixed-line-ending
- exclude: thirdparty/
- args: ["--fix=lf"]
diff --git a/README.md b/README.md
index 4717a5de..d19e55ad 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,8 @@ The framework accommodates multiple evaluation scenarios such as end-to-end RAG
EvalScope Framework.
+Framework Description
+
The architecture includes the following modules:
1. **Model Adapter**: The model adapter is used to convert the outputs of specific models into the format required by the framework, supporting both API call models and locally run models.
2. **Data Adapter**: The data adapter is responsible for converting and processing input data to meet various evaluation needs and formats.
@@ -58,6 +60,16 @@ The architecture includes the following modules:
5. **Evaluation Report**: The final generated evaluation report summarizes the model's performance, which can be used for decision-making and further model optimization.
6. **Visualization**: Visualization results help users intuitively understand evaluation results, facilitating analysis and comparison of different model performances.
+
+
+## ☎ User Groups
+
+Please scan the QR code below to join our community groups:
+
+[Discord Group](https://discord.com/invite/D27yfEFVz5) | WeChat Group | DingTalk Group
+:-------------------------:|:-------------------------:|:-------------------------:
+ | |
+
## 🎉 News
- 🔥 **[2024.12.13]** Model evaluation optimization: no need to pass the `--template-type` parameter anymore; supports starting evaluation with `evalscope eval --args`. Refer to the [📖 User Guide](https://evalscope.readthedocs.io/en/latest/get_started/basic_usage.html) for more details.
diff --git a/README_zh.md b/README_zh.md
index 4aa2aa1c..e815ebd9 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -47,7 +47,7 @@ EvalScope还适用于多种评测场景,如端到端RAG评测、竞技场模
EvalScope 整体架构图.
-EvalScope包括以下模块:
+架构介绍
1. **Model Adapter**: 模型适配器,用于将特定模型的输出转换为框架所需的格式,支持API调用的模型和本地运行的模型。
@@ -66,6 +66,16 @@ EvalScope包括以下模块:
6. **Visualization**: 可视化结果,帮助用户更直观地理解评测结果,便于分析和比较不同模型的表现。
+
+
+## ☎ 用户群
+
+请扫描下面的二维码来加入我们的交流群:
+
+[Discord Group](https://discord.com/invite/D27yfEFVz5) | 微信群 | 钉钉群
+:-------------------------:|:-------------------------:|:-------------------------:
+ | |
+
## 🎉 新闻
- 🔥 **[2024.12.13]** 模型评测优化,不再需要传递`--template-type`参数;支持`evalscope eval --args`启动评测,参考[📖使用指南](https://evalscope.readthedocs.io/zh-cn/latest/get_started/basic_usage.html)
diff --git a/linter.sh b/linter.sh
deleted file mode 100644
index 2ac7447c..00000000
--- a/linter.sh
+++ /dev/null
@@ -1,3 +0,0 @@
-yapf -r -i evalscope/ setup.py
-isort -rc evalscope/ setup.py
-flake8 evalscope/ setup.py