Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AakritiKinra authored Dec 13, 2024
1 parent 1f81838 commit d720dfb
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions examples/factscore_eval/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# FActScore: Fine-grained Atomic Evaluation of Factual Precision in Long Form Text Generation

This is a replication of the experiments from
[FActScore: Fine-grained Atomic Evaluation of Factual Precision in Long Form Text Generation](https://aclanthology.org/2023.emnlp-main.741) (Min et al., EMNLP 2023).
[FActScore: Fine-grained Atomic Evaluation of Factual Precision in Long Form
Text Generation](https://aclanthology.org/2023.emnlp-main.741) (Min et al., EMNLP
2023).

## Dependencies

Expand All @@ -19,16 +21,21 @@ pip install -r requirements.txt

To access and use OpenAI's services (such as GPT models),
you must obtain an API key from OpenAI.
After acquiring your API key, store it in a txt file such as ```key.txt``` amd pass it when creating an instance of the ```FactScorer``` class.
After acquiring your API key, store it in a txt file
such as `key.txt` amd pass it when creating an instance
of the `FactScorer` class.

### Data Preparation

Before running the code to generate the CommunityLM responses, make sure you have created the following directory to store the data:
Before running the code to generate the CommunityLM responses,
make sure you have created the following directory to store the data:

```bash
mkdir -p factscore_data
```
This will be the data directory for the FactScore analysis and all CSV files must be inside this folder.

This will be the data directory for the FactScore analysis
and all CSV files must be inside this folder.

## Reference

Expand Down

0 comments on commit d720dfb

Please sign in to comment.