A superficial cleaning of the repo has been done. Some code could still benefit from refactoring (e.g., making proper use of utils as stated in #54) but for now the main goal was to make sure that important stuff was documented and the repo was more organised in case of longer breaks due to exams/teaching.
Concretely, what has been done:
Trim down root directory folders and scripts (e.g, remove bash scripts from root and place them in the appropriate subfolders in src)
Trim down subfolders in src (remove old "misc" folder, collapse analysis and inspect)
Update documentation, add more documentation to subfolders of src (e.g., moving preliminary prompting results from results folder to prompt_select/README.md)
Since the project is quite large and has a lot of moving components, I have currently resorted to treating the individual subfolders in src as mini-projects with their own READMEs when appropriate. Suggestions are welcome on how to organise differently.
Future cleaning
Would love to make config files and not hardcode models and prompts in generate/models.py and generate/prompts.py
(Superficial) Spring Cleaning
A superficial cleaning of the repo has been done. Some code could still benefit from refactoring (e.g., making proper use of
utils
as stated in #54) but for now the main goal was to make sure that important stuff was documented and the repo was more organised in case of longer breaks due to exams/teaching.Concretely, what has been done:
src
(remove old "misc" folder, collapseanalysis
andinspect
)src
(e.g., moving preliminary prompting results fromresults
folder toprompt_select/README.md
)Since the project is quite large and has a lot of moving components, I have currently resorted to treating the individual subfolders in
src
as mini-projects with their own READMEs when appropriate. Suggestions are welcome on how to organise differently.Future cleaning
generate/models.py
andgenerate/prompts.py
src/utils
more efficiently)