Skip to content

Commit 7125c19

Browse files
authored
docs: readme clean up (#281)
1 parent 9b61f29 commit 7125c19

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ ultralytics-inference help
9999
# Using Ultralytics CLI (FP32, default)
100100
yolo export model=yolo26n.pt format=onnx
101101

102-
# FP16 (half precision) ~50% smaller model
102+
# FP16 (half precision) - ~50% smaller model
103103
yolo export model=yolo26n.pt format=onnx quantize=16
104104
```
105105

@@ -115,7 +115,7 @@ model.export(format="onnx", quantize=16) # FP16 (half precision)
115115
> **Precision / quantization:** Ultralytics ≥8.4 uses a single `quantize`
116116
> argument instead of the deprecated `half=True` / `int8=True` flags. For ONNX
117117
> the supported values are `32`/`fp32` (FP32, the default), `16`/`fp16` (FP16),
118-
> and `8`/`int8` (INT8 requires a calibration dataset via `data=`). The old
118+
> and `8`/`int8` (INT8 - requires a calibration dataset via `data=`). The old
119119
> `half=True` (→ `quantize=16`) and `int8=True` (→ `quantize=8`) still work but
120120
> emit a deprecation warning. See the
121121
> [export docs](https://docs.ultralytics.com/modes/export) and the

docs/CUDA.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| `tensorrt` | ORT TensorRT EP (FP16, engine cache, opt-level 5) | NVIDIA GPU with TensorRT installed; 2–3× faster than `cuda` |
99
| `cuda-preprocess` | GPU-side preprocess + zero-copy device input to TRT | maximum throughput; `YOLOModel::predict_image` transparently uses a fused CUDA preprocess kernel |
1010

11-
`cuda-preprocess` implies `cuda` + `tensorrt`. When it's compiled in, no API change is required `YOLOModel::predict_image` automatically routes through the GPU preprocess path on CUDA/TensorRT devices. Opt out per-model with [`InferenceConfig::with_cuda_preprocess(false)`](crate::InferenceConfig::with_cuda_preprocess).
11+
`cuda-preprocess` implies `cuda` + `tensorrt`. When it's compiled in, no API change is required - `YOLOModel::predict_image` automatically routes through the GPU preprocess path on CUDA/TensorRT devices. Opt out per-model with [`InferenceConfig::with_cuda_preprocess(false)`](crate::InferenceConfig::with_cuda_preprocess).
1212

1313
## Requirements
1414

@@ -32,7 +32,7 @@ ultralytics-inference = { version = "0.0.26", features = ["tensorrt"] }
3232
ultralytics-inference = { version = "0.0.26", features = ["cuda-preprocess"] }
3333
```
3434

35-
Then `cargo build --release` no extra flags needed.
35+
Then `cargo build --release` - no extra flags needed.
3636

3737
For the CLI / examples in this repo directly:
3838

@@ -104,7 +104,7 @@ What to expect and how to avoid surprises:
104104
to `.gitignore`, not to clean builds) to avoid paying the cost again.
105105
- **Cache is keyed to the build context.** A new engine is built whenever the
106106
model file, GPU/driver/TensorRT version, precision (`--half`), or **input
107-
shape** changes. **Dynamic-shape models rebuild per new input size** feed a
107+
shape** changes. **Dynamic-shape models rebuild per new input size** - feed a
108108
consistent size (the fast path uses the model's resolved `imgsz`) to keep it
109109
to a single cached engine.
110110
- **Warm up before timing.** The first `predict*` call also triggers an
@@ -182,7 +182,7 @@ ultralytics-inference predict --model yolo26n.onnx --source image.jpg \
182182
```
183183

184184
This uses the TensorRT EP (FP16 + engine cache). The `cuda-preprocess` kernel
185-
fast path is **not** used by the CLI the CLI runs through the batch
185+
fast path is **not** used by the CLI - the CLI runs through the batch
186186
processor, which uses CPU preprocess. The GPU preprocess path is reached only
187187
through `YOLOModel::predict_image` in library code.
188188

@@ -195,5 +195,5 @@ through `YOLOModel::predict_image` in library code.
195195
| `cudarc-* build script failed: \`nvcc --version\` failed` | Set `PATH` to include the toolkit's `bin/`, or set `CUDARC_CUDA_VERSION` (see above). |
196196
| `libcudart.so.13: cannot open shared object file` | Toolkit not installed or not on `ld.so` path. Verify `ldconfig -p \| grep libcudart.so`. |
197197
| `libnvinfer.so.10: cannot open shared object file` | TensorRT not installed. Required for `tensorrt` and `cuda-preprocess` features. |
198-
| TRT engine build is slow on first run | Expected engines are cached under `.trt_cache/`. Subsequent runs reuse them. |
198+
| TRT engine build is slow on first run | Expected - engines are cached under `.trt_cache/`. Subsequent runs reuse them. |
199199
| Build hits `Must specify one of the following features: [cuda-13020, ...]` | Your environment has neither `nvcc` on `PATH` nor `CUDARC_CUDA_VERSION` set. Pick one. |

0 commit comments

Comments
 (0)