Better documentation

[I-I-IT]

Hi, I have run a test batch today, and they are a couple of small things which could be improved in the docs.

Config
Specify that the user shouldn't directly input the API key in the config file, but rather input the name of the apiin the config file and then write export NAME_API_KEY=[redacted] in the terminal.

I also had trouble with uv that didn't want to use my venv and they recommended --active which didn't work. Listing all the dependencies might be useful, maybe as an annex.

Also, I noticed that in utils.py
from sympy.parsing.latex import parse_latex import sympy

It seems to me that import should be first, unless I am missing something.

Another thing I had trouble is to view results.I don't understand what path we need to input: the results path or the competition path? Either way, no results display.

[JasperDekoninck]

Hi!

Thanks for the feedback. I updated the README with an alternative to UV (using conda and pip install -e .). I also updated the docs to clarify that the API keys should be added as environment variables.

[JasperDekoninck]

In order to view results, you should put
uv run python scripts/app.py --comp path/to/competition
where path/to/competition is the path relative to the data folder. So if you are running on AIME 2025 I, this would be aime/aime_2025_I. I am assuming that this relative path is a bit unintuitive?

[I-I-IT]

I just have this. No data displayed.

[JasperDekoninck]

It seems from the picture you are still passing data to the path? Could you try with
uv run python scripts/app.py --comp hmmt/hmmt_feb_2025

[I-I-IT]

When I am doing this I just have a blank page.

[JasperDekoninck]

Hmm, this is strange. I cannot reproduce the issue locally. Are you sure you already ran some models on the HMMT competition and that their results are stored in data/hmmt/hmmt_feb_2025? If so, can you give me more details what models you ran and the configs you used for them?

[I-I-IT]

Late reply, but I now got it to work.