Reference for ultralytics/engine/tuner.py#

class Tuner:
    """A class for hyperparameter tuning of YOLO models.

    The class evolves YOLO model hyperparameters over a given number of iterations by mutating them according to the
    search space and retraining the model to evaluate their performance. Supports both local NDJSON storage and
    distributed MongoDB Atlas coordination for multi-machine hyperparameter optimization.

    Attributes:
        space (dict[str, tuple]): Hyperparameter search space containing bounds and scaling factors for mutation.
        tune_dir (Path): Directory where evolution logs and results will be saved.
        tune_file (Path): Path to the NDJSON file where evolution logs are saved.
        args (SimpleNamespace): Configuration arguments for the tuning process.
        callbacks (dict): Callback functions to be executed during tuning.
        prefix (str): Prefix string for logging messages.
        mongodb (MongoClient): Optional MongoDB client for distributed tuning.
        collection (Collection): MongoDB collection for storing tuning results.

    Methods:
        _mutate: Mutate hyperparameters based on bounds and scaling factors.
        __call__: Execute the hyperparameter evolution across multiple iterations.

    Examples:
        Tune hyperparameters for YOLO26n on COCO8 at imgsz=640 and epochs=10 for 300 tuning iterations.
        >>> from ultralytics import YOLO
        >>> model = YOLO("yolo26n.pt")
        >>> model.tune(
        >>>     data="coco8.yaml",
        >>>     epochs=10,
        >>>     iterations=300,
        >>>     plots=False,
        >>>     save=False,
        >>>     val=False
        >>> )

        Tune with distributed MongoDB Atlas coordination across multiple machines:
        >>> model.tune(
        >>>     data="coco8.yaml",
        >>>     epochs=10,
        >>>     iterations=300,
        >>>     mongodb_uri="mongodb+srv://user:pass@cluster.mongodb.net/",
        >>>     mongodb_db="ultralytics",
        >>>     mongodb_collection="tune_results"
        >>> )

        Tune with custom search space:
        >>> model.tune(space={"lr0": (1e-5, 1e-2), "momentum": (0.7, 0.98)})
    """

    def __init__(self, args=DEFAULT_CFG, _callbacks: dict | None = None):
        """Initialize the Tuner with configurations.

        Args:
            args (dict): Configuration for hyperparameter evolution.
            _callbacks (dict | None, optional): Callback functions to be executed during tuning.
        """
        self.space = args.pop("space", None) or {  # key: (min, max, gain(optional))
            # 'optimizer': tune.choice(['SGD', 'Adam', 'AdamW', 'NAdam', 'RAdam', 'RMSProp']),
            "lr0": (1e-5, 1e-2),  # initial learning rate (i.e. SGD=1E-2, Adam=1E-3)
            "lrf": (0.01, 1.0),  # final OneCycleLR learning rate (lr0 * lrf)
            "momentum": (0.7, 0.98, 0.3),  # SGD momentum/Adam beta1
            "weight_decay": (0.0, 0.001),  # optimizer weight decay 5e-4
            "warmup_epochs": (0.0, 5.0),  # warmup epochs (fractions ok)
            "warmup_momentum": (0.0, 0.95),  # warmup initial momentum
            "box": (1.0, 20.0),  # box loss gain
            "cls": (0.1, 4.0),  # cls loss gain (scale with pixels)
            "cls_pw": (0.0, 1.0),  # cls power weight
            "dfl": (0.4, 12.0),  # dfl loss gain
            "hsv_h": (0.0, 0.1),  # image HSV-Hue augmentation (fraction)
            "hsv_s": (0.0, 0.9),  # image HSV-Saturation augmentation (fraction)
            "hsv_v": (0.0, 0.9),  # image HSV-Value augmentation (fraction)
            "degrees": (0.0, 45.0),  # image rotation (+/- deg)
            "translate": (0.0, 0.9),  # image translation (+/- fraction)
            "scale": (0.0, 0.95),  # image scale (+/- gain)
            "shear": (0.0, 10.0),  # image shear (+/- deg)
            "perspective": (0.0, 0.001),  # image perspective (+/- fraction), range 0-0.001
            "flipud": (0.0, 1.0),  # image flip up-down (probability)
            "fliplr": (0.0, 1.0),  # image flip left-right (probability)
            "bgr": (0.0, 1.0),  # image channel bgr (probability)
            "mosaic": (0.0, 1.0),  # image mosaic (probability)
            "mixup": (0.0, 1.0),  # image mixup (probability)
            "cutmix": (0.0, 1.0),  # image cutmix (probability)
            "copy_paste": (0.0, 1.0),  # segment/obb copy-paste (object fraction)
            "close_mosaic": (0.0, 10.0),  # close dataloader mosaic (epochs)
        }
        mongodb_uri = args.pop("mongodb_uri", None)
        mongodb_db = args.pop("mongodb_db", "ultralytics")
        mongodb_collection = args.pop("mongodb_collection", "tuner_results")

        self.args = get_cfg(overrides=args)
        self.args.exist_ok = self.args.resume  # resume w/ same tune_dir
        self.tune_dir = get_save_dir(self.args, name=self.args.name or "tune")
        self.args.name, self.args.exist_ok, self.args.resume = (None, False, False)  # reset to not affect training
        self.tune_file = self.tune_dir / "tune_results.ndjson"
        self.callbacks = _callbacks or callbacks.get_default_callbacks()
        self.prefix = colorstr("Tuner: ")
        callbacks.add_integration_callbacks(self)

        # MongoDB Atlas support (optional)
        self.mongodb = None
        if mongodb_uri:
            self._init_mongodb(mongodb_uri, mongodb_db, mongodb_collection)

        LOGGER.info(
            f"{self.prefix}Initialized Tuner instance with 'tune_dir={self.tune_dir}'\n"
            f"{self.prefix}💡 Learn about tuning at https://docs.ultralytics.com/guides/hyperparameter-tuning"
        )

