Skip to content

Commit 2ad2c0a

Browse files
Updates README to include links to common guides
1 parent e1b1a0c commit 2ad2c0a

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

tripy/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,19 @@
77
[![Tripy L1](https://github.com/NVIDIA/TensorRT-Incubator/actions/workflows/tripy-l1.yml/badge.svg)](https://github.com/NVIDIA/TensorRT-Incubator/actions/workflows/tripy-l1.yml)
88
<!-- Tripy: DOC: OMIT End -->
99

10-
Tripy is a Python programming model for [TensorRT](https://developer.nvidia.com/tensorrt) that aims to provide an excellent
11-
user experience without compromising performance. Some of the features of Tripy include:
10+
Tripy is a Python programming model for [TensorRT](https://developer.nvidia.com/tensorrt) that aims to provide
11+
an excellent user experience without compromising performance. Some of the goals of Tripy are:
1212

1313
- **Intuitive API**: Tripy doesn't reinvent the wheel: If you have used NumPy or
1414
PyTorch before, Tripy APIs should feel familiar.
1515

1616
- **Excellent Error Messages**: When something goes wrong, Tripy tries to provide
1717
informative and actionable error messages. Even in cases where the error comes
18-
from deep within the software stack, Tripy is able to map it back to the Python code
19-
that caused it.
18+
from deep within the software stack, Tripy is usually able to map it back to the
19+
related Python code.
20+
21+
- **Friendly Documentation**: The documentation is meant to be accessible and comprehensive,
22+
with plenty of examples to illustrate important points.
2023

2124

2225
## Installation
@@ -73,6 +76,11 @@ We recommend starting with the
7376
[Introduction To Tripy](https://nvidia.github.io/TensorRT-Incubator/pre0_user_guides/00-introduction-to-tripy.html)
7477
guide.
7578
79+
Other features covered in our guides include:
80+
81+
- [Compiling code (including dynamic shape support)](https://nvidia.github.io/TensorRT-Incubator/pre0_user_guides/02-compiler.html)
82+
- [Quantization](https://nvidia.github.io/TensorRT-Incubator/pre0_user_guides/01-quantization.html)
83+
7684
To get an idea of the look and feel of Tripy, let's take a look at a short code example.
7785
All of the features used in this example are explained in more detail in the
7886
introduction guide mentioned above.

0 commit comments

Comments
 (0)