Skip to content

Update usage documentation in README #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattt merged 6 commits into from
Jun 12, 2023
Merged

Update usage documentation in README #83

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7cc96e6
Fix signature for trainings.create
mattt Jun 12, 2023
a4a29a8
Add entry for trainings.cancel
mattt Jun 12, 2023
07c827e
Replace {version} placeholder with id for flan-t5-xl
mattt Jun 12, 2023
86088fc
Add entry for predictions.cancel
mattt Jun 12, 2023
618be5b
Update timestamps in example responses
mattt Jun 12, 2023
bea7d08
Reorder fields in JSON responses
mattt Jun 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 84 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,17 +248,17 @@ const response = await replicate.predictions.create(options);
"get": "https://api.replicate.com/v1/predictions/ufawqhfynnddngldkgtslldrkq",
"cancel": "https://api.replicate.com/v1/predictions/ufawqhfynnddngldkgtslldrkq/cancel"
},
"created_at": "2022-04-26T22:13:06.224088Z",
"started_at": null,
"completed_at": null,
"status": "succeeded",
"input": {
"text": "Alice"
},
"output": null,
"error": null,
"logs": null,
"metrics": {}
"metrics": {},
"created_at": "2022-04-26T22:13:06.224088Z",
"started_at": null,
"completed_at": null
}
```

Expand All @@ -280,17 +280,49 @@ const response = await replicate.predictions.get(prediction_id);
"get": "https://api.replicate.com/v1/predictions/ufawqhfynnddngldkgtslldrkq",
"cancel": "https://api.replicate.com/v1/predictions/ufawqhfynnddngldkgtslldrkq/cancel"
},
"status": "starting",
"input": {
"text": "Alice"
},
"output": null,
"error": null,
"logs": null,
"metrics": {},
"created_at": "2022-04-26T22:13:06.224088Z",
"started_at": null,
"completed_at": null,
"status": "starting",
"completed_at": null
}
```

### `replicate.predictions.cancel`

```js
const response = await replicate.predictions.cancel(prediction_id);
```

| name | type | description |
| --------------- | ------ | ------------------------------- |
| `prediction_id` | number | **Required**. The prediction id |

```jsonc
{
"id": "ufawqhfynnddngldkgtslldrkq",
"version": "5c7d5dc6dd8bf75c1acaa8565735e7986bc5b66206b55cca93cb72c9bf15ccaa",
"urls": {
"get": "https://api.replicate.com/v1/predictions/ufawqhfynnddngldkgtslldrkq",
"cancel": "https://api.replicate.com/v1/predictions/ufawqhfynnddngldkgtslldrkq/cancel"
},
"status": "canceled",
"input": {
"text": "Alice"
},
"output": null,
"error": null,
"logs": null,
"metrics": {}
"metrics": {},
"created_at": "2022-04-26T22:13:06.224088Z",
"started_at": "2022-04-26T22:13:06.224088Z",
"completed_at": "2022-04-26T22:13:06.224088Z"
}
```

Expand All @@ -314,11 +346,11 @@ const response = await replicate.predictions.list();
"get": "https://api.replicate.com/v1/predictions/jpzd7hm5gfcapbfyt4mqytarku",
"cancel": "https://api.replicate.com/v1/predictions/jpzd7hm5gfcapbfyt4mqytarku/cancel"
},
"source": "web",
"status": "succeeded",
"created_at": "2022-04-26T20:00:40.658234Z",
"started_at": "2022-04-26T20:00:84.583803Z",
"completed_at": "2022-04-26T20:02:27.648305Z",
"source": "web",
"status": "succeeded"
"completed_at": "2022-04-26T20:02:27.648305Z"
}
/* ... */
]
Expand All @@ -328,12 +360,14 @@ const response = await replicate.predictions.list();
### `replicate.trainings.create`

```js
const response = await replicate.trainings.create(options);
const response = await replicate.trainings.create(model_owner, model_name, version_id, options);
```

| name | type | description |
| ------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `options.version` | string | **Required**. The model version |
| `model_owner` | string | **Required**. The name of the user or organization that owns the model. |
| `model_name` | string | **Required**. The name of the model. |
| `version` | string | **Required**. The model version |
| `options.destination` | string | **Required**. The destination for the trained version in the form `{username}/{model_name}` |
| `options.input` | object | **Required**. An object with the model's inputs |
| `options.webhook` | string | An HTTPS URL for receiving a webhook when the training has new output |
Expand All @@ -342,7 +376,7 @@ const response = await replicate.trainings.create(options);
```jsonc
{
"id": "zz4ibbonubfz7carwiefibzgga",
"version": "{version}",
"version": "3ae0799123a1fe11f8c89fd99632f843fc5f7a761630160521c4253149754523",
"status": "starting",
"input": {
"text": "..."
Expand All @@ -369,7 +403,7 @@ const response = await replicate.trainings.get(training_id);
```jsonc
{
"id": "zz4ibbonubfz7carwiefibzgga",
"version": "{version}",
"version": "3ae0799123a1fe11f8c89fd99632f843fc5f7a761630160521c4253149754523",
"status": "succeeded",
"input": {
"data": "..."
Expand All @@ -381,9 +415,40 @@ const response = await replicate.trainings.get(training_id);
"error": null,
"logs": null,
"webhook_completed": null,
"started_at": null,
"started_at": "2023-03-28T21:48:02.402755Z",
"created_at": "2023-03-28T21:47:58.566434Z",
"completed_at": null
"completed_at": "2023-03-28T02:49:48.492023Z"
}
```

### `replicate.trainings.cancel`

```js
const response = await replicate.trainings.cancel(training_id);
```

| name | type | description |
| ------------- | ------ | ----------------------------- |
| `training_id` | number | **Required**. The training id |

```jsonc
{
"id": "zz4ibbonubfz7carwiefibzgga",
"version": "3ae0799123a1fe11f8c89fd99632f843fc5f7a761630160521c4253149754523",
"status": "canceled",
"input": {
"data": "..."
"param1": "..."
},
"output": {
"version": "..."
},
"error": null,
"logs": null,
"webhook_completed": null,
"started_at": "2023-03-28T21:48:02.402755Z",
"created_at": "2023-03-28T21:47:58.566434Z",
"completed_at": "2023-03-28T02:49:48.492023Z"
}
```

Expand All @@ -407,11 +472,11 @@ const response = await replicate.trainings.list();
"get": "https://api.replicate.com/v1/trainings/jpzd7hm5gfcapbfyt4mqytarku",
"cancel": "https://api.replicate.com/v1/trainings/jpzd7hm5gfcapbfyt4mqytarku/cancel"
},
"source": "web",
"status": "succeeded",
"created_at": "2022-04-26T20:00:40.658234Z",
"started_at": "2022-04-26T20:00:84.583803Z",
"completed_at": "2022-04-26T20:02:27.648305Z",
"source": "web",
"status": "succeeded"
"completed_at": "2022-04-26T20:02:27.648305Z"
}
/* ... */
]
Expand Down