Scientific Document Insight Q/A
Project description
title: 📝 Scientific Document Insight QA emoji: colorFrom: yellow colorTo: pink sdk: streamlit sdk_version: 1.27.2 app_file: streamlit_app.py pinned: false license: apache-2.0
DocumentIQA: Scientific Document Insight QA
Work in progress :construction_worker:
Introduction
Question/Answering on scientific documents using LLMs (OpenAI, Mistral, LLama2, etc..).
This application is the frontend for testing the RAG (Retrieval Augmented Generation) on scientific documents, that we are developing at NIMS.
Differently to most of the project, we focus on scientific articles. We target only the full-text using Grobid that provide and cleaner results than the raw PDF2Text converter (which is comparable with most of other solutions).
NER in LLM response: The responses from the LLMs are post-processed to extract physical quantities, measurements (with grobid-quantities) and materials mentions (with grobid-superconductors).
Demos:
- (on HuggingFace spaces): https://lfoppiano-document-qa.hf.space/
- (on the Streamlit cloud): https://document-insights.streamlit.app/
Getting started
- Select the model+embedding combination you want ot use
(for LLama2 you must acknowledge their licence both on meta.com and on huggingface. See here)(Llama2 was removed due to API limitations). - Enter your API Key (Open AI or Huggingface).
- Upload a scientific article as PDF document. You will see a spinner or loading indicator while the processing is in progress.
- Once the spinner stops, you can proceed to ask your questions
Options
Context size
Allow to change the number of embedding chunks that are considered for responding. The text chunk are around 250 tokens, which uses around 1000 tokens for each question.
Query mode
By default, the mode is set to LLM (Language Model) which enables question/answering. You can directly ask questions related to the document content, and the system will answer the question using content from the document. If you switch the mode to "Embedding," the system will return specific chunks from the document that are semantically related to your query. This mode helps to test why sometimes the answers are not satisfying or incomplete.
Development notes
To release a new version:
bump-my-version bump patch
- `git push --tags
To use docker:
- docker run
lfoppiano/document-insights-qa:latest
To install the library with Pypi:
pip install document-qa-engine
Acknolwedgement
This project is developed at the National Institute for Materials Science (NIMS) in Japan in collaboration with the Lambard-ML-Team.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file document-qa-engine-0.2.0.tar.gz
.
File metadata
- Download URL: document-qa-engine-0.2.0.tar.gz
- Upload date:
- Size: 451.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e3d678604316073c2734df0b1db48e8be1367a7fb7645cf609156e5c573ad42 |
|
MD5 | 83ce8a06e095cb976c7da8c93d1c96ae |
|
BLAKE2b-256 | 6e3ef3c19c031b85bcea1d576b7cb912ef505abcb135ab482572eb04d93bf29c |
File details
Details for the file document_qa_engine-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: document_qa_engine-0.2.0-py3-none-any.whl
- Upload date:
- Size: 19.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7546c96e66505b302e854f04377311c5cff89f4a92643dd96c8e8e07c45af60a |
|
MD5 | c1be124cbabb86ee86b64573778085f3 |
|
BLAKE2b-256 | 46a1ee0f77209a9569fa64244b87263078b4d48e5f9fe4066082d9835013a7bd |