Skip to content
Navigation Menu
{{ message }}
forked from replicate/replicate-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodel.py
More file actions
405 lines (312 loc) · 10.5 KB
/
Copy pathmodel.py
File metadata and controls
405 lines (312 loc) · 10.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
from typing import TYPE_CHECKING, Any, Dict, Literal, Optional, Tuple, Union
from typing_extensions import NotRequired, TypedDict, Unpack, deprecated
from replicate.exceptions import ReplicateException
from replicate.identifier import ModelVersionIdentifier
from replicate.pagination import Page
from replicate.prediction import (
Prediction,
_create_prediction_body,
_json_to_prediction,
)
from replicate.resource import Namespace, Resource
from replicate.version import Version, Versions
try:
from pydantic import v1 as pydantic # type: ignore
except ImportError:
import pydantic # type: ignore
if TYPE_CHECKING:
from replicate.client import Client
from replicate.prediction import Predictions
class Model(Resource):
"""
A machine learning model hosted on Replicate.
"""
_client: "Client" = pydantic.PrivateAttr()
url: str
"""
The URL of the model.
"""
owner: str
"""
The owner of the model.
"""
name: str
"""
The name of the model.
"""
description: Optional[str]
"""
The description of the model.
"""
visibility: Literal["public", "private"]
"""
The visibility of the model. Can be 'public' or 'private'.
"""
github_url: Optional[str]
"""
The GitHub URL of the model.
"""
paper_url: Optional[str]
"""
The URL of the paper related to the model.
"""
license_url: Optional[str]
"""
The URL of the license for the model.
"""
run_count: int
"""
The number of runs of the model.
"""
cover_image_url: Optional[str]
"""
The URL of the cover image for the model.
"""
default_example: Optional[Prediction]
"""
The default example of the model.
"""
latest_version: Optional[Version]
"""
The latest version of the model.
"""
@property
def id(self) -> str:
"""
Return the qualified model name, in the format `owner/name`.
"""
return f"{self.owner}/{self.name}"
@property
@deprecated("Use `model.owner` instead.")
def username(self) -> str:
"""
The name of the user or organization that owns the model.
This attribute is deprecated and will be removed in future versions.
"""
return self.owner
@username.setter
@deprecated("Use `model.owner` instead.")
def username(self, value: str) -> None:
self.owner = value
def predict(self, *args, **kwargs) -> None:
"""
DEPRECATED: Use `replicate.run()` instead.
"""
raise ReplicateException(
"The `model.predict()` method has been removed, because it's unstable: if a new version of the model you're using is pushed and its API has changed, your code may break. Use `replicate.run()` instead. See https://github.com/replicate/replicate-python#readme"
)
@property
def versions(self) -> Versions:
"""
Get the versions of this model.
"""
return Versions(client=self._client, model=self)
def reload(self) -> None:
"""
Load this object from the server.
"""
obj = self._client.models.get(f"{self.owner}/{self.name}")
for name, value in obj.dict().items():
setattr(self, name, value)
class Models(Namespace):
"""
Namespace for operations related to models.
"""
model = Model
@property
def predictions(self) -> "ModelsPredictions":
"""
Get a namespace for operations related to predictions on a model.
"""
return ModelsPredictions(client=self._client)
def list(self, cursor: Union[str, "ellipsis", None] = ...) -> Page[Model]: # noqa: F821
"""
List all public models.
Parameters:
cursor: The cursor to use for pagination. Use the value of `Page.next` or `Page.previous`.
Returns:
Page[Model]: A page of of models.
Raises:
ValueError: If `cursor` is `None`.
"""
if cursor is None:
raise ValueError("cursor cannot be None")
resp = self._client._request("GET", "/v1/models" if cursor is ... else cursor)
obj = resp.json()
obj["results"] = [
_json_to_model(self._client, result) for result in obj["results"]
]
return Page[Model](**obj)
async def async_list(
self,
cursor: Union[str, "ellipsis", None] = ..., # noqa: F821
) -> Page[Model]:
"""
List all public models.
Parameters:
cursor: The cursor to use for pagination. Use the value of `Page.next` or `Page.previous`.
Returns:
Page[Model]: A page of of models.
Raises:
ValueError: If `cursor` is `None`.
"""
if cursor is None:
raise ValueError("cursor cannot be None")
resp = await self._client._async_request(
"GET", "/v1/models" if cursor is ... else cursor
)
obj = resp.json()
obj["results"] = [
_json_to_model(self._client, result) for result in obj["results"]
]
return Page[Model](**obj)
def get(self, key: str) -> Model:
"""
Get a model by name.
Args:
key: The qualified name of the model, in the format `owner/model-name`.
Returns:
The model.
"""
resp = self._client._request("GET", f"/v1/models/{key}")
return _json_to_model(self._client, resp.json())
async def async_get(self, key: str) -> Model:
"""
Get a model by name.
Args:
key: The qualified name of the model, in the format `owner/model-name`.
Returns:
The model.
"""
resp = await self._client._async_request("GET", f"/v1/models/{key}")
return _json_to_model(self._client, resp.json())
class CreateModelParams(TypedDict):
"""Parameters for creating a model."""
hardware: str
"""The SKU for the hardware used to run the model.
Possible values can be found by calling `replicate.hardware.list()`."""
visibility: Literal["public", "private"]
"""Whether the model should be public or private."""
description: NotRequired[str]
"""The description of the model."""
github_url: NotRequired[str]
"""A URL for the model's source code on GitHub."""
paper_url: NotRequired[str]
"""A URL for the model's paper."""
license_url: NotRequired[str]
"""A URL for the model's license."""
cover_image_url: NotRequired[str]
"""A URL for the model's cover image."""
def create(
self,
owner: str,
name: str,
**params: Unpack["Models.CreateModelParams"],
) -> Model:
"""
Create a model.
"""
body = _create_model_body(owner, name, **params)
resp = self._client._request("POST", "/v1/models", json=body)
return _json_to_model(self._client, resp.json())
async def async_create(
self, owner: str, name: str, **params: Unpack["Models.CreateModelParams"]
) -> Model:
"""
Create a model.
"""
body = body = _create_model_body(owner, name, **params)
resp = await self._client._async_request("POST", "/v1/models", json=body)
return _json_to_model(self._client, resp.json())
class ModelsPredictions(Namespace):
"""
Namespace for operations related to predictions in a deployment.
"""
def create(
self,
model: Union[str, Tuple[str, str], "Model"],
input: Dict[str, Any],
**params: Unpack["Predictions.CreatePredictionParams"],
) -> Prediction:
"""
Create a new prediction with the deployment.
"""
url = _create_prediction_url_from_model(model)
body = _create_prediction_body(version=None, input=input, **params)
resp = self._client._request(
"POST",
url,
json=body,
)
return _json_to_prediction(self._client, resp.json())
async def async_create(
self,
model: Union[str, Tuple[str, str], "Model"],
input: Dict[str, Any],
**params: Unpack["Predictions.CreatePredictionParams"],
) -> Prediction:
"""
Create a new prediction with the deployment.
"""
url = _create_prediction_url_from_model(model)
body = _create_prediction_body(version=None, input=input, **params)
resp = await self._client._async_request(
"POST",
url,
json=body,
)
return _json_to_prediction(self._client, resp.json())
def _create_model_body( # pylint: disable=too-many-arguments
owner: str,
name: str,
*,
visibility: str,
hardware: str,
description: Optional[str] = None,
github_url: Optional[str] = None,
paper_url: Optional[str] = None,
license_url: Optional[str] = None,
cover_image_url: Optional[str] = None,
) -> Dict[str, Any]:
body = {
"owner": owner,
"name": name,
"visibility": visibility,
"hardware": hardware,
}
if description is not None:
body["description"] = description
if github_url is not None:
body["github_url"] = github_url
if paper_url is not None:
body["paper_url"] = paper_url
if license_url is not None:
body["license_url"] = license_url
if cover_image_url is not None:
body["cover_image_url"] = cover_image_url
return body
def _json_to_model(client: "Client", json: Dict[str, Any]) -> Model:
model = Model(**json)
model._client = client
if model.default_example is not None:
model.default_example._client = client
return model
def _create_prediction_url_from_model(
model: Union[str, Tuple[str, str], "Model"]
) -> str:
owner, name = None, None
if isinstance(model, Model):
owner, name = model.owner, model.name
elif isinstance(model, tuple):
owner, name = model[0], model[1]
elif isinstance(model, str):
owner, name, version_id = ModelVersionIdentifier.parse(model)
if version_id is not None:
raise ValueError(
f"Invalid reference to model version: {model}. Expected model or reference in the format owner/name"
)
if owner is None or name is None:
raise ValueError(
"model must be a Model, a tuple of (owner, name), or a string in the format 'owner/name'"
)
return f"/v1/models/{owner}/{name}/predictions"
You can’t perform that action at this time.