diff --git a/README.md b/README.md index 0717772..a57e962 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ This is a Outpost CLI for [Outpost](https://outpost.run). It lets you run models from your terminal, and do various other things on Outpost. -## Requirements +### Requirements - Python 3.8+ -## Getting Started +### Getting Started Install the library with ``` @@ -15,24 +15,33 @@ pip install outpostcli outpostcli login [-t api_token] ``` -## Get Current User +### Get Current User ``` outpostcli user [-t api_token] ``` -## List Inferences +## Inference Endpoints + +### List Inferences ``` outpostcli inferences list [-e entity] [-t api_token] ``` -## Get Inference +### Get Inference ``` outpostcli inference get [-e entity] [-t api_token] #TODO: outpostcli inference get ... ``` -## Examples +### Examples ``` outpostcli user outpostcli inferences create hf:lxyuan/distilbert-base-multilingual-cased-sentiments-student -i CPU-sm -n cli-text-classification +``` + +## Outpost Hub + +Upload files for models or datasets faster from Outpost Hub using multipart. +``` +outpostcli lfs enable-largefiles . ``` \ No newline at end of file