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.9.tar.gz (93.5 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.9-py3-none-any.whl (103.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gandalf_csr-0.1.9.tar.gz
  • Upload date:
  • Size: 93.5 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.9.tar.gz
Algorithm Hash digest
SHA256 3aad44e59240d9e340db8505a86894cf32131f14f4a4f3f991256ee67cb03ec7
MD5 bfd3c4d65938909c956fbf773743391a
BLAKE2b-256 12da8c0ec3675d949e3ad6356559019b2cc5cf0b883a1907a99d4363b3ab67af

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gandalf_csr-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 103.5 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 b9b9c9c20a66ebdf26384a0dd8de6527991bd729d7943e076500edd330a3acdb
MD5 d9f1214f419db8cfbedf69ed97a5845f
BLAKE2b-256 719a8ac47d72efecc65600d73d4e356f236b24ecdd2df53db9c6cd02efe63a7e

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