eimenhmdt / autoresearcher

⚡ Automating scientific workflows with AI ⚡
MIT License
374 stars 38 forks source link

Refactor code base from a script to a Python package #6

Closed eimenhmdt closed 1 year ago

eimenhmdt commented 1 year ago

Hey guys! This pull request addresses the need to restructure and refactor the existing code base, transforming it from a standalone script to a modular and maintainable Python package. The primary goal is to improve code organization, readability, and extendability for future development.

I split up the code as follows:

Lmk what you think about this logic!

Additionally, I updated the literature review workflow to consider semantic similarity between the research question and paper titles when ranking the search results returned by Semantic Scholar.

You can find the published package here

janzheng commented 1 year ago

Looks great, I like how you're importing everything modularly. This makes it easy to reuse the other tools. I think generate_keyword_combinations func could be split up but that could be a future PR

eimenhmdt commented 1 year ago

Thanks for reviewing @janzheng !

re generate_keyword_combinations: Yea, that's a good point. Will try to include that in another PR tomorrow!