Add task category, license, and sample usage

#2
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +21 -1
README.md CHANGED
@@ -1,4 +1,7 @@
1
  ---
 
 
 
2
  dataset_info:
3
  features:
4
  - name: task_id
@@ -33,4 +36,21 @@ configs:
33
  - **Homepage:** https://bigcode-bench.github.io/
34
  - **Repository:** https://github.com/bigcode-project/bigcodebench
35
  - **Paper:** [Link](https://arxiv.org/abs/2406.15877)
36
- - **Point of Contact:** contact@bigcode-project.org terry.zhuo@monash.edu
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: apache-2.0
3
+ task_categories:
4
+ - text-generation
5
  dataset_info:
6
  features:
7
  - name: task_id
 
36
  - **Homepage:** https://bigcode-bench.github.io/
37
  - **Repository:** https://github.com/bigcode-project/bigcodebench
38
  - **Paper:** [Link](https://arxiv.org/abs/2406.15877)
39
+ - **Point of Contact:** contact@bigcode-project.org terry.zhuo@monash.edu
40
+
41
+ ## Sample Usage
42
+
43
+ Install the package and evaluate a model using the remote evaluation API:
44
+
45
+ ```bash
46
+ pip install bigcodebench --upgrade
47
+
48
+ bigcodebench.evaluate \
49
+ --model meta-llama/Meta-Llama-3.1-8B-Instruct \
50
+ --execution [e2b|gradio|local] \
51
+ --split [complete|instruct] \
52
+ --subset [full|hard] \
53
+ --backend [vllm|openai|anthropic|google|mistral|hf|hf-inference]
54
+ ```
55
+
56
+ For more details, please refer to the [GitHub repository](https://github.com/bigcode-project/bigcodebench).