def __call__(self, iterations: int = 300, cleanup: bool = True):
    """Execute the hyperparameter evolution process when the Tuner instance is called.

    This method iterates through the specified number of iterations, performing the following steps:
    1. Sync MongoDB results to local NDJSON (if using distributed mode)
    2. Mutate hyperparameters using the best previous results or defaults
    3. Train a YOLO model with the mutated hyperparameters
    4. Log fitness scores and hyperparameters to MongoDB and/or NDJSON
    5. Track the best performing configuration across all iterations

    Args:
        iterations (int): The number of generations to run the evolution for.
        cleanup (bool): Whether to delete iteration weights to reduce storage space during tuning.
    """
    from ultralytics import YOLO
    from ultralytics.engine.trainer import MultiTrainer

    t0 = time.time()
    self.tune_dir.mkdir(parents=True, exist_ok=True)
    (self.tune_dir / "weights").mkdir(parents=True, exist_ok=True)
    best_save_dirs = {}
    n_successful = 0  # iters with real training metrics in this invocation (excludes resumed/MongoDB rows)

    # Sync MongoDB to local NDJSON at startup for proper resume logic
    if self.mongodb:
        self._sync_mongodb_to_file()

    start = 0
    if self.tune_file.exists():
        start = len(self._load_local_results())
        LOGGER.info(f"{self.prefix}Resuming tuning run {self.tune_dir} from iteration {start + 1}...")
    for i in range(start, iterations):
        # Mutate hyperparameters
        mutated_hyp = self._mutate()
        LOGGER.info(f"{self.prefix}Starting iteration {i + 1}/{iterations} with hyperparameters: {mutated_hyp}")

        train_args = {**vars(self.args), **mutated_hyp}
        data = train_args.pop("data")
        if not isinstance(data, (list, tuple)):
            data = [data]
        model = YOLO(train_args["model"])
        trainer = MultiTrainer(None, {**train_args, "data": data}, model.model)
        dataset_metrics = {dataset: metrics or {} for dataset, metrics in trainer.train().items()}
        save_dir = [trainer.save_dir / dataset for dataset in dataset_metrics]
        weights_dir = [s / "weights" for s in save_dir]
        metrics = trainer.mean_metrics
        fitness = sum((metrics or {}).get("fitness") or 0.0 for metrics in dataset_metrics.values()) / len(data)
        metrics["fitness"] = fitness
        result = self._result_record(
            i + 1,
            fitness,
            mutated_hyp,
            dataset_metrics,
            {dataset: str(s) for dataset, s in zip(dataset_metrics, save_dir)},
        )
        if self._has_training_metrics(result, require_all=True):
            n_successful += 1
        stop_after_iteration = False
        if self.mongodb:
            self._save_to_mongodb(fitness, mutated_hyp, metrics, dataset_metrics, result["save_dirs"])
            self._sync_mongodb_to_file()
            total_mongo_iterations = self.collection.count_documents({"fitness": {"$exists": True}})
            if total_mongo_iterations >= iterations:
                stop_after_iteration = True
        else:
            self._save_local_result(result)

        # Get best results
        results = self._load_local_results()
        x = self._local_results_to_array(results)
        fitness = x[:, 0]  # first column
        best_idx = self._best_result_index(results, fitness)
        best_result = results[best_idx]
        n_attempted = (i + 1) - start  # iters tried in this invocation
        current_best_save_dirs = best_result.get("save_dirs", {})
        best_is_current = best_result.get("save_dirs") == result["save_dirs"]
        if best_is_current:
            if cleanup:
                for s in best_save_dirs.values():
                    if s not in current_best_save_dirs.values():
                        shutil.rmtree(s, ignore_errors=True)
            for dataset, weight_dir in zip(dataset_metrics, weights_dir):
                best_weights_dir = (
                    self.tune_dir / "weights" if len(data) == 1 else self.tune_dir / "weights" / dataset
                )
                best_weights_dir.mkdir(parents=True, exist_ok=True)
                for ckpt in weight_dir.glob("*.pt"):
                    shutil.copy2(ckpt, best_weights_dir)
            best_save_dirs = current_best_save_dirs
        elif cleanup:
            for s in save_dir:
                shutil.rmtree(s, ignore_errors=True)  # remove iteration dirs to reduce storage space
            best_save_dirs = current_best_save_dirs

        # Plot tune results
        plot_tune_results(str(self.tune_file))

        # Save and print tune results
        if n_successful == n_attempted:
            status = "complete ✅"
        elif n_successful == 0:
            status = "complete (all failed) ❌"
        else:
            status = f"complete ({n_successful}/{n_attempted} succeeded) ⚠️"
        has_valid_best = self._has_training_metrics(best_result)
        header_lines = [
            f"{self.prefix}{i + 1}/{iterations} iterations {status} ({time.time() - t0:.2f}s)",
            f"{self.prefix}Results saved to {colorstr('bold', self.tune_dir)}",
        ]
        if has_valid_best:
            header_lines.extend(
                [
                    f"{self.prefix}Best fitness={fitness[best_idx]} observed at iteration {best_idx + 1}",
                    f"{self.prefix}Best fitness metrics are {self._best_metrics(best_result)}",
                    (
                        f"{self.prefix}Best fitness model is "
                        f"{self.tune_dir / 'weights' if len(best_result.get('datasets', {})) == 1 else 'not saved for multi-dataset tuning'}"
                    ),
                ]
            )
        header = "\n".join(header_lines)
        LOGGER.info("\n" + header)
        if not has_valid_best:
            LOGGER.error(
                f"{self.prefix}No iterations produced training metrics; skipping best_hyperparameters.yaml"
            )
        else:
            data = {
                k: int(v) if k in CFG_INT_KEYS else float(v) for k, v in zip(self.space.keys(), x[best_idx, 1:])
            }
            YAML.save(
                self.tune_dir / "best_hyperparameters.yaml",
                data=data,
                header=remove_colorstr(header.replace(self.prefix, "# ")) + "\n",
            )
            YAML.print(self.tune_dir / "best_hyperparameters.yaml")
        if stop_after_iteration:
            LOGGER.info(
                f"{self.prefix}Target iterations ({iterations}) reached in MongoDB ({total_mongo_iterations}). Stopping."
            )
            break

