Skip to content

Commit d296bc5

Browse files
committed
update readme
1 parent 766c194 commit d296bc5

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

docs/GETTING_STARTED.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
# Getting Started
22
[TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM) is used for model inference speeding up.
33

4+
All the codes are successfully tested in the following enviroments:
5+
* Linux (18.04, 20.04, 22.04)
6+
* Python 3.10
7+
* Pytorch 2.0 or higher
8+
* CUDA 12.1 or higher
9+
* TensorRT-LLM 0.11.0 (stable version)
410

511
### 1. Conda or Python Environment Preparation
6-
* Please follow the step 1, 2 from the [official tutorial](https://nvidia.github.io/TensorRT-LLM/installation/linux.html) of TensorRT-LLM to install the environment.
12+
13+
14+
* Please follow the step 1, 2 from the [official tutorial](https://nvidia.github.io/TensorRT-LLM/installation/linux.html) of TensorRT-LLM to install the environment.
15+
16+
Note we used the TensorRT-LLM **stable version `0.11.0`**.
717
``` bash
818
# Installing on Linux
9-
1019
Step 1. Retrieve and launch the docker container (optional).
1120

1221
You can pre-install the environment using the [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit) to avoid manual environment configuration.
@@ -26,7 +35,7 @@ Step 2. Install TensorRT-LLM.
2635
# Install the latest preview version (corresponding to the main branch) of TensorRT-LLM.
2736
# If you want to install the stable version (corresponding to the release branch), please
2837
# remove the `--pre` option.
29-
pip3 install tensorrt_llm -U --pre --extra-index-url https://pypi.nvidia.com
38+
pip3 install tensorrt_llm==0.11.0 --extra-index-url https://pypi.nvidia.com
3039
3140
# Check installation
3241
python3 -c "import tensorrt_llm"
@@ -66,7 +75,7 @@ StructEqTable-Deploy
6675
We provide a script to help users quickly implement model compilation.
6776

6877
``` bash
69-
cd StructEqTable-Deploytools
78+
cd StructEqTable-Deploy/tools
7079
# execute the script to quickly compile the model.
7180
bash scripts/build_tensorrt.sh
7281
```

tools/scripts/build_tensorrt.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ MODEL_OUTPUT=${2:-"../ckpts/StructTable-base-TensorRT"}
55
MODEL_TYPE=${3:-"StructEqTable"}
66

77
if [ ! -d $MODEL_OUTPUT ]; then
8-
mkdir -p MODEL_OUTPUT
8+
mkdir -p $MODEL_OUTPUT
99
fi
1010

1111
# Step1 Convert the model into TensorrtLLM checkpoint format

0 commit comments

Comments
 (0)