Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
Ki-Seki committed Aug 21, 2024
1 parent 23203e8 commit 6739fdc
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,12 @@ UHGEval is a large-scale benchmark designed for evaluating hallucination in prof

To facilitate evaluation, we have developed a user-friendly evaluation framework called Eval Suite. Currently, Eval Suite supports common hallucination evaluation benchmarks, allowing for comprehensive evaluation of the same LLM with just one command as shown in the [Quick Start](#quick-start) section.

| Benchmark | Evaluator | More Information |
| --------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| HalluQA | `HalluQAMCEvaluator` | [eval/benchs/halluqa](eval/benchs/halluqa) |
| HaluEval | `HaluEvalDialogEvaluator`<br>`HaluEvalQAEvaluator`<br>`HaluEvalSummaEvaluator` | [eval/benchs/halueval](eval/benchs/halueval) |
| UHGEval | `UHGDiscKeywordEvaluator`<br>`UHGDiscSentenceEvaluator`<br>`UHGGenerativeEvaluator`<br>`UHGSelectiveEvaluator` | [eval/benchs/uhgeval](eval/benchs/uhgeval) |
| Benchmark | Evaluator | More Information |
| --------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| ExampleQA | `ExampleQAEvaluator` | [eval/benchs/exampleqa](eval/benchs/exampleqa) |
| HalluQA | `HalluQAMCEvaluator` | [eval/benchs/halluqa](eval/benchs/halluqa) |
| HaluEval | `HaluEvalDialogEvaluator`<br>`HaluEvalQAEvaluator`<br>`HaluEvalSummaEvaluator` | [eval/benchs/halueval](eval/benchs/halueval) |
| UHGEval | `UHGDiscKeywordEvaluator`<br>`UHGDiscSentenceEvaluator`<br>`UHGGenerativeEvaluator`<br>`UHGSelectiveEvaluator` | [eval/benchs/uhgeval](eval/benchs/uhgeval) |

## Learn More

Expand Down
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Common
torch
tqdm
ipykernel

# OpenAI API
openai
Expand All @@ -9,6 +10,7 @@ tenacity
# Hugging Face Transformers
transformers
accelerate
sentencepiece

# Metrics
nltk
Expand Down

0 comments on commit 6739fdc

Please sign in to comment.