Skip to content

Commit

Permalink
Models.ready docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Carson Lam authored and Carson Lam committed Sep 15, 2023
1 parent 9833d3a commit 4590e40
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ The `get_job_status` should change from `pending` to `running` to `completed` as

`carlton/ft-dd93c727-f35e-41c2-a370-7d55b54128fa-2023-08-16-10-15-09`

Now you can download your model using `together.Finetune.download(fine_tune_id)` or you start using your model for inference (may take a few minutes after finetuning to become available) by first starting your new model instance:
Now you can download your model using `together.Finetune.download(fine_tune_id)` or start using your model on our inference engine (may take a few minutes after finetuning to become available) by first starting your new model instance:

```
together.Models.start("carlton/ft-dd93c727-f35e-41c2-a370-7d55b54128fa-2023-08-16-10-15-09")
Expand All @@ -330,6 +330,16 @@ output = together.Complete.create(
)
```

To check whether your model is finished deploying, you can use the `Models.ready` like so:

```
together.Models.ready("carlton/ft-dd93c727-f35e-41c2-a370-7d55b54128fa-2023-08-16-10-15-09")
```

```
{'ready': 'model is ready for start, status code:1'}
```

## Chat

The `chat` command is a CLI-based chat application that can be used for back-and-forth conversations with models in a pre-defined format.
Expand Down
4 changes: 2 additions & 2 deletions src/together/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,9 @@ def ready(self, model: str) -> Dict[str, str]:
if model_dict.get("name") == model:
depth_num_asks = model_dict["depth"]["num_asks"]
if depth_num_asks > 0:
return {"ready":"model is ready for start, status code:"+depth_num_asks}
return {"ready":f"model is ready for start, status code:{depth_num_asks}"}
else:
return {"ready":"model is not ready for start, status code:"+depth_num_asks}
return {"ready":f"model is not ready for start, status code:{depth_num_asks}"}
else:
return {"ready":f"No matching model name found for '{model}'."}
else:
Expand Down

0 comments on commit 4590e40

Please sign in to comment.