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.2.1.tar.gz (27.1 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.2.1-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xileh-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e164e2b930a11da08426fc2321258f9e90391754a50dad5b9b5aab78df596ee3
MD5 35ce06d7ceb5b7b3f81555701c90497a
BLAKE2b-256 a45842bcb7ac64528249264d217c3f55578dd0bc347e507b3b5e0812bcc62896

See more details on using hashes here.

Provenance

The following attestation bundles were made for xileh-0.2.1.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.2.1-py3-none-any.whl.

File metadata

  • Download URL: xileh-0.2.1-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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 10f3075d55b848b740d0e71baa9c12b973b0de6971a5a5dc7d015f2edeafab26
MD5 dc9f4ea41d18a5b362b16b2138dd52dc
BLAKE2b-256 49916b0707c68b2d83de83f1b8983f09a3fea38ddf558571aa7355046c61ae50

See more details on using hashes here.

Provenance

The following attestation bundles were made for xileh-0.2.1-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