Rprop

class torch.optim.Rprop(params, lr=0.01, etas=(0.5, 1.2), step_sizes=(1e-06, 50), *, capturable=False, foreach=None, maximize=False, differentiable=False) [исходный код]

Реализует алгоритм устойчивого обратного распространения ошибки.

$$\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \theta_0 \in \mathbf{R}^d \text{ (params)},f(\theta) \text{ (objective)}, \\ &\hspace{13mm} \eta_{+/-} \text{ (etaplus, etaminus)}, \Gamma_{max/min} \text{ (step sizes)} \\ &\textbf{initialize} : g^0_{prev} \leftarrow 0, \: \eta_0 \leftarrow \text{lr (learning rate)} \\ &\rule{110mm}{0.4pt} \\ &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\ &\hspace{5mm}g_t \leftarrow \nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{5mm} \textbf{for} \text{ } i = 0, 1, \ldots, d-1 \: \mathbf{do} \\ &\hspace{10mm} \textbf{if} \: g^i_{prev} g^i_t > 0 \\ &\hspace{15mm} \eta^i_t \leftarrow \mathrm{min}(\eta^i_{t-1} \eta_{+}, \Gamma_{max}) \\ &\hspace{10mm} \textbf{else if} \: g^i_{prev} g^i_t < 0 \\ &\hspace{15mm} \eta^i_t \leftarrow \mathrm{max}(\eta^i_{t-1} \eta_{-}, \Gamma_{min}) \\ &\hspace{15mm} g^i_t \leftarrow 0 \\ &\hspace{10mm} \textbf{else} \: \\ &\hspace{15mm} \eta^i_t \leftarrow \eta^i_{t-1} \\ &\hspace{5mm}\theta_t \leftarrow \theta_{t-1}- \eta_t \mathrm{sign}(g_t) \\ &\hspace{5mm}g_{prev} \leftarrow g_t \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}$$

Дополнительные сведения об алгоритме см. в статье Прямой адаптивный метод ускорения обучения с обратным распространением ошибки: алгоритм RPROP.

Параметры:

• params (iterable) – итерируемый объект с параметрами или named_parameters для оптимизации либо итерируемый объект словарей, задающих группы параметров. При использовании named_parameters все параметры во всех группах должны иметь имена
• lr (float, необязательный) – скорость обучения (по умолчанию: 1e-2)
• etas (Tuple[float, float], необязательный) – пара (etaminus, etaplus), представляющая множители увеличения и уменьшения (по умолчанию: (0.5, 1.2))
• step_sizes (Tuple[float, float], необязательный) – пара минимального и максимального допустимых размеров шага (по умолчанию: (1e-6, 50))
• capturable (bool, необязательный) – можно ли безопасно захватить этот экземпляр в граф, будь то графы CUDA или поддержка torch.compile. Тензоры можно захватывать только при использовании поддерживаемых ускорителей. Значение True может снизить производительность без графа, поэтому, если вы не собираетесь захватывать этот экземпляр в граф, оставьте False (по умолчанию: False)
• foreach (bool, необязательный) – используется ли реализация оптимизатора foreach. Если пользователь не задаёт этот параметр (то есть foreach равен None), мы попытаемся использовать foreach вместо реализации с циклом for на CUDA, поскольку она обычно значительно производительнее. Обратите внимание: реализация foreach использует примерно на sizeof(params) больше пиковой памяти, чем версия с циклом for, поскольку промежуточные данные представлены списком тензоров, а не одним тензором. Если памяти недостаточно, передавайте оптимизатору меньше параметров за раз или установите для этого флага значение False (по умолчанию: None)
• maximize (bool, необязательный) – максимизировать целевую функцию относительно params вместо её минимизации (по умолчанию: False)
• differentiable (bool, необязательный) – выполняется ли autograd через шаг оптимизатора во время обучения. В противном случае функция step() выполняется в контексте torch.no_grad(). Значение True может снизить производительность, поэтому оставьте False, если не планируете выполнять autograd через этот экземпляр (по умолчанию: False)

add_param_group(param_group) [исходный код]

Добавляет группу параметров в Optimizers param_groups.

Это может быть полезно при тонкой настройке предварительно обученной сети: замороженные слои можно сделать обучаемыми и добавлять в Optimizer по мере обучения.

Параметры:

param_group (dict) – задаёт, какие тензоры следует оптимизировать, а также параметры оптимизации, относящиеся к группе.

load_state_dict(state_dict) [исходный код]

Загружает состояние оптимизатора.

Параметры:

state_dict (dict) – состояние оптимизатора. Должно быть объектом, возвращённым вызовом state_dict().

Предупреждение

Убедитесь, что этот метод вызывается после инициализации torch.optim.lr_scheduler.LRScheduler, поскольку его предварительный вызов перезапишет загруженные скорости обучения.

Примечание

