Skip to main content

Python client for Replicate

Project description

Replicate Python client

This is a Python client for Replicate. It lets you run models from your Python code or Jupyter notebook, and do various other things on Replicate.

You can run a model and get its output:

>>> import replicate

>>> model = replicate.models.get("bfirsh/resnet")
>>> model.predict(input=open("mystery.jpg"))
[('n02123597', 'Siamese_cat', 0.88293666), ('n02123394', 'Persian_cat', 0.09810519), ('n02123045', 'tabby', 0.0057580653)]

You can run a model and feed the output into another model:

>>> image = replicate.models.get("afiaka87/clip-guided-diffusion".predict(prompt="avocado armchair")
>>> upscaled_image = replicate.models.get("jingyunliang/swinir").predict(image=image)

Run a model and get its output while it's running:

model = replicate.models.get("pixray/text2image")
for image in model.predict(prompt="san francisco sunset"):
    display(image)

You can start a model and run it in the background:

>>> model = replicate.models.get("kvfrans/clipdraw")
>>> prediction = replicate.predictions.create(
...    version=models.versions.list()[0],
...    input={"prompt":"Watercolor painting of an underwater submarine"})

>>> prediction
<Prediction 38a73e57ddb9 on kvfrans/clipdraw:8b0ba5ab4d85>

>>> prediction.status
Prediction.STATUS_RUNNING

>>> prediction.logs
["something happened"]

>>> dict(prediction)
{"id": "...", "status": "running", ...}

>>> prediction.reload()
>>> prediction.logs
["something happened", "another thing happened"]

>>> prediction.wait()

>>> prediction.status
Prediction.STATUS_SUCCESSFUL

>>> prediction.output
<file: output.png>

You can list all the predictions you've run:

>>> replicate.predictions.list()
[<Prediction: 8b0ba5ab4d85>, <Prediction: 494900564e8c>]

Install

pip install -e .

Authentication

Set the REPLICATE_API_TOKEN environment variable to your API token.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

replicate-0.0.1a2.tar.gz (6.3 kB view details)

Uploaded Source

File details

Details for the file replicate-0.0.1a2.tar.gz.

File metadata

  • Download URL: replicate-0.0.1a2.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for replicate-0.0.1a2.tar.gz
Algorithm Hash digest
SHA256 69989edd2a815c09f1b265103a7bc37442844b325ad0f31135a37316860c52ad
MD5 cf8684b5372706de1690bbd7887a9738
BLAKE2b-256 3edba1a111c7000cf2087c351ee53a4c71126a7e5691962c05f983c0e7fa67e1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page