Skip to main content

Python client for modelrunner.ai

Project description

modelrunner.ai Python client

This is a Python client library for interacting with ML models deployed on modelrunner.ai.

Getting started

To install the client, run:

pip install modelrunner-ai

To use the client, you need to have an API key. You can get one by signing up at modelrunner.ai. Once you have it, set it as an environment variable:

export MODELRUNNER_KEY=your-api-key

Now you can use the client to interact with your models. Here's an example of how to use it:

import asyncio
import modelrunner_ai

async def main():
    response = await modelrunner_ai.submit_async("bytedance/sdxl-lightning-4step", arguments={"prompt": "two friends cooking together"})

    logs_index = 0
    async for event in response.iter_events(with_logs=True):
        if isinstance(event, modelrunner_ai.Queued):
            print("Queued. Position:", event.position)
        elif isinstance(event, (modelrunner_ai.InProgress, modelrunner_ai.Completed)):
            new_logs = event.logs[logs_index:]
            for log in new_logs:
                print(log["message"])
            logs_index = len(event.logs)

    result = await response.get()
    print(result["output"])


asyncio.run(main())

Uploading files

If the model requires files as input, you can upload them directly to media.modelrunner.ai (our CDN) and pass the URLs to the client. Here's an example:

import modelrunner_ai

input_image = modelrunner_ai.upload_file("./image.jpg")
print(input_image)
response = modelrunner_ai.run("swook/inspyrenet", arguments={"image_path": input_image})
print(response["output"])

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

modelrunner_ai-0.1.0.tar.gz (132.8 kB view details)

Uploaded Source

Built Distribution

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

modelrunner_ai-0.1.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file modelrunner_ai-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for modelrunner_ai-0.1.0.tar.gz
Algorithm Hash digest
SHA256 510bb3d9645986f9153c15d19550cddb9ea74b59838e16f83172a0002efddfdb
MD5 e1f65ada10bfb6719865243d565e9d13
BLAKE2b-256 133912f2409675e34d81127d82f670999eeb74acd5f9b87a8ef0b959dfa7279a

See more details on using hashes here.

Provenance

The following attestation bundles were made for modelrunner_ai-0.1.0.tar.gz:

Publisher: release.yaml on modelrunner/modelrunner

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

File details

Details for the file modelrunner_ai-0.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for modelrunner_ai-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ed6660876395ded602e7bcfaae01709e4d594113733726f0f6cec9704515b00
MD5 f5756117a69e516a260487df63910069
BLAKE2b-256 d02093a1390028ea24d626636d277f4b8ad8deff81b53b8e4ae15f98be26ed2d

See more details on using hashes here.

Provenance

The following attestation bundles were made for modelrunner_ai-0.1.0-py3-none-any.whl:

Publisher: release.yaml on modelrunner/modelrunner

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