@staticmethod
def _best_metrics(result: dict) -> dict | None:
    """Summarize best-result metrics for logging."""
    datasets = result.get("datasets", {})
    if len(datasets) == 1:
        return next(iter(datasets.values()))
    if len(datasets) > 1:
        return {k: round(v.get("fitness") or 0.0, 5) for k, v in datasets.items()}
    return None

@classmethod
def _best_result_index(cls, results: list[dict], fitness: np.ndarray) -> int:
    """Return the best result index, preferring rows with training metrics."""
    valid = [i for i, result in enumerate(results) if cls._has_training_metrics(result)]
    return valid[int(fitness[valid].argmax())] if valid else int(fitness.argmax())

def _connect(self, uri: str = "", max_retries: int = 3):
    """Create MongoDB client with exponential backoff retry on connection failures.

    Args:
        uri (str): MongoDB connection string with credentials and cluster information.
        max_retries (int): Maximum number of connection attempts before giving up.

    Returns:
        (MongoClient): Connected MongoDB client instance.
    """
    check_requirements("pymongo")

    from pymongo import MongoClient
    from pymongo.errors import ConnectionFailure, ServerSelectionTimeoutError

    for attempt in range(max_retries):
        try:
            client = MongoClient(
                uri,
                serverSelectionTimeoutMS=30000,
                connectTimeoutMS=20000,
                socketTimeoutMS=40000,
                retryWrites=True,
                retryReads=True,
                maxPoolSize=30,
                minPoolSize=3,
                maxIdleTimeMS=60000,
            )
            client.admin.command("ping")  # Test connection
            LOGGER.info(f"{self.prefix}Connected to MongoDB Atlas (attempt {attempt + 1})")
            return client
        except (ConnectionFailure, ServerSelectionTimeoutError):
            if attempt == max_retries - 1:
                raise
            wait_time = 2**attempt
            LOGGER.warning(
                f"{self.prefix}MongoDB connection failed (attempt {attempt + 1}), retrying in {wait_time}s..."
            )
            time.sleep(wait_time)

