Skip to main content

Simplifies interacting with Bailo programmatically

Project description

Bailo Python Client

PyPI - Python Version PyPI - Version License Contributor Covenant

A lightweight, Python API wrapper for Bailo, providing streamlined programmatic access to its core functionality - designed for Data Scientists, ML Engineers, and Developers who need to integrate Bailo capabilities directly into their workflows.


Table of Contents
  1. Quickstart
  2. Documentation
  3. Development

Quickstart

Requires: Python 3.10 to 3.14

Installation

pip install bailo

Optional: enable integration with MLFlow for advanced model tracking:

pip install bailo[mlflow]

Basic Usage

from bailo import Client, Model

# Connect to Bailo server
client = Client("http://localhost:8080")

# Create a model
yolo = Model.create(
    client=client,
    name="YoloV4",
    description="You only look once!"
)

# Populate datacard using a predefined schema
yolo.card_from_schema("minimal-general-v10")

# Create a new release
my_release = yolo.create_release(
    version="0.1.0",
    notes="Beta"
)

# Upload a binary file to the release
with open("yolo.onnx") as f:
    my_release.upload("yolo", f)

Core Features

  • Upload and download model binaries
  • Manage Models & Releases
  • Handle Datacards & Schemas
  • Manage Schemas
  • Process Access Requests

Note: Certain collaborative actions (approvals, review threads, etc.) are best handled via the Bailo web interface.

Documentation

Full Python client documentation: Bailo Python Docs.

Building locally

Refer to backend/docs/README.md for local build steps.

Development

The following steps are only required for users who wish to extend or develop the Bailo Python client locally.

Python Setup

From within the lib/python directory:

python3 -m venv libpythonvenv
source libpythonvenv/bin/activate
pip install -e .[test]

Running Tests

To run the unit tests:

pytest

To run the integration tests (requires Bailo running on https://localhost:8080):

pytest -m integration

To run the mlflow integration tests (requires Bailo running on https://localhost:8080 and mlflow running on https://localhost:5050 e.g. via docker):

docker run -p 5050:5000 \
    "ghcr.io/mlflow/mlflow:v$(python -m pip show mlflow-skinny | awk '/Version:/ {print $2}')" \
    mlflow server --host 0.0.0.0 --port 5000

pytest -m mlflow

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

bailo-3.8.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.

bailo-3.8.0-py3-none-any.whl (33.1 kB view details)

Uploaded Python 3

File details

Details for the file bailo-3.8.0.tar.gz.

File metadata

  • Download URL: bailo-3.8.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 bailo-3.8.0.tar.gz
Algorithm Hash digest
SHA256 9d4333abf107f85953cb5a61640384e90b7d71cfed40736a7dc98233fe073157
MD5 16721c0e929724e0b70818cf3df294a4
BLAKE2b-256 c47d3fdbe626d22f24a132b973de0d5b307719f43852a942395ef6c7e70d935c

See more details on using hashes here.

Provenance

The following attestation bundles were made for bailo-3.8.0.tar.gz:

Publisher: python-publish.yml on gchq/Bailo

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

File details

Details for the file bailo-3.8.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for bailo-3.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a0663cc700b7ed42d398e43463e16f06297e4458ec05c257385bb56463571367
MD5 4be1f4e3d83dbfc978a8b63eaa8bb026
BLAKE2b-256 fdf7166db1d439c6dcc908e156ee54add6abdd73d6d61f914ea8ffda913c1fc2

See more details on using hashes here.

Provenance

The following attestation bundles were made for bailo-3.8.0-py3-none-any.whl:

Publisher: python-publish.yml on gchq/Bailo

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