Skip to main content

Graph-based corpus engine for annotated text with efficient traversal and search

Project description

Context Fabric

Context-Fabric

A graph-based corpus engine for annotated text with efficient traversal and search.

Overview

Context-Fabric provides a powerful data model for working with annotated text corpora as graphs. It enables efficient navigation, feature lookup, and pattern-based search across large textual datasets.

Forked from Dirk Roorda's Text-Fabric.

Installation

pip install context-fabric

Quick Start

from cfabric.core import Fabric

# Load a dataset
CF = Fabric(locations='path/to/data')
api = CF.load('feature1 feature2')

# Navigate nodes
for node in api.N():
    print(api.F.feature1.v(node))

# Use locality
embedders = api.L.u(node)
embedded = api.L.d(node)

Core API

  • N (Nodes) - Walk through nodes in canonical order
  • F (Features) - Access node feature values
  • E (Edges) - Access edge feature values
  • L (Locality) - Navigate between related nodes
  • T (Text) - Retrieve text representations
  • S (Search) - Search using templates

Performance

Context-Fabric uses memory-mapped numpy arrays for dramatically faster loading and reduced memory consumption compared to Text-Fabric's pickle-based caching.

Benchmarks (BHSA Hebrew Bible corpus — 1.4M nodes, 109 features)

Metric Text-Fabric Context-Fabric Improvement
Load Time 7.9s 0.7s 11x faster
Memory Usage 6.3 GB 305 MB 95% reduction
Compile Time 8s 91s one-time cost
Cache Size 138 MB 859 MB 6x larger

Performance Comparison

The key insight: compilation happens once, loading happens every session. Context-Fabric trades one-time compile cost for dramatic runtime efficiency:

  • Memory-mapped arrays: Data stays on disk, accessed on-demand
  • Efficient sparse iteration: Uses numpy vectorized operations instead of Python loops
  • Cached materialization: Dictionary views computed once per session

Parallel Worker Scaling

Memory-mapped arrays enable efficient parallel processing. Multiple workers share the same mmap'd data instead of each loading a full copy into RAM.

Spawn mode (cold start — each worker loads independently):

Metric Text-Fabric Context-Fabric Savings
Total (4 workers) 7.7 GB 1.3 GB 84% less
Per worker 1.9 GB 315 MB 6x less

Fork mode (API scenario — pre-load then fork workers):

Metric Text-Fabric Context-Fabric Savings
Total (4 workers) 6.3 GB 398 MB 94% less
Per worker 1.6 GB 99 MB 16x less

Memory measured as total RSS after loading from cache on BHSA corpus.

Run the benchmark yourself:

python benchmarks/compare_performance.py --source path/to/tf/data --workers 4

Testing

See TESTING.md for how to run tests.

Authors

  • Cody Kingham
  • Dirk Roorda

License

MIT License - see LICENSE for details.

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

context_fabric-0.5.1.tar.gz (139.2 kB view details)

Uploaded Source

Built Distribution

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

context_fabric-0.5.1-py3-none-any.whl (157.2 kB view details)

Uploaded Python 3

File details

Details for the file context_fabric-0.5.1.tar.gz.

File metadata

  • Download URL: context_fabric-0.5.1.tar.gz
  • Upload date:
  • Size: 139.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for context_fabric-0.5.1.tar.gz
Algorithm Hash digest
SHA256 7ca7852218ecffeaf7a0e23a702ff7e504ba0252b0c119fc9bcad800951aa8f1
MD5 00ed1f376cc3abeed34aa996bb103ce5
BLAKE2b-256 99d46e80b28f5cfd6cfea622a4bfb21db55cdec44f705d5d3f6d443a3125e1ab

See more details on using hashes here.

File details

Details for the file context_fabric-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: context_fabric-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 157.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for context_fabric-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bc1360a0221f8419fd2ac0f1f9d8acc9084c3e914a442cb7f20bcd9f857b93b4
MD5 3ecde378d6cf0159616150a64db90a8f
BLAKE2b-256 12ab2954eb057bea3d398989749f3ba2a932e20323f1ee49516da45aa83a7386

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