Reference for ultralytics/engine/predictor.py
Note
Full source code for this file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/predictor.py. Help us fix any issues you see by submitting a Pull Request 🛠️. Thank you 🙏!
ultralytics.engine.predictor.BasePredictor
BasePredictor
A base class for creating predictors.
Attributes:
Name | Type | Description |
---|---|---|
args |
SimpleNamespace
|
Configuration for the predictor. |
save_dir |
Path
|
Directory to save results. |
done_warmup |
bool
|
Whether the predictor has finished setup. |
model |
Module
|
Model used for prediction. |
data |
dict
|
Data configuration. |
device |
device
|
Device used for prediction. |
dataset |
Dataset
|
Dataset used for prediction. |
vid_path |
str
|
Path to video file. |
vid_writer |
VideoWriter
|
Video writer for saving video output. |
data_path |
str
|
Path to data. |
Source code in ultralytics/engine/predictor.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
|
__call__(source=None, model=None, stream=False, *args, **kwargs)
Performs inference on an image or stream.
Source code in ultralytics/engine/predictor.py
__init__(cfg=DEFAULT_CFG, overrides=None, _callbacks=None)
Initializes the BasePredictor class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cfg |
str
|
Path to a configuration file. Defaults to DEFAULT_CFG. |
DEFAULT_CFG
|
overrides |
dict
|
Configuration overrides. Defaults to None. |
None
|
Source code in ultralytics/engine/predictor.py
add_callback(event, func)
postprocess(preds, img, orig_imgs)
pre_transform(im)
Pre-transform input image before inference.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
im |
List(np.ndarray
|
(N, 3, h, w) for tensor, [(h, w, 3) x N] for list. |
required |
Returns:
Type | Description |
---|---|
list
|
A list of transformed images. |
Source code in ultralytics/engine/predictor.py
predict_cli(source=None, model=None)
Method used for CLI prediction. It uses always generator as outputs as not required by CLI mode.
Source code in ultralytics/engine/predictor.py
preprocess(im)
Prepares input image before inference.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
im |
torch.Tensor | List(np.ndarray
|
BCHW for tensor, [(HWC) x B] for list. |
required |
Source code in ultralytics/engine/predictor.py
run_callbacks(event)
save_preds(vid_cap, idx, save_path)
Save video predictions as mp4 at specified path.
Source code in ultralytics/engine/predictor.py
setup_model(model, verbose=True)
Initialize YOLO model with given parameters and set it to evaluation mode.
Source code in ultralytics/engine/predictor.py
setup_source(source)
Sets up source and inference mode.
Source code in ultralytics/engine/predictor.py
show(p)
Display an image in a window using OpenCV imshow().
Source code in ultralytics/engine/predictor.py
stream_inference(source=None, model=None, *args, **kwargs)
Streams real-time inference on camera feed and saves results to file.
Source code in ultralytics/engine/predictor.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
|
write_results(idx, results, batch)
Write inference results to a file or directory.