RMSprop

class torch.optim.RMSprop(params, lr=0.01, alpha=0.99, eps=1e-08, weight_decay=0, momentum=0, centered=False, capturable=False, foreach=None, maximize=False, differentiable=False) [исходный код]

Реализует алгоритм RMSprop.

$$\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \alpha \text{ (alpha)}, \: \gamma \text{ (lr)}, \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)} \\ &\hspace{13mm} \lambda \text{ (weight decay)},\: \mu \text{ (momentum)}, \: centered, \: \epsilon \text{ (epsilon)} \\ &\textbf{initialize} : v_0 \leftarrow 0 \text{ (square average)}, \: \textbf{b}_0 \leftarrow 0 \text{ (buffer)}, \: g^{ave}_0 \leftarrow 0 \\[-1.ex] &\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}if \: \lambda \neq 0 \\ &\hspace{10mm} g_t \leftarrow g_t + \lambda \theta_{t-1} \\ &\hspace{5mm}v_t \leftarrow \alpha v_{t-1} + (1 - \alpha) g^2_t \hspace{8mm} \\ &\hspace{5mm} \tilde{v_t} \leftarrow v_t \\ &\hspace{5mm}if \: centered \\ &\hspace{10mm} g^{ave}_t \leftarrow g^{ave}_{t-1} \alpha + (1-\alpha) g_t \\ &\hspace{10mm} \tilde{v_t} \leftarrow \tilde{v_t} - \big(g^{ave}_{t} \big)^2 \\ &\hspace{5mm}if \: \mu > 0 \\ &\hspace{10mm} \textbf{b}_t\leftarrow \mu \textbf{b}_{t-1} + g_t/ \big(\sqrt{\tilde{v_t}} + \epsilon \big) \\ &\hspace{10mm} \theta_t \leftarrow \theta_{t-1} - \gamma \textbf{b}_t \\ &\hspace{5mm} else \\ &\hspace{10mm}\theta_t \leftarrow \theta_{t-1} - \gamma g_t/ \big(\sqrt{\tilde{v_t}} + \epsilon \big) \hspace{3mm} \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}$$

Подробнее об алгоритме см. в лекционных материалах G. Hinton, а о центрированном варианте — в статье «Генерация последовательностей с помощью рекуррентных нейронных сетей». В этой реализации квадратный корень из среднего градиентов берётся до добавления epsilon (обратите внимание: TensorFlow меняет порядок этих двух операций). Таким образом, эффективная скорость обучения равна $\gamma/(\sqrt{v} + \epsilon)$, где $\gamma$ — запланированная скорость обучения, а $v$ — взвешенное скользящее среднее квадратов градиента.

Параметры:

• params (итерируемый объект) – итерируемый объект с параметрами или named_parameters для оптимизации либо итерируемый объект словарей, задающих группы параметров. При использовании named_parameters все параметры во всех группах должны иметь имена
• lr (float, Tensor, необязательно) – скорость обучения (по умолчанию: 1e-2)
• alpha (float, необязательно) – коэффициент сглаживания (по умолчанию: 0.99)
• eps (float, необязательно) – слагаемое, добавляемое к знаменателю для повышения численной устойчивости (по умолчанию: 1e-8)
• weight_decay (float, необязательно) – затухание весов (штраф L2) (по умолчанию: 0)
• momentum (float, необязательно) – коэффициент момента (по умолчанию: 0)
• centered (bool, необязательно) – если True, вычисляет центрированный RMSProp; градиент нормализуется с использованием оценки его дисперсии
• capturable (bool, необязательно) – безопасно ли захватывать этот экземпляр в граф, например в графы CUDA или для поддержки torch.compile. Тензоры можно захватывать только на поддерживаемых ускорителях. Передача True может снизить производительность без захвата в граф, поэтому, если вы не планируете захватывать этот экземпляр в граф, оставьте значение False (по умолчанию: False)
• foreach (bool, необязательно) – используется ли реализация оптимизатора foreach. Если пользователь не указал значение (то есть foreach равен None), на CUDA будет предпринята попытка использовать foreach вместо реализации с циклом for, поскольку она обычно значительно производительнее. Обратите внимание, что реализация 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) [исходный код]

Добавляет группу параметров в оптимизатор Optimizer s 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) [исходный код]

Регистрирует post-hook для 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, указанный post-hook будет вызван до всех уже зарегистрированных post-хуков для load_state_dict. В противном случае указанный hook будет вызван после всех уже зарегистрированных post-хуков. (по умолчанию: False)

Возвращает:

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

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

torch.utils.hooks.RemovableHandle

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

Регистрирует pre-hook для 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, указанный pre-hook будет вызван до всех уже зарегистрированных pre-хуков для load_state_dict. В противном случае указанный hook будет вызван после всех уже зарегистрированных pre-хуков. (по умолчанию: False)

Возвращает:

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

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

torch.utils.hooks.RemovableHandle

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

Регистрирует post-hook для словаря состояния, который будет вызван после вызова 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, указанный post-hook будет вызван до всех уже зарегистрированных post-хуков для state_dict. В противном случае указанный hook будет вызван после всех уже зарегистрированных post-хуков. (по умолчанию: False)

Возвращает:

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

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

torch.utils.hooks.RemovableHandle

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

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

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

hook(optimizer) -> None

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

Параметры:

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

Возвращает:

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

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

torch.utils.hooks.RemovableHandle

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

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

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

hook(optimizer, args, kwargs) -> None

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

Параметры:

hook (Callable) – пользовательский хук, который нужно зарегистрировать.

Возвращает:

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

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

torch.utils.hooks.RemovableHandle

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

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

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

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

Аргумент optimizer — используемый экземпляр оптимизатора. Если pre-hook изменяет 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 оптимизатор сопоставляет элементы param_group params (целочисленные ID) и оптимизатора param_groups (фактические nn.Parameter s), чтобы соотнести состояния БЕЗ дополнительной проверки.

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

{
    '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.Tensor.

Параметры:

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

Вместо установки нулевых значений установите градиенты в None. По умолчанию: True

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

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