Имена параметров (если они указаны в ключе «param_names» каждой группы параметров в state_dict()) не влияют на процесс загрузки. Чтобы использовать имена параметров в особых случаях (например, когда параметры в загруженном словаре состояния отличаются от параметров, инициализированных в оптимизаторе), необходимо реализовать пользовательский register_load_state_dict_pre_hook для соответствующей адаптации загруженного словаря. Если param_names присутствуют в загруженном словаре состояния param_groups, они будут сохранены и переопределят текущие имена в состоянии оптимизатора, если таковые имеются. Если их нет в загруженном словаре состояния, param_names оптимизатора останется без изменений.

Пример

>>> optimizer = ...  # initialized optimizer matching the saved state
>>> scheduler1 = torch.optim.lr_scheduler.LinearLR(
...     optimizer,
...     start_factor=0.1,
...     end_factor=1,
...     total_iters=20,
... )
>>> scheduler2 = torch.optim.lr_scheduler.CosineAnnealingLR(
...     optimizer,
...     T_max=80,
...     eta_min=3e-5,
... )
>>> lr = torch.optim.lr_scheduler.SequentialLR(
...     optimizer,
...     schedulers=[scheduler1, scheduler2],
...     milestones=[20],
... )
>>> lr.load_state_dict(torch.load("./save_seq.pt"))
>>> # now load the optimizer checkpoint after loading the LRScheduler
>>> optimizer.load_state_dict(torch.load("./save_optim.pt"))

register_load_state_dict_post_hook(hook, prepend=False) [исходный код]

Регистрирует постхук load_state_dict, который будет вызван после вызова load_state_dict(). Он должен иметь следующую сигнатуру:

hook(optimizer) -> None

Аргумент optimizer — это используемый экземпляр оптимизатора.

Хук будет вызван с аргументом self после вызова load_state_dict для self. Зарегистрированный хук можно использовать для постобработки после того, как load_state_dict загрузил state_dict.

Параметры:

• hook (Callable) – определённый пользователем хук для регистрации.
• prepend (bool) – если True, заданный постхук hook будет вызван раньше всех уже зарегистрированных постхуков для load_state_dict. В противном случае заданный hook будет вызван после всех уже зарегистрированных постхуков. (по умолчанию: False)

Возвращает:

объект-идентификатор, который можно использовать для удаления добавленного хука, вызвав handle.remove()

Тип возвращаемого значения:

torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook, prepend=False) [исходный код]

Регистрирует прехук load_state_dict, который будет вызван перед вызовом load_state_dict(). Он должен иметь следующую сигнатуру:

hook(optimizer, state_dict) -> state_dict or None

Аргумент optimizer — это используемый экземпляр оптимизатора, а аргумент state_dict — поверхностная копия state_dict, переданного пользователем в load_state_dict. Хук может изменить state_dict на месте или при необходимости вернуть новый. Если возвращён state_dict, он будет загружен в оптимизатор.

Хук будет вызван с аргументами self и state_dict перед вызовом load_state_dict для self. Зарегистрированный хук можно использовать для предварительной обработки перед вызовом load_state_dict.

Параметры:

• hook (Callable) – определённый пользователем хук для регистрации.
• prepend (bool) – если True, заданный прехук hook будет вызван раньше всех уже зарегистрированных прехуков для load_state_dict. В противном случае заданный hook будет вызван после всех уже зарегистрированных прехуков. (по умолчанию: False)

Возвращает:

объект-идентификатор, который можно использовать для удаления добавленного хука, вызвав handle.remove()

Тип возвращаемого значения:

torch.utils.hooks.RemovableHandle

register_state_dict_post_hook(hook, prepend=False) [исходный код]

Регистрирует постхук словаря состояния, который будет вызван после вызова state_dict().

Он должен иметь следующую сигнатуру:

hook(optimizer, state_dict) -> state_dict or None

Хук будет вызван с аргументами self и state_dict после создания state_dict для self. Хук может изменить state_dict на месте или при необходимости вернуть новый. Зарегистрированный хук можно использовать для постобработки state_dict перед его возвратом.

Параметры:

• hook (Callable) – определённый пользователем хук для регистрации.
• prepend (bool) – если True, заданный постхук hook будет вызван раньше всех уже зарегистрированных постхуков для state_dict. В противном случае заданный hook будет вызван после всех уже зарегистрированных постхуков. (по умолчанию: False)

Возвращает:

объект-идентификатор, который можно использовать для удаления добавленного хука, вызвав handle.remove()

Тип возвращаемого значения:

torch.utils.hooks.RemovableHandle

register_state_dict_pre_hook(hook, prepend=False) [исходный код]

Регистрирует прехук словаря состояния, который будет вызван перед вызовом state_dict().

Он должен иметь следующую сигнатуру:

hook(optimizer) -> None

Аргумент optimizer — это используемый экземпляр оптимизатора. Хук будет вызван с аргументом self перед вызовом state_dict для self. Зарегистрированный хук можно использовать для предварительной обработки перед вызовом state_dict.

