Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
areyde authored Jun 6, 2024
1 parent 63b1fb9 commit 2dd824d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions module_summarization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ We provide dependencies via the [Poetry](https://python-poetry.org/docs/) manage

#### Generation

In order to generate your predictions, add your parameters in the [config](configs) directory and run:
In order to generate your predictions, add your parameters in the [configs](configs) directory and run:

* `poetry run python chatgpt.py --config="configs/config_openai.yaml"` if you use [OpenAI](https://platform.openai.com/docs/overview) models;
* `poetry run python togetherai.py --config="configs/config_together.yaml"` if you use [Together.AI](https://www.together.ai/) models.
Expand All @@ -34,7 +34,7 @@ To compare predicted and ground truth metrics we introduce the new metric based
CompScore = \frac{ P(pred | LLM(code, pred, gold)) + P(pred | LLM(code, gold, pred))}{2}
```

In order to evaluate predictions, add your parameters in the (config)[configs/config_eval.yaml] and run:
In order to evaluate predictions, add your parameters in the [config](configs/config_eval.yaml) and run:
* `poetry run python metrics.py --config="configs/config_eval.yaml"`

The script will evaluate the predictions and save the results into the `results.json` file.

0 comments on commit 2dd824d

Please sign in to comment.