Commit 7d872508 authored by Kai Chen's avatar Kai Chen
Browse files

fix a typo in docstring

parent ffdc1d45
......@@ -108,11 +108,14 @@ class Runner(object):
Args:
optimizer (dict or :obj:`~torch.optim.Optimizer`): Either an
optimizer object or a dict used for constructing the optimizer.
An example of the dict: ``{'algorithm': 'SGD', 'lr': 0.02,
'momentum': 0.9, 'weight_decay': 0.0001}``.
Returns:
:obj:`~torch.optim.Optimizer`: An optimizer object.
Examples:
>>> optimizer = dict(type='SGD', lr=0.01, momentum=0.9)
>>> type(runner.init_optimizer(optimizer))
<class 'torch.optim.sgd.SGD'>
"""
if isinstance(optimizer, dict):
optimizer = obj_from_dict(
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment