Reference for ultralytics/models/yolo/classify/val.py
Note
This file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/val.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
ultralytics.models.yolo.classify.val.ClassificationValidator
ClassificationValidator(
dataloader=None, save_dir=None, pbar=None, args=None, _callbacks=None
)
Bases: BaseValidator
A class extending the BaseValidator class for validation based on a classification model.
This validator handles the validation process for classification models, including metrics calculation, confusion matrix generation, and visualization of results.
Attributes:
Name | Type | Description |
---|---|---|
targets |
List[Tensor]
|
Ground truth class labels. |
pred |
List[Tensor]
|
Model predictions. |
metrics |
ClassifyMetrics
|
Object to calculate and store classification metrics. |
names |
dict
|
Mapping of class indices to class names. |
nc |
int
|
Number of classes. |
confusion_matrix |
ConfusionMatrix
|
Matrix to evaluate model performance across classes. |
Methods:
Name | Description |
---|---|
get_desc |
Return a formatted string summarizing classification metrics. |
init_metrics |
Initialize confusion matrix, class names, and tracking containers. |
preprocess |
Preprocess input batch by moving data to device. |
update_metrics |
Update running metrics with model predictions and batch targets. |
finalize_metrics |
Finalize metrics including confusion matrix and processing speed. |
postprocess |
Extract the primary prediction from model output. |
get_stats |
Calculate and return a dictionary of metrics. |
build_dataset |
Create a ClassificationDataset instance for validation. |
get_dataloader |
Build and return a data loader for classification validation. |
print_results |
Print evaluation metrics for the classification model. |
plot_val_samples |
Plot validation image samples with their ground truth labels. |
plot_predictions |
Plot images with their predicted class labels. |
Examples:
>>> from ultralytics.models.yolo.classify import ClassificationValidator
>>> args = dict(model="yolo11n-cls.pt", data="imagenet10")
>>> validator = ClassificationValidator(args=args)
>>> validator()
Notes
Torchvision classification models can also be passed to the 'model' argument, i.e. model='resnet18'.
This validator handles the validation process for classification models, including metrics calculation, confusion matrix generation, and visualization of results.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dataloader
|
DataLoader
|
Dataloader to use for validation. |
None
|
save_dir
|
str | Path
|
Directory to save results. |
None
|
pbar
|
bool
|
Display a progress bar. |
None
|
args
|
dict
|
Arguments containing model and validation configuration. |
None
|
_callbacks
|
list
|
List of callback functions to be called during validation. |
None
|
Examples:
>>> from ultralytics.models.yolo.classify import ClassificationValidator
>>> args = dict(model="yolo11n-cls.pt", data="imagenet10")
>>> validator = ClassificationValidator(args=args)
>>> validator()
Source code in ultralytics/models/yolo/classify/val.py
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
|
build_dataset
build_dataset(img_path)
Create a ClassificationDataset instance for validation.
Source code in ultralytics/models/yolo/classify/val.py
148 149 150 |
|
finalize_metrics
finalize_metrics(*args, **kwargs)
Finalize metrics including confusion matrix and processing speed.
This method processes the accumulated predictions and targets to generate the confusion matrix, optionally plots it, and updates the metrics object with speed information.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
*args
|
Any
|
Variable length argument list. |
()
|
**kwargs
|
Any
|
Arbitrary keyword arguments. |
{}
|
Examples:
>>> validator = ClassificationValidator()
>>> validator.pred = [torch.tensor([[0, 1, 2]])] # Top-3 predictions for one sample
>>> validator.targets = [torch.tensor([0])] # Ground truth class
>>> validator.finalize_metrics()
>>> print(validator.metrics.confusion_matrix) # Access the confusion matrix
Source code in ultralytics/models/yolo/classify/val.py
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 |
|
get_dataloader
get_dataloader(dataset_path, batch_size)
Build and return a data loader for classification validation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dataset_path
|
str | Path
|
Path to the dataset directory. |
required |
batch_size
|
int
|
Number of samples per batch. |
required |
Returns:
Type | Description |
---|---|
DataLoader
|
DataLoader object for the classification validation dataset. |
Source code in ultralytics/models/yolo/classify/val.py
152 153 154 155 156 157 158 159 160 161 162 163 164 |
|
get_desc
get_desc()
Return a formatted string summarizing classification metrics.
Source code in ultralytics/models/yolo/classify/val.py
77 78 79 |
|
get_stats
get_stats()
Calculate and return a dictionary of metrics by processing targets and predictions.
Source code in ultralytics/models/yolo/classify/val.py
143 144 145 146 |
|
init_metrics
init_metrics(model)
Initialize confusion matrix, class names, and tracking containers for predictions and targets.
Source code in ultralytics/models/yolo/classify/val.py
81 82 83 84 85 86 87 |
|
plot_predictions
plot_predictions(batch, preds, ni)
Plot images with their predicted class labels and save the visualization.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
batch
|
dict
|
Batch data containing images and other information. |
required |
preds
|
Tensor
|
Model predictions with shape (batch_size, num_classes). |
required |
ni
|
int
|
Batch index used for naming the output file. |
required |
Examples:
>>> validator = ClassificationValidator()
>>> batch = {"img": torch.rand(16, 3, 224, 224)}
>>> preds = torch.rand(16, 10) # 16 images, 10 classes
>>> validator.plot_predictions(batch, preds, 0)
Source code in ultralytics/models/yolo/classify/val.py
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
|
plot_val_samples
plot_val_samples(batch, ni)
Plot validation image samples with their ground truth labels.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
batch
|
dict
|
Dictionary containing batch data with 'img' (images) and 'cls' (class labels). |
required |
ni
|
int
|
Batch index used for naming the output file. |
required |
Examples:
>>> validator = ClassificationValidator()
>>> batch = {"img": torch.rand(16, 3, 224, 224), "cls": torch.randint(0, 10, (16,))}
>>> validator.plot_val_samples(batch, 0)
Source code in ultralytics/models/yolo/classify/val.py
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
|
postprocess
postprocess(preds)
Extract the primary prediction from model output if it's in a list or tuple format.
Source code in ultralytics/models/yolo/classify/val.py
139 140 141 |
|
preprocess
preprocess(batch)
Preprocess input batch by moving data to device and converting to appropriate dtype.
Source code in ultralytics/models/yolo/classify/val.py
89 90 91 92 93 94 |
|
print_results
print_results()
Print evaluation metrics for the classification model.
Source code in ultralytics/models/yolo/classify/val.py
166 167 168 169 |
|
update_metrics
update_metrics(preds, batch)
Update running metrics with model predictions and batch targets.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
preds
|
Tensor
|
Model predictions, typically logits or probabilities for each class. |
required |
batch
|
dict
|
Batch data containing images and class labels. |
required |
This method appends the top-N predictions (sorted by confidence in descending order) to the prediction list for later evaluation. N is limited to the minimum of 5 and the number of classes.
Source code in ultralytics/models/yolo/classify/val.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
|