diff --git a/README.md b/README.md index 983108d..8d29211 100644 --- a/README.md +++ b/README.md @@ -52,19 +52,23 @@ **Table of Content** -- [About TrustLLM](#-about-trustllm) -- [Before Evaluation](#before-evaluation) - - [Installation](#installation) - - [Dataset Download](#dataset-download) - - [Generation](#generation) -- [Evaluation](#evaluation) -- [Dataset & Task](#dataset--task) - - [Dataset overview:](#dataset-overview) - - [Task overview:](#task-overview) -- [Leaderboard](#leaderboard) -- [Contribution](#contribution) -- [Citation](#citation) -- [License](#license) +- [Toolkit for "**TrustLLM: Trustworthiness in Large Language Models**"](#toolkit-for-trustllm-trustworthiness-in-large-language-models) + - [Updates \& News](#updates--news) + - [๐Ÿ‘‚**TL;DR**](#tldr) + - [๐Ÿ™‹ **About TrustLLM**](#-about-trustllm) + - [๐Ÿงน **Before Evaluation**](#-before-evaluation) + - [**Installation**](#installation) + - [**Dataset Download**](#dataset-download) + - [**Generation**](#generation) + - [๐Ÿ™Œ **Evaluation**](#-evaluation) + - [๐Ÿ›Ž๏ธ **Dataset \& Task**](#๏ธ-dataset--task) + - [**Dataset overview:**](#dataset-overview) + - [**Task overview:**](#task-overview) + - [๐Ÿ† **Leaderboard**](#-leaderboard) + - [๐Ÿ“ฃ **Contribution**](#-contribution) + - [**โฐ TODO in Coming Versions**](#-todo-in-coming-versions) + - [**Citation**](#citation) + - [**License**](#license) ## ๐Ÿ™‹ **About TrustLLM** @@ -83,20 +87,28 @@ The [document](https://howiehwong.github.io/TrustLLM/#about) explains how to use ## ๐Ÿงน **Before Evaluation** ### **Installation** +Create a new environment: + +```shell +conda create --name trustllm python=3.9 +``` **Installation via Github (recommended):** ```shell git clone git@github.com:HowieHwong/TrustLLM.git +cd TrustLLM/trustllm_pkg +pip install . ``` -**Installation via `pip`:** + +**Installation via `pip` (deprecated):** ```shell pip install trustllm ``` -**Installation via `conda`:** +**Installation via `conda` (deprecated):** ```sh conda install -c conda-forge trustllm @@ -104,19 +116,6 @@ conda install -c conda-forge trustllm -Create a new environment: - -```shell -conda create --name trustllm python=3.9 -``` - -Install required packages: - -```shell -cd trustllm_pkg -pip install . -``` - ### **Dataset Download** Download TrustLLM dataset: