| Name | replicate JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | Python client for Replicate |
| upload_time | 2024-11-25 12:36:49 |
| maintainer | None |
| docs_url | None |
| author | Replicate, Inc. |
| requires_python | >=3.8 |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2022, Replicate, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Replicate Python client
This is a Python client for [Replicate](https://replicate.com). It lets you run models from your Python code or Jupyter notebook, and do various other things on Replicate.
## Breaking Changes in 1.0.0
The 1.0.0 release contains breaking changes:
- The `replicate.run()` method now returns `FileOutput`s instead of URL strings by default for models that output files. `FileOutput` implements an iterable interface similar to `httpx.Response`, making it easier to work with files efficiently.
To revert to the previous behavior, you can opt out of `FileOutput` by passing `use_file_output=False` to `replicate.run()`:
```python
output = replicate.run("acmecorp/acme-model", use_file_output=False)
```
In most cases, updating existing applications to call `output.url` should resolve any issues. But we recommend using the `FileOutput` objects directly as we have further improvements planned to this API and this approach is guaranteed to give the fastest results.
> [!TIP]
> **đź‘‹** Check out an interactive version of this tutorial on [Google Colab](https://colab.research.google.com/drive/1K91q4p-OhL96FHBAVLsv9FlwFdu6Pn3c).
>
> [](https://colab.research.google.com/drive/1K91q4p-OhL96FHBAVLsv9FlwFdu6Pn3c)
## Requirements
- Python 3.8+
## Install
```sh
pip install replicate
```
## Authenticate
Before running any Python scripts that use the API, you need to set your Replicate API token in your environment.
Grab your token from [replicate.com/account](https://replicate.com/account) and set it as an environment variable:
```
export REPLICATE_API_TOKEN=<your token>
```
We recommend not adding the token directly to your source code, because you don't want to put your credentials in source control. If anyone used your API key, their usage would be charged to your account.
## Run a model
Create a new Python file and add the following code, replacing the model identifier and input with your own:
```python
>>> import replicate
>>> outputs = replicate.run(
"black-forest-labs/flux-schnell",
input={"prompt": "astronaut riding a rocket like a horse"}
)
[<replicate.helpers.FileOutput object at 0x107179b50>]
>>> for index, output in enumerate(outputs):
with open(f"output_{index}.webp", "wb") as file:
file.write(output.read())
```
`replicate.run` raises `ModelError` if the prediction fails.
You can access the exception's `prediction` property
to get more information about the failure.
```python
import replicate
from replicate.exceptions import ModelError
try:
output = replicate.run("stability-ai/stable-diffusion-3", { "prompt": "An astronaut riding a rainbow unicorn" })
except ModelError as e
if "(some known issue)" in e.prediction.logs:
pass
print("Failed prediction: " + e.prediction.id)
```
> [!NOTE]
> By default the Replicate client will hold the connection open for up to 60 seconds while waiting
> for the prediction to complete. This is designed to optimize getting the model output back to the
> client as quickly as possible.
>
> The timeout can be configured by passing `wait=x` to `replicate.run()` where `x` is a timeout
> in seconds between 1 and 60. To disable the sync mode you can pass `wait=False`.
## AsyncIO support
You can also use the Replicate client asynchronously by prepending `async_` to the method name.
Here's an example of how to run several predictions concurrently and wait for them all to complete:
```python
import asyncio
import replicate
# https://replicate.com/stability-ai/sdxl
model_version = "stability-ai/sdxl:39ed52f2a78e934b3ba6e2a89f5b1c712de7dfea535525255b1aa35c5565e08b"
prompts = [
f"A chariot pulled by a team of {count} rainbow unicorns"
for count in ["two", "four", "six", "eight"]
]
async with asyncio.TaskGroup() as tg:
tasks = [
tg.create_task(replicate.async_run(model_version, input={"prompt": prompt}))
for prompt in prompts
]
results = await asyncio.gather(*tasks)
print(results)
```
To run a model that takes a file input you can pass either
a URL to a publicly accessible file on the Internet
or a handle to a file on your local device.
```python
>>> output = replicate.run(
"andreasjansson/blip-2:f677695e5e89f8b236e52ecd1d3f01beb44c34606419bcc19345e046d8f786f9",
input={ "image": open("path/to/mystery.jpg") }
)
"an astronaut riding a horse"
```
## Run a model and stream its output
Replicate’s API supports server-sent event streams (SSEs) for language models.
Use the `stream` method to consume tokens as they're produced by the model.
```python
import replicate
for event in replicate.stream(
"meta/meta-llama-3-70b-instruct",
input={
"prompt": "Please write a haiku about llamas.",
},
):
print(str(event), end="")
```
> [!TIP]
> Some models, like [meta/meta-llama-3-70b-instruct](https://replicate.com/meta/meta-llama-3-70b-instruct),
> don't require a version string.
> You can always refer to the API documentation on the model page for specifics.
You can also stream the output of a prediction you create.
This is helpful when you want the ID of the prediction separate from its output.
```python
prediction = replicate.predictions.create(
model="meta/meta-llama-3-70b-instruct"
input={"prompt": "Please write a haiku about llamas."},
stream=True,
)
for event in prediction.stream():
print(str(event), end="")
```
For more information, see
["Streaming output"](https://replicate.com/docs/streaming) in Replicate's docs.
## Run a model in the background
You can start a model and run it in the background using async mode:
```python
>>> model = replicate.models.get("kvfrans/clipdraw")
>>> version = model.versions.get("5797a99edc939ea0e9242d5e8c9cb3bc7d125b1eac21bda852e5cb79ede2cd9b")
>>> prediction = replicate.predictions.create(
version=version,
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
<replicate.helpers.FileOutput object at 0x107179b50>
>>> with open("output.png", "wb") as file:
file.write(prediction.output.read())
```
## Run a model in the background and get a webhook
You can run a model and get a webhook when it completes, instead of waiting for it to finish:
```python
model = replicate.models.get("ai-forever/kandinsky-2.2")
version = model.versions.get("ea1addaab376f4dc227f5368bbd8eff901820fd1cc14ed8cad63b29249e9d463")
prediction = replicate.predictions.create(
version=version,
input={"prompt":"Watercolor painting of an underwater submarine"},
webhook="https://example.com/your-webhook",
webhook_events_filter=["completed"]
)
```
For details on receiving webhooks, see [replicate.com/docs/webhooks](https://replicate.com/docs/webhooks).
## Compose models into a pipeline
You can run a model and feed the output into another model:
```python
laionide = replicate.models.get("afiaka87/laionide-v4").versions.get("b21cbe271e65c1718f2999b038c18b45e21e4fba961181fbfae9342fc53b9e05")
swinir = replicate.models.get("jingyunliang/swinir").versions.get("660d922d33153019e8c263a3bba265de882e7f4f70396546b6c9c8f9d47a021a")
image = laionide.predict(prompt="avocado armchair")
upscaled_image = swinir.predict(image=image)
```
## Get output from a running model
Run a model and get its output while it's running:
```python
iterator = replicate.run(
"pixray/text2image:5c347a4bfa1d4523a58ae614c2194e15f2ae682b57e3797a5bb468920aa70ebf",
input={"prompts": "san francisco sunset"}
)
for index, image in enumerate(iterator):
with open(f"file_{index}.png", "wb") as file:
file.write(image.read())
```
## Cancel a prediction
You can cancel a running prediction:
```python
>>> model = replicate.models.get("kvfrans/clipdraw")
>>> version = model.versions.get("5797a99edc939ea0e9242d5e8c9cb3bc7d125b1eac21bda852e5cb79ede2cd9b")
>>> prediction = replicate.predictions.create(
version=version,
input={"prompt":"Watercolor painting of an underwater submarine"}
)
>>> prediction.status
'starting'
>>> prediction.cancel()
>>> prediction.reload()
>>> prediction.status
'canceled'
```
## List predictions
You can list all the predictions you've run:
```python
replicate.predictions.list()
# [<Prediction: 8b0ba5ab4d85>, <Prediction: 494900564e8c>]
```
Lists of predictions are paginated. You can get the next page of predictions by passing the `next` property as an argument to the `list` method:
```python
page1 = replicate.predictions.list()
if page1.next:
page2 = replicate.predictions.list(page1.next)
```
## Load output files
Output files are returned as `FileOutput` objects:
```python
import replicate
from PIL import Image # pip install pillow
output = replicate.run(
"stability-ai/stable-diffusion:27b93a2413e7f36cd83da926f3656280b2931564ff050bf9575f1fdf9bcd7478",
input={"prompt": "wavy colorful abstract patterns, oceans"}
)
# This has a .read() method that returns the binary data.
with open("my_output.png", "wb") as file:
file.write(output[0].read())
# It also implements the iterator protocol to stream the data.
background = Image.open(output[0])
```
### FileOutput
Is a [file-like](https://docs.python.org/3/glossary.html#term-file-object) object returned from the `replicate.run()` method that makes it easier to work with models that output files. It implements `Iterator` and `AsyncIterator` for reading the file data in chunks as well as `read()` and `aread()` to read the entire file into memory.
> [!NOTE]
> It is worth noting that at this time `read()` and `aread()` do not currently accept a `size` argument to read up to `size` bytes.
Lastly, the URL of the underlying data source is available on the `url` attribute though we recommend you use the object as an iterator or use its `read()` or `aread()` methods, as the `url` property may not always return HTTP URLs in future.
```python
print(output.url) #=> "data:image/png;base64,xyz123..." or "https://delivery.replicate.com/..."
```
To consume the file directly:
```python
with open('output.bin', 'wb') as file:
file.write(output.read())
```
Or for very large files they can be streamed:
```python
with open(file_path, 'wb') as file:
for chunk in output:
file.write(chunk)
```
Each of these methods has an equivalent `asyncio` API.
```python
async with aiofiles.open(filename, 'w') as file:
await file.write(await output.aread())
async with aiofiles.open(filename, 'w') as file:
await for chunk in output:
await file.write(chunk)
```
For streaming responses from common frameworks, all support taking `Iterator` types:
**Django**
```python
@condition(etag_func=None)
def stream_response(request):
output = replicate.run("black-forest-labs/flux-schnell", input={...}, use_file_output =True)
return HttpResponse(output, content_type='image/webp')
```
**FastAPI**
```python
@app.get("/")
async def main():
output = replicate.run("black-forest-labs/flux-schnell", input={...}, use_file_output =True)
return StreamingResponse(output)
```
**Flask**
```python
@app.route('/stream')
def streamed_response():
output = replicate.run("black-forest-labs/flux-schnell", input={...}, use_file_output =True)
return app.response_class(stream_with_context(output))
```
You can opt out of `FileOutput` by passing `use_file_output=False` to the `replicate.run()` method.
```python
const replicate = replicate.run("acmecorp/acme-model", use_file_output=False);
```
## List models
You can list the models you've created:
```python
replicate.models.list()
```
Lists of models are paginated. You can get the next page of models by passing the `next` property as an argument to the `list` method, or you can use the `paginate` method to fetch pages automatically.
```python
# Automatic pagination using `replicate.paginate` (recommended)
models = []
for page in replicate.paginate(replicate.models.list):
models.extend(page.results)
if len(models) > 100:
break
# Manual pagination using `next` cursors
page = replicate.models.list()
while page:
models.extend(page.results)
if len(models) > 100:
break
page = replicate.models.list(page.next) if page.next else None
```
You can also find collections of featured models on Replicate:
```python
>>> collections = [collection for page in replicate.paginate(replicate.collections.list) for collection in page]
>>> collections[0].slug
"vision-models"
>>> collections[0].description
"Multimodal large language models with vision capabilities like object detection and optical character recognition (OCR)"
>>> replicate.collections.get("text-to-image").models
[<Model: stability-ai/sdxl>, ...]
```
## Create a model
You can create a model for a user or organization
with a given name, visibility, and hardware SKU:
```python
import replicate
model = replicate.models.create(
owner="your-username",
name="my-model",
visibility="public",
hardware="gpu-a40-large"
)
```
Here's how to list of all the available hardware for running models on Replicate:
```python
>>> [hw.sku for hw in replicate.hardware.list()]
['cpu', 'gpu-t4', 'gpu-a40-small', 'gpu-a40-large']
```
## Fine-tune a model
Use the [training API](https://replicate.com/docs/fine-tuning) to fine-tune models to make them better at a particular task. To see what **language models** currently support fine-tuning, check out Replicate's [collection of trainable language models](https://replicate.com/collections/trainable-language-models).
If you're looking to fine-tune **image models**, check out Replicate's [guide to fine-tuning image models](https://replicate.com/docs/guides/fine-tune-an-image-model).
Here's how to fine-tune a model on Replicate:
```python
training = replicate.trainings.create(
model="stability-ai/sdxl",
version="39ed52f2a78e934b3ba6e2a89f5b1c712de7dfea535525255b1aa35c5565e08b",
input={
"input_images": "https://my-domain/training-images.zip",
"token_string": "TOK",
"caption_prefix": "a photo of TOK",
"max_train_steps": 1000,
"use_face_detection_instead": False
},
# You need to create a model on Replicate that will be the destination for the trained version.
destination="your-username/model-name"
)
```
## Customize client behavior
The `replicate` package exports a default shared client. This client is initialized with an API token set by the `REPLICATE_API_TOKEN` environment variable.
You can create your own client instance to pass a different API token value, add custom headers to requests, or control the behavior of the underlying [HTTPX client](https://www.python-httpx.org/api/#client):
```python
import os
from replicate.client import Client
replicate = Client(
api_token=os.environ["SOME_OTHER_REPLICATE_API_TOKEN"]
headers={
"User-Agent": "my-app/1.0"
}
)
```
> [!WARNING]
> Never hardcode authentication credentials like API tokens into your code.
> Instead, pass them as environment variables when running your program.
## Development
See [CONTRIBUTING.md](CONTRIBUTING.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "replicate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Replicate, Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/77/f4/f2ef5916d1a9a1c8401210992b5e9f6f6bee50f372106ad2e25c1e4f3536/replicate-1.0.4.tar.gz",
"platform": null,
"description": "# Replicate Python client\n\nThis is a Python client for [Replicate](https://replicate.com). It lets you run models from your Python code or Jupyter notebook, and do various other things on Replicate.\n\n## Breaking Changes in 1.0.0\n\nThe 1.0.0 release contains breaking changes:\n\n- The `replicate.run()` method now returns `FileOutput`s instead of URL strings by default for models that output files. `FileOutput` implements an iterable interface similar to `httpx.Response`, making it easier to work with files efficiently.\n\nTo revert to the previous behavior, you can opt out of `FileOutput` by passing `use_file_output=False` to `replicate.run()`:\n\n```python\noutput = replicate.run(\"acmecorp/acme-model\", use_file_output=False)\n```\n\nIn most cases, updating existing applications to call `output.url` should resolve any issues. But we recommend using the `FileOutput` objects directly as we have further improvements planned to this API and this approach is guaranteed to give the fastest results.\n\n> [!TIP]\n> **\ud83d\udc4b** Check out an interactive version of this tutorial on [Google Colab](https://colab.research.google.com/drive/1K91q4p-OhL96FHBAVLsv9FlwFdu6Pn3c).\n>\n> [](https://colab.research.google.com/drive/1K91q4p-OhL96FHBAVLsv9FlwFdu6Pn3c)\n\n## Requirements\n\n- Python 3.8+\n\n## Install\n\n```sh\npip install replicate\n```\n\n## Authenticate\n\nBefore running any Python scripts that use the API, you need to set your Replicate API token in your environment.\n\nGrab your token from [replicate.com/account](https://replicate.com/account) and set it as an environment variable:\n\n```\nexport REPLICATE_API_TOKEN=<your token>\n```\n\nWe recommend not adding the token directly to your source code, because you don't want to put your credentials in source control. If anyone used your API key, their usage would be charged to your account.\n\n## Run a model\n\nCreate a new Python file and add the following code, replacing the model identifier and input with your own:\n\n```python\n>>> import replicate\n>>> outputs = replicate.run(\n \"black-forest-labs/flux-schnell\",\n input={\"prompt\": \"astronaut riding a rocket like a horse\"}\n )\n[<replicate.helpers.FileOutput object at 0x107179b50>]\n>>> for index, output in enumerate(outputs):\n with open(f\"output_{index}.webp\", \"wb\") as file:\n file.write(output.read())\n```\n\n`replicate.run` raises `ModelError` if the prediction fails.\nYou can access the exception's `prediction` property \nto get more information about the failure.\n\n```python\nimport replicate\nfrom replicate.exceptions import ModelError\n\ntry:\n output = replicate.run(\"stability-ai/stable-diffusion-3\", { \"prompt\": \"An astronaut riding a rainbow unicorn\" })\nexcept ModelError as e\n if \"(some known issue)\" in e.prediction.logs:\n pass\n\n print(\"Failed prediction: \" + e.prediction.id)\n```\n\n> [!NOTE]\n> By default the Replicate client will hold the connection open for up to 60 seconds while waiting\n> for the prediction to complete. This is designed to optimize getting the model output back to the\n> client as quickly as possible.\n>\n> The timeout can be configured by passing `wait=x` to `replicate.run()` where `x` is a timeout\n> in seconds between 1 and 60. To disable the sync mode you can pass `wait=False`.\n\n## AsyncIO support\n\nYou can also use the Replicate client asynchronously by prepending `async_` to the method name. \n\nHere's an example of how to run several predictions concurrently and wait for them all to complete:\n\n```python\nimport asyncio\nimport replicate\n \n# https://replicate.com/stability-ai/sdxl\nmodel_version = \"stability-ai/sdxl:39ed52f2a78e934b3ba6e2a89f5b1c712de7dfea535525255b1aa35c5565e08b\"\nprompts = [\n f\"A chariot pulled by a team of {count} rainbow unicorns\"\n for count in [\"two\", \"four\", \"six\", \"eight\"]\n]\n\nasync with asyncio.TaskGroup() as tg:\n tasks = [\n tg.create_task(replicate.async_run(model_version, input={\"prompt\": prompt}))\n for prompt in prompts\n ]\n\nresults = await asyncio.gather(*tasks)\nprint(results)\n```\n\nTo run a model that takes a file input you can pass either\na URL to a publicly accessible file on the Internet\nor a handle to a file on your local device.\n\n```python\n>>> output = replicate.run(\n \"andreasjansson/blip-2:f677695e5e89f8b236e52ecd1d3f01beb44c34606419bcc19345e046d8f786f9\",\n input={ \"image\": open(\"path/to/mystery.jpg\") }\n )\n\n\"an astronaut riding a horse\"\n```\n\n## Run a model and stream its output\n\nReplicate\u2019s API supports server-sent event streams (SSEs) for language models. \nUse the `stream` method to consume tokens as they're produced by the model.\n\n```python\nimport replicate\n\nfor event in replicate.stream(\n \"meta/meta-llama-3-70b-instruct\",\n input={\n \"prompt\": \"Please write a haiku about llamas.\",\n },\n):\n print(str(event), end=\"\")\n```\n\n> [!TIP]\n> Some models, like [meta/meta-llama-3-70b-instruct](https://replicate.com/meta/meta-llama-3-70b-instruct), \n> don't require a version string. \n> You can always refer to the API documentation on the model page for specifics.\n\nYou can also stream the output of a prediction you create.\nThis is helpful when you want the ID of the prediction separate from its output.\n\n```python\nprediction = replicate.predictions.create(\n model=\"meta/meta-llama-3-70b-instruct\"\n input={\"prompt\": \"Please write a haiku about llamas.\"},\n stream=True,\n)\n\nfor event in prediction.stream():\n print(str(event), end=\"\")\n```\n\nFor more information, see\n[\"Streaming output\"](https://replicate.com/docs/streaming) in Replicate's docs.\n\n\n## Run a model in the background\n\nYou can start a model and run it in the background using async mode:\n\n```python\n>>> model = replicate.models.get(\"kvfrans/clipdraw\")\n>>> version = model.versions.get(\"5797a99edc939ea0e9242d5e8c9cb3bc7d125b1eac21bda852e5cb79ede2cd9b\")\n>>> prediction = replicate.predictions.create(\n version=version,\n input={\"prompt\":\"Watercolor painting of an underwater submarine\"})\n\n>>> prediction\nPrediction(...)\n\n>>> prediction.status\n'starting'\n\n>>> dict(prediction)\n{\"id\": \"...\", \"status\": \"starting\", ...}\n\n>>> prediction.reload()\n>>> prediction.status\n'processing'\n\n>>> print(prediction.logs)\niteration: 0, render:loss: -0.6171875\niteration: 10, render:loss: -0.92236328125\niteration: 20, render:loss: -1.197265625\niteration: 30, render:loss: -1.3994140625\n\n>>> prediction.wait()\n\n>>> prediction.status\n'succeeded'\n\n>>> prediction.output\n<replicate.helpers.FileOutput object at 0x107179b50>\n\n>>> with open(\"output.png\", \"wb\") as file:\n file.write(prediction.output.read())\n```\n\n## Run a model in the background and get a webhook\n\nYou can run a model and get a webhook when it completes, instead of waiting for it to finish:\n\n```python\nmodel = replicate.models.get(\"ai-forever/kandinsky-2.2\")\nversion = model.versions.get(\"ea1addaab376f4dc227f5368bbd8eff901820fd1cc14ed8cad63b29249e9d463\")\nprediction = replicate.predictions.create(\n version=version,\n input={\"prompt\":\"Watercolor painting of an underwater submarine\"},\n webhook=\"https://example.com/your-webhook\",\n webhook_events_filter=[\"completed\"]\n)\n```\n\nFor details on receiving webhooks, see [replicate.com/docs/webhooks](https://replicate.com/docs/webhooks).\n\n## Compose models into a pipeline\n\nYou can run a model and feed the output into another model:\n\n```python\nlaionide = replicate.models.get(\"afiaka87/laionide-v4\").versions.get(\"b21cbe271e65c1718f2999b038c18b45e21e4fba961181fbfae9342fc53b9e05\")\nswinir = replicate.models.get(\"jingyunliang/swinir\").versions.get(\"660d922d33153019e8c263a3bba265de882e7f4f70396546b6c9c8f9d47a021a\")\nimage = laionide.predict(prompt=\"avocado armchair\")\nupscaled_image = swinir.predict(image=image)\n```\n\n## Get output from a running model\n\nRun a model and get its output while it's running:\n\n```python\niterator = replicate.run(\n \"pixray/text2image:5c347a4bfa1d4523a58ae614c2194e15f2ae682b57e3797a5bb468920aa70ebf\",\n input={\"prompts\": \"san francisco sunset\"}\n)\n\nfor index, image in enumerate(iterator):\n with open(f\"file_{index}.png\", \"wb\") as file:\n file.write(image.read())\n```\n\n## Cancel a prediction\n\nYou can cancel a running prediction:\n\n```python\n>>> model = replicate.models.get(\"kvfrans/clipdraw\")\n>>> version = model.versions.get(\"5797a99edc939ea0e9242d5e8c9cb3bc7d125b1eac21bda852e5cb79ede2cd9b\")\n>>> prediction = replicate.predictions.create(\n version=version,\n input={\"prompt\":\"Watercolor painting of an underwater submarine\"}\n )\n\n>>> prediction.status\n'starting'\n\n>>> prediction.cancel()\n\n>>> prediction.reload()\n>>> prediction.status\n'canceled'\n```\n\n## List predictions\n\nYou can list all the predictions you've run:\n\n```python\nreplicate.predictions.list()\n# [<Prediction: 8b0ba5ab4d85>, <Prediction: 494900564e8c>]\n```\n\nLists of predictions are paginated. You can get the next page of predictions by passing the `next` property as an argument to the `list` method:\n\n```python\npage1 = replicate.predictions.list()\n\nif page1.next:\n page2 = replicate.predictions.list(page1.next)\n```\n\n## Load output files\n\nOutput files are returned as `FileOutput` objects:\n\n```python\nimport replicate\nfrom PIL import Image # pip install pillow\n\noutput = replicate.run(\n \"stability-ai/stable-diffusion:27b93a2413e7f36cd83da926f3656280b2931564ff050bf9575f1fdf9bcd7478\",\n input={\"prompt\": \"wavy colorful abstract patterns, oceans\"}\n )\n\n# This has a .read() method that returns the binary data.\nwith open(\"my_output.png\", \"wb\") as file:\n file.write(output[0].read())\n \n# It also implements the iterator protocol to stream the data.\nbackground = Image.open(output[0])\n```\n\n### FileOutput\n\nIs a [file-like](https://docs.python.org/3/glossary.html#term-file-object) object returned from the `replicate.run()` method that makes it easier to work with models that output files. It implements `Iterator` and `AsyncIterator` for reading the file data in chunks as well as `read()` and `aread()` to read the entire file into memory.\n\n> [!NOTE]\n> It is worth noting that at this time `read()` and `aread()` do not currently accept a `size` argument to read up to `size` bytes.\n\nLastly, the URL of the underlying data source is available on the `url` attribute though we recommend you use the object as an iterator or use its `read()` or `aread()` methods, as the `url` property may not always return HTTP URLs in future.\n\n```python\nprint(output.url) #=> \"data:image/png;base64,xyz123...\" or \"https://delivery.replicate.com/...\"\n```\n\nTo consume the file directly:\n\n```python\nwith open('output.bin', 'wb') as file:\n file.write(output.read())\n```\n\nOr for very large files they can be streamed:\n\n```python\nwith open(file_path, 'wb') as file:\n for chunk in output:\n file.write(chunk)\n```\n\nEach of these methods has an equivalent `asyncio` API.\n\n```python\nasync with aiofiles.open(filename, 'w') as file:\n await file.write(await output.aread())\n\nasync with aiofiles.open(filename, 'w') as file:\n await for chunk in output:\n await file.write(chunk)\n```\n\nFor streaming responses from common frameworks, all support taking `Iterator` types:\n\n**Django**\n\n```python\n@condition(etag_func=None)\ndef stream_response(request):\n output = replicate.run(\"black-forest-labs/flux-schnell\", input={...}, use_file_output =True)\n return HttpResponse(output, content_type='image/webp')\n```\n \n**FastAPI**\n\n```python\n@app.get(\"/\")\nasync def main():\n output = replicate.run(\"black-forest-labs/flux-schnell\", input={...}, use_file_output =True)\n return StreamingResponse(output)\n```\n\n**Flask**\n\n```python\n@app.route('/stream')\ndef streamed_response():\n output = replicate.run(\"black-forest-labs/flux-schnell\", input={...}, use_file_output =True)\n return app.response_class(stream_with_context(output))\n```\n\nYou can opt out of `FileOutput` by passing `use_file_output=False` to the `replicate.run()` method.\n\n```python\nconst replicate = replicate.run(\"acmecorp/acme-model\", use_file_output=False);\n```\n\n## List models\n\nYou can list the models you've created:\n\n```python\nreplicate.models.list()\n```\n\nLists of models are paginated. You can get the next page of models by passing the `next` property as an argument to the `list` method, or you can use the `paginate` method to fetch pages automatically.\n\n```python\n# Automatic pagination using `replicate.paginate` (recommended)\nmodels = []\nfor page in replicate.paginate(replicate.models.list):\n models.extend(page.results)\n if len(models) > 100:\n break\n\n# Manual pagination using `next` cursors\npage = replicate.models.list()\nwhile page:\n models.extend(page.results)\n if len(models) > 100:\n break\n page = replicate.models.list(page.next) if page.next else None\n```\n\nYou can also find collections of featured models on Replicate:\n\n```python\n>>> collections = [collection for page in replicate.paginate(replicate.collections.list) for collection in page]\n>>> collections[0].slug\n\"vision-models\"\n>>> collections[0].description\n\"Multimodal large language models with vision capabilities like object detection and optical character recognition (OCR)\"\n\n>>> replicate.collections.get(\"text-to-image\").models\n[<Model: stability-ai/sdxl>, ...]\n```\n\n## Create a model\n\nYou can create a model for a user or organization\nwith a given name, visibility, and hardware SKU:\n\n```python\nimport replicate\n\nmodel = replicate.models.create(\n owner=\"your-username\",\n name=\"my-model\",\n visibility=\"public\",\n hardware=\"gpu-a40-large\"\n)\n```\n\nHere's how to list of all the available hardware for running models on Replicate:\n\n```python\n>>> [hw.sku for hw in replicate.hardware.list()]\n['cpu', 'gpu-t4', 'gpu-a40-small', 'gpu-a40-large']\n```\n\n## Fine-tune a model\n\nUse the [training API](https://replicate.com/docs/fine-tuning) to fine-tune models to make them better at a particular task. To see what **language models** currently support fine-tuning, check out Replicate's [collection of trainable language models](https://replicate.com/collections/trainable-language-models).\n\nIf you're looking to fine-tune **image models**, check out Replicate's [guide to fine-tuning image models](https://replicate.com/docs/guides/fine-tune-an-image-model).\n\nHere's how to fine-tune a model on Replicate:\n\n```python\ntraining = replicate.trainings.create(\n model=\"stability-ai/sdxl\",\n version=\"39ed52f2a78e934b3ba6e2a89f5b1c712de7dfea535525255b1aa35c5565e08b\",\n input={\n \"input_images\": \"https://my-domain/training-images.zip\",\n \"token_string\": \"TOK\",\n \"caption_prefix\": \"a photo of TOK\",\n \"max_train_steps\": 1000,\n \"use_face_detection_instead\": False\n },\n # You need to create a model on Replicate that will be the destination for the trained version.\n destination=\"your-username/model-name\"\n)\n```\n\n## Customize client behavior\n\nThe `replicate` package exports a default shared client. This client is initialized with an API token set by the `REPLICATE_API_TOKEN` environment variable.\n\nYou can create your own client instance to pass a different API token value, add custom headers to requests, or control the behavior of the underlying [HTTPX client](https://www.python-httpx.org/api/#client):\n\n```python\nimport os\nfrom replicate.client import Client\n\nreplicate = Client(\n api_token=os.environ[\"SOME_OTHER_REPLICATE_API_TOKEN\"]\n headers={\n \"User-Agent\": \"my-app/1.0\"\n }\n)\n```\n\n> [!WARNING]\n> Never hardcode authentication credentials like API tokens into your code.\n> Instead, pass them as environment variables when running your program.\n\n## Development\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": " Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright 2022, Replicate, Inc. Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ",
"summary": "Python client for Replicate",
"version": "1.0.4",
"project_urls": {
"homepage": "https://replicate.com",
"repository": "https://github.com/replicate/replicate-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4799596172f868a94858ffbd5b366386bf2c367ff10525ad7a67d679011ae3c",
"md5": "ec311795763468415c28c1eabadf2fe4",
"sha256": "f568f6271ff715067901b6094c23c37373bbcfd7de0ff9b85e9c9ead567e09e7"
},
"downloads": -1,
"filename": "replicate-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec311795763468415c28c1eabadf2fe4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 48041,
"upload_time": "2024-11-25T12:36:47",
"upload_time_iso_8601": "2024-11-25T12:36:47.252376Z",
"url": "https://files.pythonhosted.org/packages/c4/79/9596172f868a94858ffbd5b366386bf2c367ff10525ad7a67d679011ae3c/replicate-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "77f4f2ef5916d1a9a1c8401210992b5e9f6f6bee50f372106ad2e25c1e4f3536",
"md5": "3bb29cf3db1ea3d695b76a1d7b2e84ea",
"sha256": "f718601863ef1f419aa7dcdab1ea8770ba5489b571b86edf840cd506d68758ef"
},
"downloads": -1,
"filename": "replicate-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "3bb29cf3db1ea3d695b76a1d7b2e84ea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 60660,
"upload_time": "2024-11-25T12:36:49",
"upload_time_iso_8601": "2024-11-25T12:36:49.077283Z",
"url": "https://files.pythonhosted.org/packages/77/f4/f2ef5916d1a9a1c8401210992b5e9f6f6bee50f372106ad2e25c1e4f3536/replicate-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 12:36:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "replicate",
"github_project": "replicate-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "replicate"
}
