Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shubham-kaushal committed Jun 10, 2024
1 parent 0ea853e commit 8a42bc1
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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 <inf_name> [-e entity] [-t api_token]
#TODO: outpostcli inference <inf_name> 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 .
```

0 comments on commit 8a42bc1

Please sign in to comment.