ultralytics 8.2.80__py3-none-any.whl → 8.2.82__py3-none-any.whl

ultralytics/engine/trainer.py

@@ -56,8 +56,6 @@ from ultralytics.utils.torch_utils import (
 
 class BaseTrainer:
     """
-    BaseTrainer.
-
     A base class for creating trainers.
 
     Attributes:
@@ -230,7 +228,6 @@ class BaseTrainer:
 
     def _setup_train(self, world_size):
         """Builds dataloaders and optimizer on correct rank process."""
-
         # Model
         self.run_callbacks("on_pretrain_routine_start")
         ckpt = self.setup_model()
@@ -478,12 +475,16 @@ class BaseTrainer:
         torch.cuda.empty_cache()
         self.run_callbacks("teardown")
 
+    def read_results_csv(self):
+        """Read results.csv into a dict using pandas."""
+        import pandas as pd  # scope for faster 'import ultralytics'
+
+        return {k.strip(): v for k, v in pd.read_csv(self.csv).to_dict(orient="list").items()}
+
     def save_model(self):
         """Save model training checkpoints with additional metadata."""
         import io
 
-        import pandas as pd  # scope for faster 'import ultralytics'
-
         # Serialize ckpt to a byte buffer once (faster than repeated torch.save() calls)
         buffer = io.BytesIO()
         torch.save(
@@ -496,7 +497,7 @@ class BaseTrainer:
                 "optimizer": convert_optimizer_state_dict_to_fp16(deepcopy(self.optimizer.state_dict())),
                 "train_args": vars(self.args),  # save as dict
                 "train_metrics": {**self.metrics, **{"fitness": self.fitness}},
-                "train_results": {k.strip(): v for k, v in pd.read_csv(self.csv).to_dict(orient="list").items()},
+                "train_results": self.read_results_csv(),
                 "date": datetime.now().isoformat(),
                 "version": __version__,
                 "license": "AGPL-3.0 (https://ultralytics.com/license)",
@@ -636,7 +637,7 @@ class BaseTrainer:
         pass
 
     def on_plot(self, name, data=None):
-        """Registers plots (e.g. to be consumed in callbacks)"""
+        """Registers plots (e.g. to be consumed in callbacks)."""
         path = Path(name)
         self.plots[path] = {"data": data, "timestamp": time.time()}
 
@@ -646,6 +647,9 @@ class BaseTrainer:
             if f.exists():
                 strip_optimizer(f)  # strip optimizers
                 if f is self.best:
+                    if self.last.is_file():  # update best.pt train_metrics from last.pt
+                        k = "train_results"
+                        torch.save({**torch.load(self.best), **{k: torch.load(self.last)[k]}}, self.best)
                     LOGGER.info(f"\nValidating {f}...")
                     self.validator.args.plots = self.args.plots
                     self.metrics = self.validator(model=f)
@@ -732,7 +736,6 @@ class BaseTrainer:
         Returns:
             (torch.optim.Optimizer): The constructed optimizer.
         """
-
         g = [], [], []  # optimizer parameter groups
         bn = tuple(v for k, v in nn.__dict__.items() if "Norm" in k)  # normalization layers, i.e. BatchNorm2d()
         if name == "auto":

ultralytics/engine/tuner.py

@@ -1,7 +1,7 @@
 # Ultralytics YOLO 🚀, AGPL-3.0 license
 """
-This module provides functionalities for hyperparameter tuning of the Ultralytics YOLO models for object detection,
-instance segmentation, image classification, pose estimation, and multi-object tracking.
+Module provides functionalities for hyperparameter tuning of the Ultralytics YOLO models for object detection, instance
+segmentation, image classification, pose estimation, and multi-object tracking.
 
 Hyperparameter tuning is the process of systematically searching for the optimal set of hyperparameters
 that yield the best model performance. This is particularly crucial in deep learning models like YOLO,
@@ -12,8 +12,8 @@ Example:
     ```python
     from ultralytics import YOLO
 
-    model = YOLO('yolov8n.pt')
-    model.tune(data='coco8.yaml', epochs=10, iterations=300, optimizer='AdamW', plots=False, save=False, val=False)
+    model = YOLO("yolov8n.pt")
+    model.tune(data="coco8.yaml", epochs=10, iterations=300, optimizer="AdamW", plots=False, save=False, val=False)
     ```
 """
 
@@ -54,15 +54,15 @@ class Tuner:
         ```python
         from ultralytics import YOLO
 
-        model = YOLO('yolov8n.pt')
-        model.tune(data='coco8.yaml', epochs=10, iterations=300, optimizer='AdamW', plots=False, save=False, val=False)
+        model = YOLO("yolov8n.pt")
+        model.tune(data="coco8.yaml", epochs=10, iterations=300, optimizer="AdamW", plots=False, save=False, val=False)
         ```
 
         Tune with custom search space.
         ```python
         from ultralytics import YOLO
 
-        model = YOLO('yolov8n.pt')
+        model = YOLO("yolov8n.pt")
         model.tune(space={key1: val1, key2: val2})  # custom search space dictionary
         ```
     """
@@ -176,7 +176,6 @@ class Tuner:
            The method utilizes the `self.tune_csv` Path object to read and log hyperparameters and fitness scores.
            Ensure this path is set correctly in the Tuner instance.
         """
-
         t0 = time.time()
         best_save_dir, best_metrics = None, None
         (self.tune_dir / "weights").mkdir(parents=True, exist_ok=True)

ultralytics/engine/validator.py

@@ -104,9 +104,7 @@ class BaseValidator:
 
     @smart_inference_mode()
     def __call__(self, trainer=None, model=None):
-        """Supports validation of a pre-trained model if passed or a model being trained if trainer is passed (trainer
-        gets priority).
-        """
+        """Executes validation process, running inference on dataloader and computing performance metrics."""
         self.training = trainer is not None
         augment = self.args.augment and (not self.training)
         if self.training:
@@ -280,7 +278,7 @@ class BaseValidator:
         return batch
 
     def postprocess(self, preds):
-        """Describes and summarizes the purpose of 'postprocess()' but no details mentioned."""
+        """Preprocesses the predictions."""
         return preds
 
     def init_metrics(self, model):
@@ -317,7 +315,7 @@ class BaseValidator:
         return []
 
     def on_plot(self, name, data=None):
-        """Registers plots (e.g. to be consumed in callbacks)"""
+        """Registers plots (e.g. to be consumed in callbacks)."""
         self.plots[Path(name)] = {"data": data, "timestamp": time.time()}
 
     # TODO: may need to put these following functions into callback

ultralytics/hub/__init__.py

@@ -136,11 +136,11 @@ def check_dataset(path: str, task: str) -> None:
         ```python
         from ultralytics.hub import check_dataset
 
-        check_dataset('path/to/coco8.zip', task='detect')  # detect dataset
-        check_dataset('path/to/coco8-seg.zip', task='segment')  # segment dataset
-        check_dataset('path/to/coco8-pose.zip', task='pose')  # pose dataset
-        check_dataset('path/to/dota8.zip', task='obb')  # OBB dataset
-        check_dataset('path/to/imagenet10.zip', task='classify')  # classification dataset
+        check_dataset("path/to/coco8.zip", task="detect")  # detect dataset
+        check_dataset("path/to/coco8-seg.zip", task="segment")  # segment dataset
+        check_dataset("path/to/coco8-pose.zip", task="pose")  # pose dataset
+        check_dataset("path/to/dota8.zip", task="obb")  # OBB dataset
+        check_dataset("path/to/imagenet10.zip", task="classify")  # classification dataset
         ```
     """
     HUBDatasetStats(path=path, task=task).get_json()

ultralytics/hub/auth.py

@@ -27,10 +27,14 @@ class Auth:
 
     def __init__(self, api_key="", verbose=False):
         """
-        Initialize the Auth class with an optional API key.
+        Initialize Auth class and authenticate user.
+
+        Handles API key validation, Google Colab authentication, and new key requests. Updates SETTINGS upon successful
+        authentication.
 
         Args:
-            api_key (str, optional): May be an API key or a combination API key and model ID, i.e. key_id
+            api_key (str): API key or combined key_id format.
+            verbose (bool): Enable verbose logging.
         """
         # Split the input API key in case it contains a combined key_model and keep only the API key part
         api_key = api_key.split("_")[0]

ultralytics/hub/session.py

@@ -1,5 +1,6 @@
 # Ultralytics YOLO 🚀, AGPL-3.0 license
 
+import shutil
 import threading
 import time
 from http import HTTPStatus
@@ -158,7 +159,6 @@ class HUBTrainingSession:
         Raises:
             HUBModelError: If the identifier format is not recognized.
         """
-
         # Initialize variables
         api_key, model_id, filename = None, None, None
 
@@ -199,7 +199,6 @@ class HUBTrainingSession:
             ValueError: If the model is already trained, if required dataset information is missing, or if there are
                 issues with the provided training arguments.
         """
-
         if self.model.is_resumable():
             # Model has saved weights
             self.train_args = {"data": self.model.get_dataset_url(), "resume": True}
@@ -275,7 +274,7 @@ class HUBTrainingSession:
 
             # if request related to metrics upload and exceed retries
             if response is None and kwargs.get("metrics"):
-                self.metrics_upload_failed_queue.update(kwargs.get("metrics", None))
+                self.metrics_upload_failed_queue.update(kwargs.get("metrics"))
 
             return response
 
@@ -344,23 +343,34 @@ class HUBTrainingSession:
             map (float): Mean average precision of the model.
             final (bool): Indicates if the model is the final model after training.
         """
-        if Path(weights).is_file():
-            progress_total = Path(weights).stat().st_size if final else None  # Only show progress if final
-            self.request_queue(
-                self.model.upload_model,
-                epoch=epoch,
-                weights=weights,
-                is_best=is_best,
-                map=map,
-                final=final,
-                retry=10,
-                timeout=3600,
-                thread=not final,
-                progress_total=progress_total,
-                stream_response=True,
-            )
-        else:
-            LOGGER.warning(f"{PREFIX}WARNING ⚠️ Model upload issue. Missing model {weights}.")
+        weights = Path(weights)
+        if not weights.is_file():
+            last = weights.with_name("last" + weights.suffix)
+            if final and last.is_file():
+                LOGGER.warning(
+                    f"{PREFIX} WARNING ⚠️ Model 'best.pt' not found, copying 'last.pt' to 'best.pt' and uploading. "
+                    "This often happens when resuming training in transient environments like Google Colab. "
+                    "For more reliable training, consider using Ultralytics HUB Cloud. "
+                    "Learn more at https://docs.ultralytics.com/hub/cloud-training."
+                )
+                shutil.copy(last, weights)  # copy last.pt to best.pt
+            else:
+                LOGGER.warning(f"{PREFIX} WARNING ⚠️ Model upload issue. Missing model {weights}.")
+                return
+
+        self.request_queue(
+            self.model.upload_model,
+            epoch=epoch,
+            weights=str(weights),
+            is_best=is_best,
+            map=map,
+            final=final,
+            retry=10,
+            timeout=3600,
+            thread=not final,
+            progress_total=weights.stat().st_size if final else None,  # only show progress if final
+            stream_response=True,
+        )
 
     @staticmethod
     def _show_upload_progress(content_length: int, response: requests.Response) -> None:

ultralytics/models/fastsam/model.py

@@ -16,8 +16,8 @@ class FastSAM(Model):
         ```python
         from ultralytics import FastSAM
 
-        model = FastSAM('last.pt')
-        results = model.predict('ultralytics/assets/bus.jpg')
+        model = FastSAM("last.pt")
+        results = model.predict("ultralytics/assets/bus.jpg")
         ```
     """
 
@@ -30,18 +30,21 @@ class FastSAM(Model):
 
     def predict(self, source, stream=False, bboxes=None, points=None, labels=None, texts=None, **kwargs):
         """
-        Performs segmentation prediction on the given image or video source.
+        Perform segmentation prediction on image or video source.
+
+        Supports prompted segmentation with bounding boxes, points, labels, and texts.
 
         Args:
-            source (str): Path to the image or video file, or a PIL.Image object, or a numpy.ndarray object.
-            stream (bool, optional): If True, enables real-time streaming. Defaults to False.
-            bboxes (list, optional): List of bounding box coordinates for prompted segmentation. Defaults to None.
-            points (list, optional): List of points for prompted segmentation. Defaults to None.
-            labels (list, optional): List of labels for prompted segmentation. Defaults to None.
-            texts (list, optional): List of texts for prompted segmentation. Defaults to None.
+            source (str | PIL.Image | numpy.ndarray): Input source.
+            stream (bool): Enable real-time streaming.
+            bboxes (list): Bounding box coordinates for prompted segmentation.
+            points (list): Points for prompted segmentation.
+            labels (list): Labels for prompted segmentation.
+            texts (list): Texts for prompted segmentation.
+            **kwargs (Any): Additional keyword arguments.
 
         Returns:
-            (list): The model predictions.
+            (list): Model predictions.
         """
         prompts = dict(bboxes=bboxes, points=points, labels=labels, texts=texts)
         return super().predict(source, stream, prompts=prompts, **kwargs)

ultralytics/models/fastsam/predict.py

@@ -92,8 +92,8 @@ class FastSAMPredictor(SegmentationPredictor):
                     if labels.sum() == 0  # all negative points
                     else torch.zeros(len(result), dtype=torch.bool, device=self.device)
                 )
-                for p, l in zip(points, labels):
-                    point_idx[torch.nonzero(masks[:, p[1], p[0]], as_tuple=True)[0]] = True if l else False
+                for point, label in zip(points, labels):
+                    point_idx[torch.nonzero(masks[:, point[1], point[0]], as_tuple=True)[0]] = True if label else False
                 idx |= point_idx
             if texts is not None:
                 if isinstance(texts, str):

ultralytics/models/fastsam/utils.py

@@ -13,7 +13,6 @@ def adjust_bboxes_to_image_border(boxes, image_shape, threshold=20):
     Returns:
         adjusted_boxes (torch.Tensor): adjusted bounding boxes
     """
-
     # Image dimensions
     h, w = image_shape
 

ultralytics/models/nas/model.py

@@ -6,8 +6,8 @@ Example:
     ```python
     from ultralytics import NAS
 
-    model = NAS('yolo_nas_s')
-    results = model.predict('ultralytics/assets/bus.jpg')
+    model = NAS("yolo_nas_s")
+    results = model.predict("ultralytics/assets/bus.jpg")
     ```
 """
 
@@ -34,8 +34,8 @@ class NAS(Model):
         ```python
         from ultralytics import NAS
 
-        model = NAS('yolo_nas_s')
-        results = model.predict('ultralytics/assets/bus.jpg')
+        model = NAS("yolo_nas_s")
+        results = model.predict("ultralytics/assets/bus.jpg")
         ```
 
     Attributes:

ultralytics/models/nas/predict.py

@@ -22,7 +22,7 @@ class NASPredictor(BasePredictor):
         ```python
         from ultralytics import NAS
 
-        model = NAS('yolo_nas_s')
+        model = NAS("yolo_nas_s")
         predictor = model.predictor
         # Assumes that raw_preds, img, orig_imgs are available
         results = predictor.postprocess(raw_preds, img, orig_imgs)
@@ -34,7 +34,6 @@ class NASPredictor(BasePredictor):
 
     def postprocess(self, preds_in, img, orig_imgs):
         """Postprocess predictions and returns a list of Results objects."""
-
         # Cat boxes and class scores
         boxes = ops.xyxy2xywh(preds_in[0][0])
         preds = torch.cat((boxes, preds_in[0][1]), -1).permute(0, 2, 1)

ultralytics/models/nas/val.py

@@ -24,7 +24,7 @@ class NASValidator(DetectionValidator):
         ```python
         from ultralytics import NAS
 
-        model = NAS('yolo_nas_s')
+        model = NAS("yolo_nas_s")
         validator = model.validator
         # Assumes that raw_preds are available
         final_preds = validator.postprocess(raw_preds)

ultralytics/models/rtdetr/predict.py

@@ -21,7 +21,7 @@ class RTDETRPredictor(BasePredictor):
         from ultralytics.utils import ASSETS
         from ultralytics.models.rtdetr import RTDETRPredictor
 
-        args = dict(model='rtdetr-l.pt', source=ASSETS)
+        args = dict(model="rtdetr-l.pt", source=ASSETS)
         predictor = RTDETRPredictor(overrides=args)
         predictor.predict_cli()
         ```

ultralytics/models/rtdetr/train.py

@@ -25,7 +25,7 @@ class RTDETRTrainer(DetectionTrainer):
         ```python
         from ultralytics.models.rtdetr.train import RTDETRTrainer
 
-        args = dict(model='rtdetr-l.yaml', data='coco8.yaml', imgsz=640, epochs=3)
+        args = dict(model="rtdetr-l.yaml", data="coco8.yaml", imgsz=640, epochs=3)
         trainer = RTDETRTrainer(overrides=args)
         trainer.train()
         ```

ultralytics/models/rtdetr/val.py

@@ -62,7 +62,7 @@ class RTDETRValidator(DetectionValidator):
         ```python
         from ultralytics.models.rtdetr import RTDETRValidator
 
-        args = dict(model='rtdetr-l.pt', data='coco8.yaml')
+        args = dict(model="rtdetr-l.pt", data="coco8.yaml")
         validator = RTDETRValidator(args=args)
         validator()
         ```

ultralytics/models/sam/model.py

@@ -41,8 +41,8 @@ class SAM(Model):
         info: Logs information about the SAM model.
 
     Examples:
-        >>> sam = SAM('sam_b.pt')
-        >>> results = sam.predict('image.jpg', points=[[500, 375]])
+        >>> sam = SAM("sam_b.pt")
+        >>> results = sam.predict("image.jpg", points=[[500, 375]])
         >>> for r in results:
         >>>     print(f"Detected {len(r.masks)} masks")
     """
@@ -58,7 +58,7 @@ class SAM(Model):
             NotImplementedError: If the model file extension is not .pt or .pth.
 
         Examples:
-            >>> sam = SAM('sam_b.pt')
+            >>> sam = SAM("sam_b.pt")
             >>> print(sam.is_sam2)
         """
         if model and Path(model).suffix not in {".pt", ".pth"}:
@@ -78,8 +78,8 @@ class SAM(Model):
             task (str | None): Task name. If provided, it specifies the particular task the model is being loaded for.
 
         Examples:
-            >>> sam = SAM('sam_b.pt')
-            >>> sam._load('path/to/custom_weights.pt')
+            >>> sam = SAM("sam_b.pt")
+            >>> sam._load("path/to/custom_weights.pt")
         """
         self.model = build_sam(weights)
 
@@ -100,8 +100,8 @@ class SAM(Model):
             (List): The model predictions.
 
         Examples:
-            >>> sam = SAM('sam_b.pt')
-            >>> results = sam.predict('image.jpg', points=[[500, 375]])
+            >>> sam = SAM("sam_b.pt")
+            >>> results = sam.predict("image.jpg", points=[[500, 375]])
             >>> for r in results:
             ...     print(f"Detected {len(r.masks)} masks")
         """
@@ -130,8 +130,8 @@ class SAM(Model):
             (List): The model predictions, typically containing segmentation masks and other relevant information.
 
         Examples:
-            >>> sam = SAM('sam_b.pt')
-            >>> results = sam('image.jpg', points=[[500, 375]])
+            >>> sam = SAM("sam_b.pt")
+            >>> results = sam("image.jpg", points=[[500, 375]])
             >>> print(f"Detected {len(results[0].masks)} masks")
         """
         return self.predict(source, stream, bboxes, points, labels, **kwargs)
@@ -151,7 +151,7 @@ class SAM(Model):
             (Tuple): A tuple containing the model's information (string representations of the model).
 
         Examples:
-            >>> sam = SAM('sam_b.pt')
+            >>> sam = SAM("sam_b.pt")
             >>> info = sam.info()
             >>> print(info[0])  # Print summary information
         """
@@ -167,7 +167,7 @@ class SAM(Model):
                 class. For SAM2 models, it maps to SAM2Predictor, otherwise to the standard Predictor.
 
         Examples:
-            >>> sam = SAM('sam_b.pt')
+            >>> sam = SAM("sam_b.pt")
             >>> task_map = sam.task_map
             >>> print(task_map)
             {'segment': <class 'ultralytics.models.sam.predict.Predictor'>}

ultralytics/models/sam/modules/decoders.py

@@ -32,8 +32,9 @@ class MaskDecoder(nn.Module):
 
     Examples:
         >>> decoder = MaskDecoder(transformer_dim=256, transformer=transformer_module)
-        >>> masks, iou_pred = decoder(image_embeddings, image_pe, sparse_prompt_embeddings,
-        ...                           dense_prompt_embeddings, multimask_output=True)
+        >>> masks, iou_pred = decoder(
+        ...     image_embeddings, image_pe, sparse_prompt_embeddings, dense_prompt_embeddings, multimask_output=True
+        ... )
         >>> print(f"Predicted masks shape: {masks.shape}, IoU predictions shape: {iou_pred.shape}")
     """
 
@@ -213,7 +214,8 @@ class SAM2MaskDecoder(nn.Module):
         >>> dense_prompt_embeddings = torch.rand(1, 256, 64, 64)
         >>> decoder = SAM2MaskDecoder(256, transformer)
         >>> masks, iou_pred, sam_tokens_out, obj_score_logits = decoder.forward(
-        ...     image_embeddings, image_pe, sparse_prompt_embeddings, dense_prompt_embeddings, True, False)
+        ...     image_embeddings, image_pe, sparse_prompt_embeddings, dense_prompt_embeddings, True, False
+        ... )
     """
 
     def __init__(
@@ -345,7 +347,8 @@ class SAM2MaskDecoder(nn.Module):
             >>> dense_prompt_embeddings = torch.rand(1, 256, 64, 64)
             >>> decoder = SAM2MaskDecoder(256, transformer)
             >>> masks, iou_pred, sam_tokens_out, obj_score_logits = decoder.forward(
-            ...     image_embeddings, image_pe, sparse_prompt_embeddings, dense_prompt_embeddings, True, False)
+            ...     image_embeddings, image_pe, sparse_prompt_embeddings, dense_prompt_embeddings, True, False
+            ... )
         """
         masks, iou_pred, mask_tokens_out, object_score_logits = self.predict_masks(
             image_embeddings=image_embeddings,

ultralytics/models/sam/modules/sam.py

@@ -417,7 +417,15 @@ class SAM2Model(torch.nn.Module):
             >>> point_inputs = {"point_coords": torch.rand(1, 2, 2), "point_labels": torch.tensor([[1, 0]])}
             >>> mask_inputs = torch.rand(1, 1, 512, 512)
             >>> results = model._forward_sam_heads(backbone_features, point_inputs, mask_inputs)
-            >>> low_res_multimasks, high_res_multimasks, ious, low_res_masks, high_res_masks, obj_ptr, object_score_logits = results
+            >>> (
+            ...     low_res_multimasks,
+            ...     high_res_multimasks,
+            ...     ious,
+            ...     low_res_masks,
+            ...     high_res_masks,
+            ...     obj_ptr,
+            ...     object_score_logits,
+            ... ) = results
         """
         B = backbone_features.size(0)
         device = backbone_features.device

ultralytics/models/sam/modules/tiny_encoder.py

@@ -716,7 +716,7 @@ class BasicLayer(nn.Module):
 
         Examples:
             >>> layer = BasicLayer(dim=96, input_resolution=(56, 56), depth=2, num_heads=3, window_size=7)
-            >>> x = torch.randn(1, 56*56, 96)
+            >>> x = torch.randn(1, 56 * 56, 96)
             >>> output = layer(x)
             >>> print(output.shape)
         """

ultralytics/models/sam/modules/transformer.py

@@ -232,7 +232,6 @@ class TwoWayAttentionBlock(nn.Module):
 
     def forward(self, queries: Tensor, keys: Tensor, query_pe: Tensor, key_pe: Tensor) -> Tuple[Tensor, Tensor]:
         """Applies two-way attention to process query and key embeddings in a transformer block."""
-
         # Self attention block
         if self.skip_first_layer_pe:
             queries = self.self_attn(q=queries, k=queries, v=queries)
@@ -353,7 +352,6 @@ class Attention(nn.Module):
 
     def forward(self, q: Tensor, k: Tensor, v: Tensor) -> Tensor:
         """Applies multi-head attention to query, key, and value tensors with optional downsampling."""
-
         # Input projections
         q = self.q_proj(q)
         k = self.k_proj(k)

ultralytics/models/sam/modules/utils.py

@@ -22,7 +22,7 @@ def select_closest_cond_frames(frame_idx, cond_frame_outputs, max_cond_frame_num
 
     Examples:
         >>> frame_idx = 5
-        >>> cond_frame_outputs = {1: 'a', 3: 'b', 7: 'c', 9: 'd'}
+        >>> cond_frame_outputs = {1: "a", 3: "b", 7: "c", 9: "d"}
         >>> max_cond_frame_num = 2
         >>> selected, unselected = select_closest_cond_frames(frame_idx, cond_frame_outputs, max_cond_frame_num)
         >>> print(selected)

ultralytics/models/sam/predict.py

@@ -69,8 +69,8 @@ class Predictor(BasePredictor):
 
     Examples:
         >>> predictor = Predictor()
-        >>> predictor.setup_model(model_path='sam_model.pt')
-        >>> predictor.set_image('image.jpg')
+        >>> predictor.setup_model(model_path="sam_model.pt")
+        >>> predictor.set_image("image.jpg")
         >>> masks, scores, boxes = predictor.generate()
         >>> results = predictor.postprocess((masks, scores, boxes), im, orig_img)
     """
@@ -90,8 +90,8 @@ class Predictor(BasePredictor):
 
         Examples:
             >>> predictor = Predictor(cfg=DEFAULT_CFG)
-            >>> predictor = Predictor(overrides={'imgsz': 640})
-            >>> predictor = Predictor(_callbacks={'on_predict_start': custom_callback})
+            >>> predictor = Predictor(overrides={"imgsz": 640})
+            >>> predictor = Predictor(_callbacks={"on_predict_start": custom_callback})
         """
         if overrides is None:
             overrides = {}
@@ -188,8 +188,8 @@ class Predictor(BasePredictor):
 
         Examples:
             >>> predictor = Predictor()
-            >>> predictor.setup_model(model_path='sam_model.pt')
-            >>> predictor.set_image('image.jpg')
+            >>> predictor.setup_model(model_path="sam_model.pt")
+            >>> predictor.set_image("image.jpg")
             >>> masks, scores, logits = predictor.inference(im, bboxes=[[0, 0, 100, 100]])
         """
         # Override prompts if any stored in self.prompts
@@ -475,8 +475,8 @@ class Predictor(BasePredictor):
 
         Examples:
             >>> predictor = Predictor()
-            >>> predictor.setup_source('path/to/images')
-            >>> predictor.setup_source('video.mp4')
+            >>> predictor.setup_source("path/to/images")
+            >>> predictor.setup_source("video.mp4")
             >>> predictor.setup_source(None)  # Uses default source if available
 
         Notes:
@@ -504,8 +504,8 @@ class Predictor(BasePredictor):
 
         Examples:
             >>> predictor = Predictor()
-            >>> predictor.set_image('path/to/image.jpg')
-            >>> predictor.set_image(cv2.imread('path/to/image.jpg'))
+            >>> predictor.set_image("path/to/image.jpg")
+            >>> predictor.set_image(cv2.imread("path/to/image.jpg"))
 
         Notes:
             - This method should be called before performing inference on a new image.