diff --git a/mmengine/evaluator/evaluator.py b/mmengine/evaluator/evaluator.py index 34bb02e5..2531be92 100644 --- a/mmengine/evaluator/evaluator.py +++ b/mmengine/evaluator/evaluator.py @@ -29,10 +29,12 @@ class Evaluator: @property def dataset_meta(self) -> Optional[dict]: + """Optional[dict]: Meta info of the dataset.""" return self._dataset_meta @dataset_meta.setter def dataset_meta(self, dataset_meta: dict) -> None: + """Set the dataset meta info to the evaluator and it's metrics.""" self._dataset_meta = dataset_meta for metric in self.metrics: metric.dataset_meta = dataset_meta diff --git a/mmengine/evaluator/metric.py b/mmengine/evaluator/metric.py index 4bcf163b..7d8fa736 100644 --- a/mmengine/evaluator/metric.py +++ b/mmengine/evaluator/metric.py @@ -43,10 +43,12 @@ class BaseMetric(metaclass=ABCMeta): @property def dataset_meta(self) -> Optional[dict]: + """Optional[dict]: Meta info of the dataset.""" return self._dataset_meta @dataset_meta.setter def dataset_meta(self, dataset_meta: dict) -> None: + """Set the dataset meta info to the metric.""" self._dataset_meta = dataset_meta @abstractmethod diff --git a/mmengine/optim/scheduler/param_scheduler.py b/mmengine/optim/scheduler/param_scheduler.py index f40507e5..b8b7f260 100644 --- a/mmengine/optim/scheduler/param_scheduler.py +++ b/mmengine/optim/scheduler/param_scheduler.py @@ -256,6 +256,7 @@ class StepParamScheduler(_ParamScheduler): verbose=verbose) def _get_value(self): + """Compute value using chainable form of the scheduler.""" if (self.last_step == 0) or (self.last_step % self.step_size != 0): return [ group[self.param_name] for group in self.optimizer.param_groups @@ -312,6 +313,7 @@ class MultiStepParamScheduler(_ParamScheduler): verbose=verbose) def _get_value(self): + """Compute value using chainable form of the scheduler.""" if self.last_step not in self.milestones: return [ group[self.param_name] for group in self.optimizer.param_groups @@ -371,6 +373,7 @@ class ConstantParamScheduler(_ParamScheduler): verbose=verbose) def _get_value(self): + """Compute value using chainable form of the scheduler.""" if self.last_step == 0: return [ group[self.param_name] * self.factor @@ -429,6 +432,7 @@ class ExponentialParamScheduler(_ParamScheduler): verbose=verbose) def _get_value(self): + """Compute value using chainable form of the scheduler.""" if self.last_step == 0: return [ group[self.param_name] for group in self.optimizer.param_groups @@ -509,6 +513,7 @@ class CosineAnnealingParamScheduler(_ParamScheduler): verbose=verbose) def _get_value(self): + """Compute value using chainable form of the scheduler.""" if self.last_step == 0: return [ group[self.param_name] for group in self.optimizer.param_groups @@ -585,7 +590,7 @@ class LinearParamScheduler(_ParamScheduler): verbose=verbose) def _get_value(self): - + """Compute value using chainable form of the scheduler.""" if self.last_step == 0: return [ group[self.param_name] * self.start_factor @@ -651,7 +656,7 @@ class PolyParamScheduler(_ParamScheduler): verbose=verbose) def _get_value(self): - + """Compute value using chainable form of the scheduler.""" if self.last_step == 0: return [ group[self.param_name] for group in self.optimizer.param_groups