def _constrain(self, hyp: dict[str, float]) -> dict[str, float]:
    """Constrain hyperparameters to their search bounds and configured types."""
    for k, bounds in self.space.items():
        if k in CFG_INT_KEYS:
            lower, upper = int(np.ceil(bounds[0])), int(np.floor(bounds[1]))
            if lower > upper:
                raise ValueError(f"{self.prefix}Search space for '{k}' contains no integer values")
            hyp[k] = min(max(round(hyp[k]), lower), upper)
        else:
            hyp[k] = min(max(round(hyp[k], 5), bounds[0]), bounds[1])

    return hyp

@staticmethod
def _has_training_metrics(result: dict, require_all: bool = False) -> bool:
    """Return whether a tuning result contains training metrics."""
    datasets = result.get("datasets", {})
    return bool(datasets) and (all(datasets.values()) if require_all else any(datasets.values()))

def _init_mongodb(self, mongodb_uri="", mongodb_db="", mongodb_collection=""):
    """Initialize MongoDB connection for distributed tuning.

    Connects to MongoDB Atlas for distributed hyperparameter optimization across multiple machines. Each worker
    saves results to a shared collection and reads the latest best hyperparameters from all workers for evolution.

    Args:
        mongodb_uri (str): MongoDB connection string.
        mongodb_db (str, optional): Database name.
        mongodb_collection (str, optional): Collection name.

    Notes:
        - Creates a fitness index when workers start a new collection
        - Falls back to local NDJSON mode if connection fails
        - Uses connection pooling and retry logic for production reliability
    """
    self.mongodb = self._connect(mongodb_uri)
    self.collection = self.mongodb[mongodb_db][mongodb_collection]
    LOGGER.info(f"{self.prefix}Using MongoDB Atlas for distributed tuning")

