ipc-frontier-py 0.1.5

Benchmarks comparing Python concurrency models--threads, Queue-based multiprocessing, and SharedMemory-based multiprocessing--for moving and processing NumPy arrays.

ipc-frontier-py

---

ipc-frontier-py implements benchmarks comparing Python concurrency models--threads, Queue-based multiprocessing, and SharedMemory-based multiprocessing--for moving and processing NumPy arrays. The benchmarks highlight throughput, latency, and IPC overheads relevant to ML/AI data pipelines and performance-sensitive Python applications.

TODO

Development 🛠️

This section contains info about developing the ipc_frontier Python package itself.

First time working on the project? Run make install-tools then make setup.

Requirements

Supported on Linux and macOS.

Contributing Code

See CONTRIBUTING.md for the pull request process used to introduce code changes.

Releases

See RELEASE.md for a description of the GitHub pipeline that builds and publishes new versions of the ipc_frontier package.

Tooling

The ipc-frontier-py project uses Pyenv for Python version management and Poetry for package management, environment management, and builds.

The ipc-frontier-py project uses Make to automate common development operations and workflows. Run make help or see the Makefile in the root of the repository for a full list of the available targets. See the "Make Targets" section below for guidance using selected targets.

Make Targets

This section describes how and when to use the automated procedures for common development tasks.

install-tools

make install-tools

Installs the tools required to run other targets. Tools include Pyenv and Poetry. This target only needs to be run once per user.

setup

make setup

Creates an isolated execution environment to run the project. This target installs the required version of Python using Pyenv and creates a virtual environment using Poetry with the required dependencies plus the ipc_frontier package itself installed.

fmt

make fmt

Autoformats the entire codebase in compliance with the project's style standards. All formatting is handled by Ruff in a way that mimics the combination of Black + autopep8 + isort.

test

make test

Executes type checks and runs the suite of unit tests. Pyright is used for type checking, and pytest is used as the unit test framework.

clean

make clean

Deletes build/test/coverage artifacts, including .pytest_cache/, .mypy_cache/, and .ruff_cache/.