texttoknowledgegraph 0.1.8

A Python package to generate BEL statements and CX2 networks.

textToKnowledgeGraph

A Python package to generate BEL statements and CX2 networks.

Table of Contents

• License
• Project Description
• Glossary
• Installation
• Methodology
  • BEL Generation
  • CX2 Network Generation
  • Uploading to NDEx
• Usage

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

  • The convert_to_cx2 function in textToKnowledgeGraph.convert_to_cx2 converts extracted interactions into CX2 network format for visualization in Cytoscape.

• 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-..", "[e-mail]", "xxxx", upload_to_ndex=True)