@staticmethod
def _json_default(x):
    """Convert tensor-like values for JSON serialization."""
    return x.item() if hasattr(x, "item") else str(x)

def _load_local_results(self) -> list[dict]:
    """Load local tuning results from the NDJSON log."""
    if not self.tune_file.exists():
        return []
    with open(self.tune_file, encoding="utf-8") as f:
        return [json.loads(line) for line in f if line.strip()]

def _local_results_to_array(self, results: list[dict]) -> np.ndarray | None:
    """Convert local NDJSON records to a fitness-plus-hyperparameters numpy array."""
    if not results:
        return None
    return np.array(
        [
            [r.get("fitness", 0.0)]
            + [r.get("hyperparameters", {}).get(k, getattr(self.args, k)) for k in self.space]
            for r in results
        ],
        dtype=float,
    )

def _mutate(
    self,
    n: int = 9,
    sigma: float = 0.2,
) -> dict[str, float]:
    """Mutate hyperparameters based on bounds and scaling factors specified in `self.space`.

    Args:
        n (int): Number of top parents to consider.
        sigma (float): Initial normalized mutation standard deviation.

    Returns:
        (dict[str, float]): A dictionary containing mutated hyperparameters.
    """
    history = None

    # Try MongoDB first if available
    if self.mongodb:
        if results := list(
            self.collection.find({"fitness": {"$exists": True}}, {"fitness": 1, "hyperparameters": 1}).sort(
                "_id", 1
            )
        ):
            history = np.array(
                [
                    [r["fitness"]] + [r["hyperparameters"].get(k, self.args.get(k)) for k in self.space]
                    for r in results
                ]
            )
        else:
            from pymongo.errors import DuplicateKeyError

            default_hyp = self._constrain({k: getattr(self.args, k) for k in self.space})
            try:
                self.collection.insert_one({"_id": "defaults", "timestamp": datetime.now().astimezone()})
            except DuplicateKeyError:  # Another worker already claimed the default generation
                history = np.array([[0.0, *default_hyp.values()]])
            self.collection.create_index([("fitness", -1)], background=True)
            if history is None:
                return default_hyp

    # Fall back to local NDJSON if MongoDB unavailable or empty
    if history is None:
        results = self._load_local_results()
        history = self._local_results_to_array(results)

    # Mutate if we have data, otherwise use defaults
    if history is not None:
        rng = np.random.default_rng()
        ng = len(self.space)
        fitness = np.round(history[:, 0], 5)
        stale = len(history) - 1 - int(np.argmax(fitness))
        x = history[np.argsort(-history[:, 0])][:n]
        bounds = np.array([v[:2] for v in self.space.values()])
        span = np.ptp(bounds, axis=1)
        mutable = span > 0
        if mutable.any():
            population = np.divide(x[:, 1:] - bounds[:, 0], span, out=np.zeros_like(x[:, 1:]), where=mutable)
            weights = x[:, 0] - x[:, 0].min() + 1e-6
            weights = weights if np.isfinite(weights).all() and weights.sum() else np.ones_like(weights)
            gains = np.array([v[2] if len(v) == 3 else 1.0 for v in self.space.values()])  # gains 0-1
            resolution = np.array([1 if k in CFG_INT_KEYS else 1e-5 for k in self.space])
            scale = sigma * (1 - 0.2 * min(stale / 25, 1)) * gains
            scale = np.maximum(scale, np.divide(resolution, span, out=np.zeros(ng), where=mutable))
            existing = {tuple(row[1:]) for row in history}
            for attempt in range(200):
                if attempt < 100:
                    genes = population[rng.choice(len(x), p=weights / weights.sum())]
                    mask = (rng.random(ng) < 0.5) & mutable
                    genes = np.clip(genes + mask * rng.standard_normal(ng) * scale, 0, 1)
                else:
                    genes = population[rng.choice(len(x), p=weights / weights.sum())].copy()
                    genes[mutable] = rng.random(mutable.sum())
                hyp = {k: float(bounds[i, 0] + genes[i] * span[i]) for i, k in enumerate(self.space)}
                hyp = self._constrain(hyp)
                if tuple(hyp.values()) not in existing:
                    return hyp
            raise RuntimeError(f"{self.prefix}Unable to generate a unique hyperparameter mutation")
        raise RuntimeError(f"{self.prefix}Hyperparameter search space is exhausted")
    else:
        hyp = {k: getattr(self.args, k) for k in self.space}

    return self._constrain(hyp)

