Skip to content

Luca-Pozzi/ai_reviewing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Reviewing tools

AI-powered tools to support the literature review process.

The ai_reviewing.ipynb implements Retrieval-Augmented Generation (RAG), i.e. a technique that grants a generative model to fetch information from (in this case) files in the local system. Leveraging on the power of RAG, the notebook allows the user to query the paper and gather insights without having to read the full-text.

Important

The power of the present tool is its flexibility, and thus the possibility to be run on a large collection of references without any human supervision. For similar analysis of a single paper, online tools with better performance are available. See for example Paper Digest or SciSpace.

How to install

  • Clone the repo with
    git clone https://github.com/Luca-Pozzi/ai_reviewing.git
    
  • [Optional]. Setup a virtual environment and activate it
    python3.12 -m venv gpt4all_venv
    <path_to_venv>\Scripts\activate # in Windows
    . <path_to_venv>/bin/activate   # in Linux
    
  • Install the requirements
    pip install -r requirements.txt
    

How to use

Export the collection of papers from Zotero

  • Create a collection of references in Zotero.
  • Ensure that each reference has an associated local PDF file.
  • Export the collection from Zotero in BibTex format. To do so:
    • right-click on the collection in the left menu,
    • select Export,
    • from the pop-up menu, select BibTex in the Format field,
    • tick the Export file option (other options can be left unchecked),
    • click OK and select the location for your file.

Use RAG to summarize papers from the collection

Run the ai_reviewing.ipynb cell-by-cell. You might have to adapt the query strings to your specific use case.

Troubleshooting

  • Even if you have downloaded the models, instanciating a GPT4All object will try to access gpt4all.io. This happens under the hood with any instanciation of GPT4All models, either LLMs or embeddings, with both the GPT4All SDK or via LangChain.
    See here how to turn off this functionality and how to reproduce the online behavior without Internet access.
  • If you are running the ai_reviewing.ipynb tool from VS Code and you have installed the dependencies in a virtual environment, you might have a hard time setting the right interpreter.
    To do so:
    • From inside VS Code, press Ctrl + Shift + P to open the control palette, and look for the Python: Select Interpreter entry.
    • Click on Python: Select Interpreter > Enter interpreter path... > Find... and browse to the python executable inside your venv folder. Now your venv should be visible in the list of kernels to select when you try to run the first cell. If not, try to close and re-open VS Code and check the list again.

About

AI-powered tools to support the literature review process

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors