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 | 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.7.0.tar.gz (26.1 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.7.0-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bailo-3.7.0.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for bailo-3.7.0.tar.gz
Algorithm Hash digest
SHA256 6e09d6a76b94be0d296a488256e87e9e874ed6707880972782c08ca15c3cc2c1
MD5 a7aca349c4903602678cf789e3294a1b
BLAKE2b-256 e624eb53b8e40d60d56ce54449f4b70925ac66aa8aa0474d2d539de0f97dc82e

See more details on using hashes here.

Provenance

The following attestation bundles were made for bailo-3.7.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.7.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for bailo-3.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2639406ff01dc84593389c6458d82bf64c78d1eb7642ada03c2fce68c4dee0f
MD5 f002a2f7ef55e0d953490c5f4ddc4380
BLAKE2b-256 bf5518874d3270e52cb2466ec550085e8d601cc9e4689b642491dc142c842ff4

See more details on using hashes here.

Provenance

The following attestation bundles were made for bailo-3.7.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