Skip to content

Commit 3e02370

Browse files
committed
fix: add documentations
1 parent d7cfe54 commit 3e02370

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# BigCodeBench
22

3-
> [!WARNING]
4-
> The project is under active development. Please check back later for more updates.
5-
63
> [!WARNING]
74
> Please use BigCodeBench with caution. Different from [EvalPlus](https://github.com/evalplus/evalplus), BigCodeBench has a much less constrained execution environment to support tasks with diverse library dependencies. This may lead to security risks. We recommend using a sandbox such as [Docker](https://docs.docker.com/get-docker/) to run the evaluation.
85
@@ -54,7 +51,13 @@ We inherit the design of the EvalPlus framework, which is a flexible and extensi
5451
To get started, please first set up the environment:
5552

5653
```shell
54+
# Install to use bigcodebench.evaluate
5755
pip install bigcodebench --upgrade
56+
pip install -I -r https://raw.githubusercontent.com/bigcode-project/bigcodebench/main/Requirements/requirements-eval.txt
57+
58+
# Install to use bigcodebench.generate
59+
# You are strongly recommended to install the generate dependencies in a separate environment
60+
pip install bigcodebench[generate] --upgrade
5861
```
5962

6063
<details><summary>⏬ Install nightly version <i>:: click to expand ::</i></summary>
@@ -158,6 +161,10 @@ We provide a tool namely `bigcodebench.sanitize` to clean up the code:
158161
bigcodebench.sanitize --samples samples.jsonl
159162
# Sanitized code will be produced to `samples-sanitized.jsonl`
160163

164+
# 💡 If you want to get the calibrated results:
165+
bigcodebench.sanitize --samples samples.jsonl --calibrate
166+
# Sanitized code will be produced to `samples-sanitized-calibrate.jsonl`
167+
161168
# 💡 If you are storing codes in directories:
162169
bigcodebench.sanitize --samples /path/to/vicuna-[??]b_temp_[??]
163170
# Sanitized code will be produced to `/path/to/vicuna-[??]b_temp_[??]-sanitized`

0 commit comments

Comments
 (0)