def _result_record(
    self,
    iteration: int,
    fitness: float,
    hyperparameters: dict[str, float],
    datasets: dict[str, dict],
    save_dirs: dict[str, str] | None = None,
) -> dict:
    """Build one local tuning result record."""
    result = {
        "iteration": iteration,
        "fitness": round(fitness, 5),
        "hyperparameters": hyperparameters,
        "datasets": datasets,
    }
    if save_dirs:
        result["save_dirs"] = save_dirs
    return result

def _save_local_result(self, result: dict):
    """Append one tuning result to the local NDJSON log."""
    with open(self.tune_file, "a", encoding="utf-8") as f:
        f.write(json.dumps(result, default=self._json_default) + "\n")

def _save_to_mongodb(
    self,
    fitness: float,
    hyperparameters: dict[str, float],
    metrics: dict,
    datasets: dict[str, dict],
    save_dirs: dict[str, str],
):
    """Save results to MongoDB with proper type conversion.

    Args:
        fitness (float): Fitness score achieved with these hyperparameters.
        hyperparameters (dict[str, float]): Dictionary of hyperparameter values.
        metrics (dict): Complete training metrics dictionary (mAP, precision, recall, losses, etc.).
        datasets (dict[str, dict]): Per-dataset metrics for the iteration.
        save_dirs (dict[str, str]): Per-dataset training directories for cleanup.
    """
    try:
        self.collection.insert_one(
            {
                "fitness": fitness,
                "hyperparameters": {k: (v.item() if hasattr(v, "item") else v) for k, v in hyperparameters.items()},
                "metrics": metrics,
                "datasets": datasets,
                "save_dirs": save_dirs,
                "timestamp": datetime.now().astimezone(),
                "iteration": self.collection.find_one_and_update(
                    {"_id": "defaults"}, {"$inc": {"last_iteration": 1}}, return_document=True
                )["last_iteration"],
            }
        )
    except Exception as e:
        LOGGER.warning(f"{self.prefix}MongoDB save failed: {e}")

def _sync_mongodb_to_file(self):
    """Sync MongoDB results to the local NDJSON tuning log.

    Downloads all results from MongoDB and writes them to the local NDJSON file in chronological order. This keeps
    resume, mutation, and plotting on the same local source of truth when using distributed tuning.
    """
    try:
        all_results = list(self.collection.find({"fitness": {"$exists": True}}).sort("_id", 1))
        if not all_results:
            return
        last_iteration = max(r["iteration"] for r in all_results)
        self.collection.update_one({"_id": "defaults"}, {"$max": {"last_iteration": last_iteration}}, upsert=True)

        with open(self.tune_file, "w", encoding="utf-8") as f:
            f.writelines(
                json.dumps(
                    self._result_record(
                        result["iteration"],
                        result["fitness"] or 0.0,
                        result.get("hyperparameters", {}),
                        result.get("datasets", {}),
                        result.get("save_dirs"),
                    ),
                    default=self._json_default,
                )
                + "\n"
                for result in all_results
            )

    except Exception as e:
        LOGGER.warning(f"{self.prefix}MongoDB to NDJSON sync failed: {e}")