d3rlpy.models.SGDFactory

class d3rlpy.models.SGDFactory(momentum=0.0, dampening=0.0, weight_decay=0.0, nesterov=False)[source]

An alias for SGD optimizer.

from d3rlpy.optimizers import SGDFactory

factory = SGDFactory(weight_decay=1e-4)
Parameters

  • momentum (float) – momentum factor.

  • dampening (float) – dampening for momentum.

  • weight_decay (float) – weight decay (L2 penalty).

  • nesterov (bool) – flag to enable Nesterov momentum.

Return type

None

Methods

create(named_modules, lr)[source]

Returns an optimizer object.

Parameters

  • named_modules (list) – List of tuples of module names and modules.

  • lr (float) – Learning rate.

Returns

an optimizer object.

Return type

torch.optim.Optimizer

classmethod deserialize(serialized_config)
Parameters

serialized_config (str) –

Return type

d3rlpy.serializable_config.TConfig

classmethod deserialize_from_dict(dict_config)
Parameters

dict_config (Dict[str, Any]) –

Return type

d3rlpy.serializable_config.TConfig

classmethod deserialize_from_file(path)
Parameters

path (str) –

Return type

d3rlpy.serializable_config.TConfig

classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

static get_type()[source]
Return type

str

classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.api.A]

serialize()
Return type

str

serialize_to_dict()
Return type

Dict[str, Any]

to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters

  • skipkeys (bool) –

  • ensure_ascii (bool) –

  • check_circular (bool) –

  • allow_nan (bool) –

  • indent (Optional[Union[int, str]]) –

  • separators (Optional[Tuple[str, str]]) –

  • default (Optional[Callable]) –

  • sort_keys (bool) –

Return type

str

Attributes

dampening: float = 0.0
momentum: float = 0.0
nesterov: bool = False
weight_decay: float = 0.0