Skip to content

docs: fix TRT RTX download link and doc lints #159

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

Merged
theHamsta merged 1 commit into from
Oct 17, 2026
Merged

docs: fix TRT RTX download link and doc lints #159

Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ trtx-rs/
You can steer discovery of libclang using LIBCLANG_PATH environment variable if auto-discovery
discovers a wrong version of libclang, e.g.

$env:LIBCLANG_PATH="D:\programs\LLVM\bin" # powershell windows
export LIBCLANG_PATH=/usr/lib/llvm-19/lib # linux
$env:LIBCLANG_PATH="D:\programs\LLVM\bin" # powershell windows
export LIBCLANG_PATH=/usr/lib/llvm-19/lib # linux

See https://rust-lang.github.io/rust-bindgen/requirements.html (note that autocxx uses an older fork of bindgen)

Expand All @@ -51,7 +51,7 @@ Use `TENSORRT_SDK_DIR` to point to the TensorRT SDK root directory (the path tha

### Required (GPU execution)

1. **NVIDIA TensorRT-RTX**: Download and install from [NVIDIA Developer](https://developer.nvidia.com/tensorrt)
1. **NVIDIA TensorRT-RTX**: Download and install from [NVIDIA Developer](https://developer.nvidia.com/tensorrt-rtx)
- The TensorRT libraries should be in a location where they can be dynamically loaded.
(e.g. by setting PATH on Windows or LD_LIBRARY_PATH on Linux)
- This crate currently requires TensorRT RTX version 1.3, 1.4, 1.5, 1.6 or 1.7 (see Cargo feature `v_1_3`, `v_1_4`, `v_1_5`, `v_1_6`, `v_1_7`).
Expand Down
2 changes: 1 addition & 1 deletion trtx/src/interfaces.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use trtx_sys::{
};
use trtx_sys::{DataType, Dims64, ErrorCode, SeekPosition, TensorLocation};

/// Rust trait implemented by [`ProgressMonitor`] for [`trtx_sys::nvinfer1::IProgressMonitor`]; C++ [`nvinfer1::v_1_0::IProgressMonitor`](https://docs.nvidia.com/deeplearning/tensorrt-rtx/latest/_static/c-api/classnvinfer1_1_1v__1__0_1_1_i_progress_monitor.html).
/// Rust trait to implement [`trtx_sys::nvinfer1::IProgressMonitor`]; C++ [`nvinfer1::v_1_0::IProgressMonitor`](https://docs.nvidia.com/deeplearning/tensorrt-rtx/latest/_static/c-api/classnvinfer1_1_1v__1__0_1_1_i_progress_monitor.html).
///
/// Use with [`crate::BuilderConfig::set_progress_monitor`].
pub trait MonitorProgress: Send + Sync {
Expand Down
4 changes: 3 additions & 1 deletion trtx/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,10 @@
//! You can steer discovery of libclang using LIBCLANG_PATH environment variable if auto-discovery
//! discovers a wrong version of libclang, e.g.
//!
//! ```text
//! $env:LIBCLANG_PATH="D:\programs\LLVM\bin" # powershell windows
//! export LIBCLANG_PATH=/usr/lib/llvm-19/lib # linux
//! ```
//!
//! See <https://rust-lang.github.io/rust-bindgen/requirements.html> (note that autocxx uses an older fork of bindgen)
//!
Expand All @@ -103,7 +105,7 @@
//!
//! ### Required (GPU execution)
//!
//! 1. **NVIDIA TensorRT-RTX**: Download and install from [NVIDIA Developer](https://developer.nvidia.com/tensorrt)
//! 1. **NVIDIA TensorRT-RTX**: Download and install from [NVIDIA Developer](https://developer.nvidia.com/tensorrt-rtx)
//! - The TensorRT libraries should be in a location where they can be dynamically loaded.
//! (e.g. by setting PATH on Windows or LD_LIBRARY_PATH on Linux)
//! - This crate currently requires TensorRT RTX version 1.3, 1.4, 1.5, 1.6 or 1.7 (see Cargo feature `v_1_3`, `v_1_4`, `v_1_5`, `v_1_6`, `v_1_7`).
Expand Down
Loading