diff --git a/README.md b/README.md index 70953b87..e7a279da 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [🌐Website](https://opencompass.org.cn/) | [📘Documentation](https://opencompass.readthedocs.io/en/latest/) | -[🛠️Installation](https://opencompass.readthedocs.io/en/latest/get_started/install.html) | +[🛠️Installation](https://opencompass.readthedocs.io/en/latest/get_started.html#installation) | [🤔Reporting Issues](https://github.com/InternLM/opencompass/issues/new/choose) English | [简体中文](README_zh-CN.md) @@ -291,7 +291,7 @@ We provide [OpenCompass Leaderbaord](https://opencompass.org.cn/rank) for commun ## Installation -Below are the steps for quick installation. Some third-party features may require additional steps to work properly, for detailed steps please refer to the [Installation Guide](https://opencompass.readthedocs.io/en/latest/get_started.html). +Below are the steps for quick installation and datasets preparation. ```Python conda create --name opencompass python=3.10 pytorch torchvision pytorch-cuda -c nvidia -c pytorch -y @@ -304,9 +304,13 @@ wget https://github.com/InternLM/opencompass/releases/download/0.1.0/OpenCompass unzip OpenCompassData.zip ``` +Some third-party features, like Humaneval and Llama, may require additional steps to work properly, for detailed steps please refer to the [Installation Guide](https://opencompass.readthedocs.io/en/latest/get_started.html). + ## Evaluation -Please read the [Quick Start](https://opencompass.readthedocs.io/en/latest/get_started.html) to learn how to run an evaluation task. +Make sure you have installed OpenCompass correctly and prepared your datasets according to the above steps. Please read the [Quick Start](https://opencompass.readthedocs.io/en/latest/get_started.html#quick-start) to learn how to run an evaluation task. + +For more tutorials, please check our [Documentation](https://opencompass.readthedocs.io/en/latest/index.html). ## Acknowledgements diff --git a/README_zh-CN.md b/README_zh-CN.md index fae6e28f..78057571 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -10,7 +10,7 @@ [🌐Website](https://opencompass.org.cn/) | [📘Documentation](https://opencompass.readthedocs.io/zh_CN/latest/index.html) | -[🛠️Installation](https://opencompass.readthedocs.io/zh_CN/latest/get_started.html) | +[🛠️Installation](https://opencompass.readthedocs.io/zh_CN/latest/get_started.html#id1) | [🤔Reporting Issues](https://github.com/InternLM/opencompass/issues/new/choose) [English](/README.md) | 简体中文 @@ -291,7 +291,7 @@ OpenCompass 是面向大模型评测的一站式平台。其主要特点如下 ## 安装 -下面展示了快速安装的步骤。有部分第三方功能可能需要额外步骤才能正常运行,详细步骤请参考[安装指南](https://opencompass.readthedocs.io/zh_cn/latest/get_started.html)。 +下面展示了快速安装以及准备数据集的步骤。 ```Python conda create --name opencompass python=3.10 pytorch torchvision pytorch-cuda -c nvidia -c pytorch -y @@ -304,9 +304,13 @@ wget https://github.com/InternLM/opencompass/releases/download/0.1.0/OpenCompass unzip OpenCompassData.zip ``` +有部分第三方功能,如 Humaneval 以及 Llama,可能需要额外步骤才能正常运行,详细步骤请参考[安装指南](https://opencompass.readthedocs.io/zh_CN/latest/get_started.html)。 + ## 评测 -请阅读[快速上手](https://opencompass.readthedocs.io/zh_CN/latest/get_started.html#id2)了解如何运行一个评测任务。 +确保按照上述步骤正确安装 OpenCompass 并准备好数据集后,请阅读[快速上手](https://opencompass.readthedocs.io/zh_CN/latest/get_started.html#id3)了解如何运行一个评测任务。 + +更多教程请查看我们的[文档](https://opencompass.readthedocs.io/zh_CN/latest/index.html)。 ## 致谢