Add a demo gif in README (#12)

* Add demo gif * Add demo gif --------- Co-authored-by: npuzhangyuchao <[email protected]>
npuichigo · Dec 7, 2023 · 6bba496 · 6bba496
1 parent fb04401
commit 6bba496
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -14,3 +14,5 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+/models
diff --git a/README.md b/README.md
@@ -3,13 +3,16 @@
 Provide [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM) and [NVIDIA Triton Inference Server](https://github.com/triton-inference-server/tensorrtllm_backend)
 with an OpenAI-compatible API. This allows you to integrate with [langchain](https://github.com/langchain-ai/langchain)
 
+## Quick overview
+![demo](images/demo.gif)
+
 ## Get started
 Follow the [tensorrtllm_backend tutorial](https://github.com/triton-inference-server/tensorrtllm_backend#using-the-tensorrt-llm-backend)
 to build your TensorRT engine, and launch a triton server. We provide an `Baichuan` example below to follow.
 
 You need to clone the repository with dependencies to build the project.
 ```bash
-git submodule update --init --recursive
+git clone --recursive https://github.com/npuichigo/openai_trtllm.git
 ```
 
 ### Build with Docker

diff --git a/client/requirements.txt b/client/requirements.txt
@@ -1,2 +1 @@
 openai>=0.28.1
-pprint
diff --git a/images/demo.gif b/images/demo.gif
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,3 +14,5 @@ Cargo.lock

		# MSVC Windows builds of rustc generate these, which store debugging information
		*.pdb

		/models