Skip to main content

A Python package to generate BEL statements and CX2 networks.

Project description

textToKnowledgeGraph

A Python package to generate BEL statements and CX2 networks.

Table of Contents

License

Project Description

textToKnowledgeGraph is a Python package that converts natural language scientific text into structured knowledge graphs using the capabilities of advanced language models (LLMs). It can be used for:

  • Generating BEL statements.
  • Extracting entities and interactions from scientific text.
  • Uploading the generated CX2 networks to NDEx.

Glossary

These discusses terms that would be used in this documentation:

  • BEL (Biological Expression Language): BEL is a structured language used to represent scientific findings, especially in the biomedical domain, in a computable format. Learn More: BEL Documentation
  • CX2 (Cytoscape Exchange Format 2): CX2 is a JSON-based format used for storing and exchanging network data in Cytoscape. Learn More: CX2 Specification
  • PMCID (PubMed Central Identifier): A unique identifier for articles archived in PubMed Central (PMC), a free digital repository of biomedical and life sciences journal literature. Learn More: PubMed Central
  • NDEx (Network Data Exchange): NDEx is an online resource that facilitates the sharing, storage, and visualization of biological networks. Learn More: NDEx
  • LangChain: LangChain is a framework for developing applications powered by language models. It allows easy integration of language models with data sources and APIs, enabling workflows like knowledge extraction and retrieval. Learn More: LangChain
  • Cytoscape: Cytoscape is an open-source platform for visualizing and analyzing complex networks, including biological pathways, protein interaction networks, and more. Learn More: Cytoscape
  • Knowledge Graph: A knowledge graph is a structured representation of knowledge in a graph format, where entities are nodes and relationships are edges. It enables intuitive querying, reasoning, and visualization of complex biological data, aiding in understanding biological systems and facilitating discoveries.

Installation

Install the package via pip:

pip install textToKnowledgeGraph

Methodology

  • BEL Generation

    • The process_paper function in textToKnowledgeGraph.main processes scientific papers with PMCIDs to extract biological interactions and generate BEL statements.
    • The llm_bel_processing function in textToKnowledgeGraph.sentence_level_extraction performs sentence-level extraction of BEL statements using openai model. It passes the papers through the language model to extract BEL statements paragraph by paragraph. Then it saves the extracted BEL statements with the paragraph that it was extracted from.
  • CX2 Network Generation

  • Uploading to NDEx

    • The save_new_cx2_network function in textToKnowledgeGraph.main uploads the generated CX2 networks to NDEx for sharing and visualization. In order to use this function, you need to provide your NDEx email and password as an argument.

Usage

To install python package:

pip install textToKnowledgeGraph

Required parameters:

  • pmc_id: can only process one at a time

  • api_key: open_ai api key

Optional parameters:

  • ndex_email: The NDEx email for authentication. ndex_password: The NDEx password for authentication.

Expected output:

  • BEL statements: extracted from the paper
  • CX2 network: generated from the extracted BEL statements

To run in an interactive python environment:

# Process pmcid without uploading to ndex
from textToKnowledgeGraph import process_paper
 
process_paper("PMC8354587","sk-....") 

# Process pmcid and upload to ndex

from textToKnowledgeGraph import process_paper

process_paper("PMC8354587","sk-..", "favour.ujames196@gmail.com", "Fujames17", upload_to_ndex=True)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

texttoknowledgegraph-0.1.3.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

textToKnowledgeGraph-0.1.3-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file texttoknowledgegraph-0.1.3.tar.gz.

File metadata

  • Download URL: texttoknowledgegraph-0.1.3.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.9

File hashes

Hashes for texttoknowledgegraph-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c5205c4b4563cc688fbd983097609261c718b8bc79b22ab508c5b731ab1c16e5
MD5 a4cfddf6bf5649a60dce061dd966516e
BLAKE2b-256 658c6237749a14af0b6ddc3222d5264c23022c652aff25bd1019684951695432

See more details on using hashes here.

File details

Details for the file textToKnowledgeGraph-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for textToKnowledgeGraph-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ecbc3840027e1c9f30472d68bf2d12044dad673cb3a80bd0171777b045cab295
MD5 1b8a4c8d245661cd40c2e876c069ea60
BLAKE2b-256 87f39904079db19a7f53d57dd389a229e8ebc4152647e87bf8b560ca5b758f83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page