Skip to main content

A lightweight, composable pipeline abstraction built around a hierarchical data container.

Project description

xileh

CI codecov Tests Python

A lightweight, composable pipeline abstraction built around a hierarchical data container.

xileh_gif

Overview

xileh abstracts complex processing pipelines, motivated by sklearn.Pipeline but with data capacities going beyond a feature matrix X and target y. It is built from two components:

  • xData — a hierarchical container holding data, a header (description / control flags), and meta information. It can nest other xData objects to pass multiple data entities through a pipeline.
  • xPipeline — an ordered set of plain Python functions, each taking and returning an xData object.

schematic

Why build something new?

Placing libraries on two axes — built-in functionality and specificity / restrictionsxileh deliberately aims for minimal built-in functionality and maximal freedom of customization.

func_spec_landscape

sklearn.Pipeline is great for ML pipelines but specific about data shape and the fit/transform contract. Config-driven tools like hydra provide a single source of truth but impose a format that can hinder rapid prototyping. xileh instead:

  • imposes as few restrictions on your workflow as possible (arbitrary data objects and plain Python functions),
  • integrates easily with a function-based workflow during development,
  • provides a single source of truth for the processing,
  • enables reuse of whole pipelines by strongly motivating composition.

Installation

pip install xileh

The bare install is lite (numpy only). Optional data backends are available as extras:

pip install xileh[pandas]   # pandas DataFrame/Series save & load (parquet)
pip install xileh[polars]   # polars DataFrame/Series save & load (parquet)

Saving or loading a container that holds a backend-specific type without the corresponding extra installed raises an error pointing at the extra to install.

Or from source:

git clone git@github.com:matthiasdold/xileh.git
cd xileh
pip install -e .

xileh targets Python 3.11+.

Quick example

from xileh import xData, xPipeline


def add_ones(pdata, name="ones", size=3):
    pdata.add([1] * size, name=name)
    return pdata


pl = xPipeline("demo")
pl.add_steps(("add_ones", add_ones))

root = xData([], name="root")
pl.eval(root)

The container was renamed from xPData to xData; xPData remains available as a backwards-compatible alias.

Documentation

Full documentation, including a quick-start guide, worked examples, and the API reference, is available at matthiasdold.github.io/xileh.

License

MIT

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

xileh-0.3.0.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

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

xileh-0.3.0-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

Details for the file xileh-0.3.0.tar.gz.

File metadata

  • Download URL: xileh-0.3.0.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for xileh-0.3.0.tar.gz
Algorithm Hash digest
SHA256 76de89e09fcf942ad332bccd474db9c968e780a4e9eeeed2b4cd6bf6fe50c0f6
MD5 961a845ed20c566d2b01c10328a3ea87
BLAKE2b-256 738906541392d8836d59b66872363bea884fb5924fb36c42739cbb37e6115162

See more details on using hashes here.

Provenance

The following attestation bundles were made for xileh-0.3.0.tar.gz:

Publisher: publish-pypi.yml on matthiasdold/xileh

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xileh-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: xileh-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 22.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for xileh-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d22118f9855ae8cf2141d286c187b6720a08d7bfd68d6b1ba86ea94a54bd4903
MD5 479e1576542fe6358f17055b9f6431fa
BLAKE2b-256 bf896a7f09463dc4c2bb7720ef3c6002042067998ea08916c9fd904550c25ba1

See more details on using hashes here.

Provenance

The following attestation bundles were made for xileh-0.3.0-py3-none-any.whl:

Publisher: publish-pypi.yml on matthiasdold/xileh

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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