OntoGPT
Project description
OntoGPT
Introduction
OntoGPT is a Python package for extracting structured information from text with large language models (LLMs), instruction prompts, and ontology-based grounding.
For more details, please see the full documentation.
Quick Start
OntoGPT runs on the command line, though there's also a minimal web app interface (see Web Application
section below).
-
Ensure you have Python 3.9 or greater installed.
-
Install with
pip
:pip install ontogpt
-
Set your OpenAI API key:
runoak set-apikey -e openai <your openai api key>
-
See the list of all OntoGPT commands:
ontogpt --help
-
Try a simple example of information extraction:
echo "One treatment for high blood pressure is carvedilol." > example.txt ontogpt extract -i example.txt -t drug
OntoGPT will retrieve the necessary ontologies and output results to the command line. Your output will provide all extracted objects under the heading
extracted_object
.
Web Application
There is a bare bones web application for running OntoGPT and viewing results.
First, install the required dependencies with pip
by running the following command:
pip install ontogpt[web]
Then run this command to start the web application:
web-ontogpt
NOTE: We do not recommend hosting this webapp publicly without authentication.
Model APIs
OntoGPT uses the litellm
package (https://litellm.vercel.app/) to interface with LLMs.
This means most APIs are supported, including OpenAI, Azure, Anthropic, Mistral, Replicate, and beyond.
The model name to use may be found from the command ontogpt list-models
- use the name in the first column with the --model
option.
In most cases, this will require setting the API key for a particular service as above:
runoak set-apikey -e anthropic-key <your anthropic api key>
Some endpoints, such as OpenAI models through Azure, require setting additional details. These may be set similarly:
runoak set-apikey -e azure-key <your azure api key>
runoak set-apikey -e azure-base <your azure endpoint url>
runoak set-apikey -e azure-version <your azure api version, e.g. "2023-05-15">
These details may also be set as environment variables as follows:
export AZURE_API_KEY="my-azure-api-key"
export AZURE_API_BASE="https://example-endpoint.openai.azure.com"
export AZURE_API_VERSION="2023-05-15"
Open Models
Open LLMs may be retrieved and run through the ollama
package (https://ollama.com/).
You will need to install ollama
(see the GitHub repo), and you may need to start it as a service with a command like ollama serve
or sudo systemctl start ollama
.
Then retrieve a model with ollama pull <modelname>
, e.g., ollama pull llama3
.
The model may then be used in OntoGPT by prefixing its name with ollama/
, e.g., ollama/llama3
, along with the --model
option.
Some ollama models may not be listed in ontogpt list-models
but the full list of downloaded LLMs can be seen with ollama list
command.
Evaluations
OntoGPT's functions have been evaluated on test data. Please see the full documentation for details on these evaluations and how to reproduce them.
Related Projects
- TALISMAN, a tool for generating summaries of functions enriched within a gene set. TALISMAN uses OntoGPT to work with LLMs.
Tutorials and Presentations
- Presentation: "Staying grounded: assembling structured biological knowledge with help from large language models" - presented by Harry Caufield as part of the AgBioData Consortium webinar series (September 2023)
- Presentation: "Transforming unstructured biomedical texts with large language models" - presented by Harry Caufield as part of the BOSC track at ISMB/ECCB 2023 (July 2023)
- Presentation: "OntoGPT: A framework for working with ontologies and large language models" - talk by Chris Mungall at Joint Food Ontology Workgroup (May 2023)
Citation
The information extraction approach used in OntoGPT, SPIRES, is described further in: Caufield JH, Hegde H, Emonet V, Harris NL, Joachimiak MP, Matentzoglu N, et al. Structured prompt interrogation and recursive extraction of semantics (SPIRES): A method for populating knowledge bases using zero-shot learning. Bioinformatics, Volume 40, Issue 3, March 2024, btae104, https://doi.org/10.1093/bioinformatics/btae104.
Acknowledgements
This project is part of the Monarch Initiative. We also gratefully acknowledge Bosch Research for their support of this research project.
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 ontogpt-1.0.7.tar.gz
.
File metadata
- Download URL: ontogpt-1.0.7.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f029b5163635ac66e924e8c28c8d2a8f790ca565fe27f0a67b60ec2c7ced4e4d |
|
MD5 | 5c0538bbd16c95773c19dbca200e1052 |
|
BLAKE2b-256 | c2a819e20ccba0775ea1a0ba65dd76946522c95cfb12480028cc92f4d9b239f0 |
File details
Details for the file ontogpt-1.0.7-py3-none-any.whl
.
File metadata
- Download URL: ontogpt-1.0.7-py3-none-any.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79e36a9adfe3b8f72236162efbeee618c9ad24142b2ddb4e2c652ae7e3a8706d |
|
MD5 | 28160e07496da33373f33cc107354ead |
|
BLAKE2b-256 | f92c5a0b5db07a283fdb81866d479b4c81b0db7b6777293e92beda9f808a3794 |