mirrors/mmengine
1
0
Fork 0
mirror of https://github.com/open-mmlab/mmengine.git synced 2025-06-03 21:54:44 +08:00
Code Issues Projects Releases Wiki Activity

improve the coverage of docstring (#203)

Browse Source 
* improve the coverage of docstring

* update
This commit is contained in:
RangiLyu 2022-04-27 19:53:06 +08:00 committed by GitHub
parent db2b45b7ac
commit b1a275a14a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
mmengine/evaluator/evaluator.py
View File

@ -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

2
mmengine/evaluator/metric.py
View File

@ -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

9
mmengine/optim/scheduler/param_scheduler.py
View File

@ -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