From 14eb95a2ac3e24ecb425757d4a4823b0811ff859 Mon Sep 17 00:00:00 2001 From: Vasile Popescu Date: Mon, 1 Jul 2024 08:12:11 +0300 Subject: [PATCH] Update the README.md file --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 64fb6bc..012a877 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ # Simple forecasting bot -This is a very simple forecasting bot which uses an LLM to forecase on a Metaculus tournament. -It lists all questions from the tournament, uses perplexity.ai to search up to date news about the question and then uses ChatGPT to forecast on it. +This is a very simple forecasting bot that uses an LLM to forecast on a Metaculus tournament. It lists all questions from the tournament, uses Perplexity.ai to search for up-to-date news about the questions, and then uses ChatGPT to make forecasts. + +You need to set these secrets and environment variables: -You have to set these secrets and environment variables - `METACULUS_TOKEN` - register your bot to get a token [here](https://www.metaculus.com/aib/) - `TOURNAMENT_ID` - the ID of the tournament your bot should forecast on -- `OPENAI_API_KEY` - used to use ChatGPT and forecast on the question -- `PERPLEXITY_API_KEY` - optional, used to search up to date information about the question. \ No newline at end of file +- `OPENAI_API_KEY` - used to access ChatGPT and make forecasts on the questions +- `PERPLEXITY_API_KEY` - used to search for up-to-date information about the questions + +It uses GitHub Actions to schedule it for running daily (you can see more about that in [daily_run.yaml](.github/workflows/daily_run.yaml)) \ No newline at end of file