Skip to content

Commit

Permalink
chore(docs): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hanxiao committed May 9, 2022
1 parent f524d0f commit 099e221
Showing 1 changed file with 41 additions and 40 deletions.
81 changes: 41 additions & 40 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,48 +5,8 @@
:end-before: <!-- end elevator-pitch -->
```

## Install

![PyPI](https://img.shields.io/pypi/v/clip_client?color=%23ffffff&label=%20) is the latest version.

Make sure you have Python 3.7+. You can install client and server independently. You **don't** have to install both: e.g. installing `clip_server` on a GPU machine and `clip_client` on a local laptop.

````{tab} Client
```bash
pip install clip-client
```
````

````{tab} Server
```bash
pip install clip-server
```
````

````{tab} Server with ONNX support
```bash
pip install "clip_server[onnx]"
```
````


````{tab} Server with TensorRT support
```bash
pip install nvidia-pyindex
pip install "clip_server[tensorrt]"
```
````

## Try it!


An always-online demo server loaded with `ViT-L/14-336px` is there for you to play & test:

````{tab} via HTTP
Expand Down Expand Up @@ -88,6 +48,47 @@ print(r)
````

## Install

![PyPI](https://img.shields.io/pypi/v/clip_client?color=%23ffffff&label=%20) is the latest version.

Make sure you have Python 3.7+. You can install client and server independently. You **don't** have to install both: e.g. installing `clip_server` on a GPU machine and `clip_client` on a local laptop.

````{tab} Client
```bash
pip install clip-client
```
````

````{tab} Server
```bash
pip install clip-server
```
````

````{tab} Server with ONNX support
```bash
pip install "clip_server[onnx]"
```
````


````{tab} Server with TensorRT support
```bash
pip install nvidia-pyindex
pip install "clip_server[tensorrt]"
```
````



## Quick check

After install, you can run the following commands for a quick connectivity check.
Expand Down

0 comments on commit 099e221

Please sign in to comment.