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.2.tar.gz (9.0 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.2-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sunra_client-0.1.2.tar.gz
  • Upload date:
  • Size: 9.0 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.2.tar.gz
Algorithm Hash digest
SHA256 ece06ca923bb23d2532656127bdc1dcd4d0895f58cc84431571c5d8281baa97a
MD5 f67f2a8ad66a62a3387b4b9545414f21
BLAKE2b-256 719dd58673dcd0d7bd52795878631e156205295b3b95882dda142d090e40d47c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sunra_client-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9dccb6eb0482f6d411d4cbc16532d80a3cfaeab2d8c91bb0fec9bc5e6a92fa51
MD5 fd30c99ec760a99dc439e03aabe964c2
BLAKE2b-256 71bfba57d23a24b5ad366616a1b267d310106dff6b6199bb2affea871fd7547d

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