WIP: Formatting

[i-be-snek]

This PR is meant to do two things:

(1) format any left-over files using the pre-commit hook (done automatically)
(2) improve the README, especially after a large number of changes were made to the pipeline

[i-be-snek]

@liniiiiii

I don't understand this sentence:

This name will be used as the output file, the api env you want to use, the decription of the experiment, the prompt category, and the batch file location you want to store the batch file (this is not mandatory, but it's good to check if you create correct batch file)

Is it suggesting that the experiment name and description and category will all be the name of the output file?

Maybe adding a psuedo example (or a real example) could help

[liniiiiii]

thanks, I will do that, where can I edit it, in the same branch?

[i-be-snek]

You can edit the same branch. I think for READMEs you can even safely edit directly in the Github website :D

[liniiiiii]

Pls keep this pr for a while, I will check other readmes I edited later, thanks!

[i-be-snek]

Wow, this looks great! Thanks :D

One thing that could help the reader is to say that these are the params to pass into run_prompts

Suggested change

	##### Step 1: Experiment Settings
	##### Step 1: Experiment Settings
	Here is what you need to begin an experiment run with `Database/Prompts/run_prompts.py`:

[i-be-snek]

Could we add something like this:

# check the args and flags
poetry run python3 Database/Prompts/run_prompts.py --help

[i-be-snek]

Output:

wikimpacts-py3.11➜  Wikimpacts git:(drop-l1-missing-all-impacts) ✗ poetry run python3 Database/Prompts/run_prompts.py --help

usage: run_prompts.py [-h] [-f FILENAME] [-r RAW_DIR] [-b BATCH_DIR] [-m MODEL_NAME] [-t MAX_TOKENS] [-e API_ENV] [-d DESCRIPTION] [-p PROMPT_CATEGORY]

options:
  -h, --help            show this help message and exit
  -f FILENAME, --filename FILENAME
                        The name of the json file in the <Wikipedia articles> directory
  -r RAW_DIR, --raw_dir RAW_DIR
                        The directory containing Wikipedia json files to be run
  -b BATCH_DIR, --batch_dir BATCH_DIR
                        The directory where the batch file will land (as .jsonl)
  -m MODEL_NAME, --model_name MODEL_NAME
                        The model version applied in the experiment, like gpt-4o-mini.
  -t MAX_TOKENS, --max_tokens MAX_TOKENS
                        The max tokens of the model selected
  -e API_ENV, --api_env API_ENV
                        The env file that contains the API keys.
  -d DESCRIPTION, --description DESCRIPTION
                        The description of the experiment
  -p PROMPT_CATEGORY, --prompt_category PROMPT_CATEGORY
                        The prompt category of the experiment, can only choose from impact, basic, and all

[liniiiiii]

thanks for the suggestion, I will check them out after I fixed the visualization!

[i-be-snek]

As per the suggestion from @koffiworou, I've moved the dev doc section further to the top so that users can make sure they have all the basics and dependencies set up before developing.