Параметры:

• hook (Callable) – определённый пользователем хук для регистрации.
• prepend (bool) – если True, заданный прехук hook будет вызван раньше всех уже зарегистрированных прехуков для state_dict. В противном случае заданный hook будет вызван после всех уже зарегистрированных прехуков. (по умолчанию: False)

Возвращает:

объект-идентификатор, который можно использовать для удаления добавленного хука, вызвав handle.remove()

Тип возвращаемого значения:

torch.utils.hooks.RemovableHandle

register_step_post_hook(hook) [исходный код]

Регистрирует постхук шага оптимизатора, который будет вызван после выполнения шага оптимизатора.

Он должен иметь следующую сигнатуру:

hook(optimizer, args, kwargs) -> None

Аргумент optimizer — это используемый экземпляр оптимизатора.

Параметры:

hook (Callable) – определённый пользователем хук для регистрации.

Возвращает:

объект-идентификатор, который можно использовать для удаления добавленного хука, вызвав handle.remove()

Тип возвращаемого значения:

torch.utils.hooks.RemovableHandle

register_step_pre_hook(hook) [исходный код]

Регистрирует прехук шага оптимизатора, который будет вызван перед выполнением шага оптимизатора.

Он должен иметь следующую сигнатуру:

hook(optimizer, args, kwargs) -> None or modified args and kwargs

Аргумент optimizer — это используемый экземпляр оптимизатора. Если прехук изменяет args и kwargs, преобразованные значения возвращаются в виде кортежа, содержащего new_args и new_kwargs.

Параметры:

hook (Callable) – определённый пользователем хук для регистрации.

Возвращает:

объект-идентификатор, который можно использовать для удаления добавленного хука, вызвав handle.remove()

Тип возвращаемого значения:

torch.utils.hooks.RemovableHandle

state_dict() [исходный код]

Возвращает состояние оптимизатора в виде dict.

Оно содержит две записи:

• state: a Dict holding current optimization state. Its content

  отличается для разных классов оптимизаторов, но некоторые общие характеристики сохраняются. Например, состояние сохраняется отдельно для каждого параметра, а сам параметр НЕ сохраняется. state — это словарь, сопоставляющий идентификаторы параметров со словарём состояния каждого параметра.

• param_groups: a List containing all parameter groups where each

  группа параметров — это словарь. Каждая группа содержит метаданные, относящиеся к оптимизатору, например скорость обучения и затухание весов, а также список идентификаторов параметров в группе. Если группа параметров была инициализирована с помощью named_parameters(), сведения об именах также будут сохранены в словаре состояния.

ПРИМЕЧАНИЕ: идентификаторы параметров могут выглядеть как индексы, но это лишь идентификаторы, связывающие состояние с param_group. При загрузке из state_dict оптимизатор объединяет в пары params группы параметров (целочисленные идентификаторы) и param_groups оптимизатора (сами nn.Parameters), чтобы сопоставить состояние БЕЗ дополнительной проверки.

Возвращаемый словарь состояния может выглядеть примерно так:

{
    'state': {
        0: {'momentum_buffer': tensor(...), ...},
        1: {'momentum_buffer': tensor(...), ...},
        2: {'momentum_buffer': tensor(...), ...},
        3: {'momentum_buffer': tensor(...), ...}
    },
    'param_groups': [
        {
            'lr': 0.01,
            'weight_decay': 0,
            ...
            'params': [0]
            'param_names' ['param0']  (optional)
        },
        {
            'lr': 0.001,
            'weight_decay': 0.5,
            ...
            'params': [1, 2, 3]
            'param_names': ['param1', 'layer.weight', 'layer.bias'] (optional)
        }
    ]
}

Тип возвращаемого значения:

dict[str, Any]

step(closure=None) [исходный код]

Выполняет один шаг оптимизации.

Параметры:

closure (Callable, необязательный) – замыкание, повторно вычисляющее модель и возвращающее значение функции потерь.

zero_grad(set_to_none=True) [исходный код]

Сбрасывает градиенты всех оптимизируемых torch.Tensors.

Параметры:

set_to_none (bool, необязательный) –

Вместо обнуления устанавливает значение градиентов None. По умолчанию: True

Как правило, это снижает потребление памяти и может немного повысить производительность. Однако это меняет некоторые виды поведения. Например:

1. Если пользователь обращается к градиенту и выполняет над ним операции вручную, атрибут None и тензор, заполненный нулями, ведут себя по-разному.
2. Если пользователь запрашивает zero_grad(set_to_none=True), а затем выполняет обратный проход, для параметров, не получивших градиент, .grads гарантированно будут равны None.
3. torch.optim оптимизаторы ведут себя по-разному, если градиент равен 0 или None (в первом случае выполняется шаг с градиентом 0, а во втором шаг полностью пропускается).