Skip to content

Commit b02d4da

Browse files
committed
feat(nox): Added documentation for nox in README.md
Signed-off-by: Anurag Dixit <[email protected]>
1 parent 19e0c07 commit b02d4da

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,43 @@ docker run -it -v$(pwd)/..:/workspace/Torch-TensorRT build_torch_tensorrt_wheel
250250

251251
Python compilation expects using the tarball based compilation strategy from above.
252252

253+
254+
## Testing using Python backend
255+
256+
Torch-TensorRT supports testing in Python using [nox](https://nox.thea.codes/en/stable)
257+
258+
To install the nox using python-pip
259+
260+
```
261+
python3 -m pip install --upgrade nox
262+
```
263+
264+
To list supported nox sessions:
265+
266+
```
267+
nox --session -l
268+
```
269+
270+
Environment variables supported by nox
271+
272+
```
273+
PYT_PATH - To use different PYTHONPATH than system installed Python packages
274+
TOP_DIR - To set the root directory of the noxfile
275+
USE_CXX11 - To use cxx11_abi (Defaults to 0)
276+
USE_HOST_DEPS - To use host dependencies for tests (Defaults to 0)
277+
```
278+
279+
Usage example
280+
281+
```
282+
nox --session l0_api_tests
283+
```
284+
285+
Supported Python versions:
286+
```
287+
["3.7", "3.8", "3.9", "3.10"]
288+
```
289+
253290
## How do I add support for a new op...
254291

255292
### In Torch-TensorRT?
@@ -279,4 +316,4 @@ Take a look at the [CONTRIBUTING.md](CONTRIBUTING.md)
279316

280317
## License
281318

282-
The Torch-TensorRT license can be found in the LICENSE file. It is licensed with a BSD Style licence
319+
The Torch-TensorRT license can be found in the LICENSE file. It is licensed with a BSD Style licence

0 commit comments

Comments
 (0)