Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update OpenAI README for 24.12 release #7899

Merged
merged 1 commit into from
Dec 23, 2024
Merged

docs: Update OpenAI README for 24.12 release #7899

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 10 additions & 19 deletions python/openai/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,22 +51,13 @@
docker run -it --net=host --gpus all --rm \
-v ${HOME}/.cache/huggingface:/root/.cache/huggingface \
-e HF_TOKEN \
nvcr.io/nvidia/tritonserver:24.08-vllm-python-py3
nvcr.io/nvidia/tritonserver:24.12-vllm-python-py3
```

2. Install dependencies inside the container:
2. Launch the OpenAI-compatible Triton Inference Server:
```bash
# Install python bindings for tritonserver and tritonfrontend
pip install /opt/tritonserver/python/triton*.whl

# Install application requirements
git clone https://github.com/triton-inference-server/server.git
cd server/python/openai/
pip install -r requirements.txt
```
cd /opt/tritonserver/python/openai

3. Launch the OpenAI-compatible Triton Inference Server:
```bash
# NOTE: Adjust the --tokenizer based on the model being used
python3 openai_frontend/main.py --model-repository tests/vllm_models --tokenizer meta-llama/Meta-Llama-3.1-8B-Instruct
```
Expand All @@ -92,7 +83,7 @@ INFO: Uvicorn running on http://0.0.0.0:9000 (Press CTRL+C to quit) <- OpenA

</details>

4. Send a `/v1/chat/completions` request:
3. Send a `/v1/chat/completions` request:
- Note the use of `jq` is optional, but provides a nicely formatted output for JSON responses.
```bash
MODEL="llama-3.1-8b-instruct"
Expand Down Expand Up @@ -132,7 +123,7 @@ curl -s http://localhost:9000/v1/chat/completions -H 'Content-Type: application/

</details>

5. Send a `/v1/completions` request:
4. Send a `/v1/completions` request:
- Note the use of `jq` is optional, but provides a nicely formatted output for JSON responses.
```bash
MODEL="llama-3.1-8b-instruct"
Expand Down Expand Up @@ -166,7 +157,7 @@ curl -s http://localhost:9000/v1/completions -H 'Content-Type: application/json'

</details>

6. Benchmark with `genai-perf`:
5. Benchmark with `genai-perf`:
- To install genai-perf in this container, see the instructions [here](https://github.com/triton-inference-server/perf_analyzer/tree/main/genai-perf#install-perf-analyzer-ubuntu-python-38)
- Or try using genai-perf from the [SDK container](https://github.com/triton-inference-server/perf_analyzer/tree/main/genai-perf#install-perf-analyzer-ubuntu-python-38)

Expand Down Expand Up @@ -206,7 +197,7 @@ genai-perf profile \

</details>

7. Use the OpenAI python client directly:
6. Use the OpenAI python client directly:
```python
from openai import OpenAI

Expand All @@ -231,9 +222,9 @@ completion = client.chat.completions.create(
print(completion.choices[0].message.content)
```

8. Run tests (NOTE: The server should not be running, the tests will handle starting/stopping the server as necessary):
7. Run tests (NOTE: The server should not be running, the tests will handle starting/stopping the server as necessary):
```bash
cd server/python/openai/
cd /opt/tritonserver/python/openai/
pip install -r requirements-test.txt

pytest -v tests/
Expand All @@ -255,7 +246,7 @@ docker run -it --net=host --gpus all --rm \
-v ${HOME}/.cache/huggingface:/root/.cache/huggingface \
-e HF_TOKEN \
-e TRTLLM_ORCHESTRATOR=1 \
nvcr.io/nvidia/tritonserver:24.08-trtllm-python-py3
nvcr.io/nvidia/tritonserver:24.11-trtllm-python-py3
dmitry-tokarev-nv marked this conversation as resolved.
Show resolved Hide resolved
```

2. Install dependencies inside the container:
Expand Down
Loading