Skip to main content

Fast path finding in large knowledge graphs

Project description

GANDALF

Graph Analysis Navigator for Discovery And Link Finding

Features

  • Compressed Sparse Row (CSR) graph representation for memory efficiency
  • Bidirectional search for optimal performance
  • O(1) property lookups via hash indexing
  • Predicate filtering to reduce path explosion
  • Batch property enrichment for fast results
  • Diagnostic tools to understand path counts

Installation

Recommended: Use a virtual environment

Some transitive dependencies (e.g., stringcase, pytest-logging) require modern pip/setuptools to build correctly. Using a virtual environment ensures you have updated tools.

# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Upgrade pip and setuptools (important for building dependencies)
pip install --upgrade pip setuptools wheel

# Install the package
pip install -e .

Alternative: Direct install (may fail on some systems)

If you have a recent pip/setuptools already, you can try:

pip install -e .

Quick Start

Unzipping a full translator kgx

  • tar -xvf translator_kg.tar.zst This will output a nodes.jsonl and edges.jsonl file

Build a graph from JSONL

from gandalf import build_graph_from_jsonl

# Build with ontology filtering
graph = build_graph_from_jsonl(
    edges_path="data/raw/edges.jsonl",
    nodes_path="data/raw/nodes.jsonl",
    excluded_predicates={'biolink:subclass_of'}
)

# Save for fast loading
graph.save("data/processed/graph_filtered.pkl")

Query paths

from gandalf import CSRGraph, find_paths

# Load graph (takes ~1-2 seconds)
graph = CSRGraph.load("data/processed/graph.pkl")

# Find paths
paths = find_paths(
    graph,
    start_id="CHEBI:45783",
    end_id="MONDO:0004979"
)

print(f"Found {len(paths)} paths")

Filter by predicates

from gandalf import find_paths_filtered

# Only mechanistic relationships
paths = find_paths_filtered(
    graph,
    start_id="CHEBI:45783",
    end_id="MONDO:0004979",
    allowed_predicates={
        'biolink:treats',
        'biolink:affects',
        'biolink:has_metabolite'
    }
)

Architecture

The package uses a three-stage pipeline:

  1. Topology Search (fast) - Find all paths using indices only
  2. Filtering (medium) - Apply business logic on necessary node or edge properties
  3. Enrichment (batch) - Load all properties for final paths only

This separation allows filtering millions of paths before expensive property lookups.

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

gandalf_csr-0.1.5.tar.gz (89.8 kB view details)

Uploaded Source

Built Distribution

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

gandalf_csr-0.1.5-py3-none-any.whl (92.8 kB view details)

Uploaded Python 3

File details

Details for the file gandalf_csr-0.1.5.tar.gz.

File metadata

  • Download URL: gandalf_csr-0.1.5.tar.gz
  • Upload date:
  • Size: 89.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for gandalf_csr-0.1.5.tar.gz
Algorithm Hash digest
SHA256 d4bd4741caf13eaad35ecf5545582fdd8c3a5f3837dda2e8f0d460a50ea0bedc
MD5 5a43d75991a56fd26eba7061366a5767
BLAKE2b-256 158a58bea4f3324318f2640164e72f105a26a213272af5656d991ae9798e5294

See more details on using hashes here.

File details

Details for the file gandalf_csr-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: gandalf_csr-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 92.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for gandalf_csr-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 234c89dbf065b6f3ce67b2c0d4e83d844470acbd1aa13adb741b9448e9388fb6
MD5 e28827bc0bfe35dcfe0e55205b284e6e
BLAKE2b-256 422fa20d3f1a0483e9e1991d9b46c4df736dfa7b9e232a9a56fc72c7819b1981

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