Skip to main content

Python client for sunra.ai

Project description

sunra.ai Python client

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

Getting started

To install the client, run:

pip install sunra-client

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

export SUNRA_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 sunra_client

response = sunra_client.subscribe("sunra/lcm/text-to-image", arguments={"prompt": "a cute cat, realistic, orange"})
print(response["images"][0]["url"])

streaming responses

import sunra_client

application = "sunra/lcm/text-to-image"
arguments={"prompt": "a cute cat, realistic, orange"}

for event in sunra_client.stream(application, arguments):
    print(f"Received event: {event}")

Asynchronous requests

The client also supports asynchronous requests out of the box. Here's an example:

import asyncio
import sunra_client

async def main():
    response = await sunra_client.subscribe_async("sunra/lcm/text-to-image", arguments={"prompt": "a cute cat, realistic, orange"})
    print(response["images"][0]["url"])


asyncio.run(main())

Queuing requests

When you want to send a request and keep receiving updates on its status, you can use the submit method. Here's an example:

import asyncio
import sunra_client

async def main():
    response = await sunra_client.submit_async("sunra/lcm/text-to-image", arguments={"prompt": "a cute cat, realistic, orange"})

    logs_index = 0
    async for event in response.iter_events():
        if isinstance(event, sunra_client.Queued):
            print("Queued. Position:", event.position)
        elif isinstance(event, (sunra_client.InProgress, sunra_client.Completed)):
            print(event)

    result = await response.get()
    print(result["images"][0]["url"])


asyncio.run(main())

Credits

This project is derived from

and adapted to work with sunra.ai. The original project is licensed under the MIT/Apache2.0 License. We extend our gratitude to the original authors for their contributions.

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

sunra_client-0.1.1.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

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

sunra_client-0.1.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file sunra_client-0.1.1.tar.gz.

File metadata

  • Download URL: sunra_client-0.1.1.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for sunra_client-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0edff1436fb3e1c4bfed4b973aafe76a3a5a9eaa383c419fb5da9959a06dc3c7
MD5 7a0ed2c98662eed6a3a52c4b7ab49cbc
BLAKE2b-256 881690ddeeeff3faf6b515474e66285ca5c396fd34248f682609601c3881653e

See more details on using hashes here.

File details

Details for the file sunra_client-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: sunra_client-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for sunra_client-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aa5cb22c83bfa1286cf5109906eb8d10c65285e6fd843450576c01293bcd1552
MD5 6465af2968217922c72666b4c4a3851e
BLAKE2b-256 22444034771e3748c221a9613e766e8daf946b8c4ea0f35f93649ad8a2b90e0f

See more details on using hashes here.

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