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("replicate/hello-world")
>>> model.predict(text="python")
"hello python"
>>> model = replicate.models.get("replicate/resnet")
>>> model.predict(image=open("mystery.jpg", "rb"))
[['n02123597', 'Siamese_cat', 0.8829364776611328],
['n02123394', 'Persian_cat', 0.09810526669025421],
['n02123045', 'tabby', 0.005758069921284914]]
You can run a model and feed the output into another model:
>>> image = replicate.models.get("afiaka87/laionide-v4").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=model.versions.list()[0],
... input={"prompt":"Watercolor painting of an underwater submarine"})
>>> prediction
Prediction(...)
>>> prediction.status
'starting'
>>> dict(prediction)
{"id": "...", "status": "starting", ...}
>>> prediction.reload()
>>> prediction.status
'processing'
>>> print(prediction.logs)
iteration: 0, render:loss: -0.6171875
iteration: 10, render:loss: -0.92236328125
iteration: 20, render:loss: -1.197265625
iteration: 30, render:loss: -1.3994140625
>>> prediction.wait()
>>> prediction.status
'succeeded'
>>> prediction.output
'https://.../output.png'
You can list all the predictions you've run:
>>> replicate.predictions.list()
[<Prediction: 8b0ba5ab4d85>, <Prediction: 494900564e8c>]
Install
pip install replicate
Authentication
Set the REPLICATE_API_TOKEN environment variable to your API token.
Development
To install in development:
pip install -e .
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.1a6.tar.gz
(10.6 kB
view details)
File details
Details for the file replicate-0.0.1a6.tar.gz.
File metadata
- Download URL: replicate-0.0.1a6.tar.gz
- Upload date:
- Size: 10.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b4d0503f511738f43435b79d36958f429919fc83cb65b8c0aec58ffc4346d2b3 |
|
| MD5 | d1bc0027f3673634f25aa91587df1087 |
|
| BLAKE2b-256 | bba0c70f744eb20c25467fbf66199569064820e413fe31b2c323ba725e383dac |
