RAdam

class torch.optim.RAdam(params, lr=0.001, betas=(0.9, 0.999), eps=1e-08, weight_decay=0, decoupled_weight_decay=False, *, foreach=None, maximize=False, capturable=False, differentiable=False) [источник]

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

$$\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma \text{ (lr)}, \: \beta_1, \beta_2 \text{ (betas)}, \: \theta_0 \text{ (params)}, \:f(\theta) \text{ (objective)}, \: \lambda \text{ (weight decay)}, \:\textit{maximize} \\ &\hspace{13mm} \epsilon \text{ (epsilon)}, \textit{decoupled\_weight\_decay} \\ &\textbf{initialize} : m_0 \leftarrow 0 \text{ ( first moment)}, v_0 \leftarrow 0 \text{ ( second moment)}, \\ &\hspace{18mm} \rho_{\infty} \leftarrow 2/(1-\beta_2) -1 \\[-1.ex] &\rule{110mm}{0.4pt} \\ &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\ &\hspace{6mm}\textbf{if} \: \textit{maximize}: \\ &\hspace{12mm}g_t \leftarrow -\nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{6mm}\textbf{else} \\ &\hspace{12mm}g_t \leftarrow \nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{6mm} \theta_t \leftarrow \theta_{t-1} \\ &\hspace{6mm} \textbf{if} \: \lambda \neq 0 \\ &\hspace{12mm}\textbf{if} \: \textit{decoupled\_weight\_decay} \\ &\hspace{18mm} \theta_t \leftarrow \theta_{t} - \gamma \lambda \theta_{t} \\ &\hspace{12mm}\textbf{else} \\ &\hspace{18mm} g_t \leftarrow g_t + \lambda \theta_{t} \\ &\hspace{6mm}m_t \leftarrow \beta_1 m_{t-1} + (1 - \beta_1) g_t \\ &\hspace{6mm}v_t \leftarrow \beta_2 v_{t-1} + (1-\beta_2) g^2_t \\ &\hspace{6mm}\widehat{m_t} \leftarrow m_t/\big(1-\beta_1^t \big) \\ &\hspace{6mm}\rho_t \leftarrow \rho_{\infty} - 2 t \beta^t_2 /\big(1-\beta_2^t \big) \\[0.1.ex] &\hspace{6mm}\textbf{if} \: \rho_t > 5 \\ &\hspace{12mm} l_t \leftarrow \frac{\sqrt{ (1-\beta^t_2) }}{ \sqrt{v_t} +\epsilon } \\ &\hspace{12mm} r_t \leftarrow \sqrt{\frac{(\rho_t-4)(\rho_t-2)\rho_{\infty}}{(\rho_{\infty}-4)(\rho_{\infty}-2) \rho_t}} \\ &\hspace{12mm}\theta_t \leftarrow \theta_t - \gamma \widehat{m_t} r_t l_t \\ &\hspace{6mm}\textbf{else} \\ &\hspace{12mm}\theta_t \leftarrow \theta_t - \gamma \widehat{m_t} \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}$$

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

Эта реализация позволяет выбрать между исходной реализацией weight_decay, как в Adam (где weight_decay применяется к градиенту), и реализацией из AdamW (где weight_decay применяется к весам) с помощью параметра decoupled_weight_decay. Если decoupled_weight_decay имеет значение False (по умолчанию), используется исходный вариант затухания весов Adam; в противном случае используется вариант AdamW, который точнее соответствует реализации автора статьи о RAdam. Дополнительные сведения о развязанном затухании весов приведены в статье Регуляризация с развязанным затуханием весов.

Параметры:

• params (iterable) – итерируемый объект с параметрами или named_parameters для оптимизации либо итерируемый объект со словарями, определяющими группы параметров. При использовании named_parameters все параметры во всех группах должны иметь имена
• lr (float, Tensor, необязательно) – скорость обучения (по умолчанию: 1e-3)
• betas (Tuple[float, float], необязательно) – коэффициенты, используемые для вычисления скользящих средних градиента и его квадрата (по умолчанию: (0.9, 0.999))
• eps (float, необязательно) – слагаемое, добавляемое к знаменателю для повышения численной устойчивости (по умолчанию: 1e-8)
• weight_decay (float, необязательно) – затухание весов (штраф L2) (по умолчанию: 0)
• decoupled_weight_decay (bool, необязательно) – следует ли отделить затухание весов, как в AdamW, чтобы получить RAdamW. Если значение True, алгоритм не накапливает затухание весов ни в импульсе, ни в дисперсии. (по умолчанию: False)
• foreach (bool, необязательно) – следует ли использовать реализацию оптимизатора foreach. Если пользователь не указал значение (то есть foreach равен None), на CUDA будет предпринята попытка использовать foreach вместо реализации с циклом for, поскольку обычно она значительно производительнее. Обратите внимание: реализация foreach использует на пике примерно на sizeof(params) больше памяти, чем версия с циклом for, поскольку промежуточные результаты представлены списком тензоров, а не одним тензором. Если памяти недостаточно, передавайте оптимизатору меньше параметров за раз или установите для этого флага значение False (по умолчанию: None)
• maximize (bool, необязательно) – максимизировать целевую функцию относительно параметров, а не минимизировать её (по умолчанию: False)
• capturable (bool, необязательно) – можно ли безопасно захватить этот экземпляр в граф, например в графы CUDA или для поддержки torch.compile. Тензоры можно захватывать только на поддерживаемых ускорителях. Передача True может ухудшить производительность без графа, поэтому оставьте значение False, если не планируете захватывать этот экземпляр в граф (по умолчанию: False)
• differentiable (bool, необязательно) – следует ли выполнять autograd через шаг оптимизатора при обучении. В противном случае функция step() выполняется в контексте torch.no_grad(). Установка значения True может снизить производительность, поэтому оставьте значение False, если не планируете выполнять autograd через этот экземпляр (по умолчанию: False)

add_param_group(param_group) [источник]

Добавляет группу параметров в Optimizer 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, с помощью которого можно удалить добавленный хук, вызвав 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, с помощью которого можно удалить добавленный хук, вызвав 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, с помощью которого можно удалить добавленный хук, вызвав 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, с помощью которого можно удалить добавленный хук, вызвав handle.remove()

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

torch.utils.hooks.RemovableHandle

register_step_post_hook(hook) [источник]

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

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

hook(optimizer, args, kwargs) -> None

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

Параметры:

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

Возвращает:

объект handle, с помощью которого можно удалить добавленный хук, вызвав 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, с помощью которого можно удалить добавленный хук, вызвав 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(), содержимое с именами также будет сохранено в словаре состояния.

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

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

{
    '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, optional) – Замыкание, повторно вычисляющее модель и возвращающее значение функции потерь.

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

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

Параметры:

set_to_none (bool, optional) –

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

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

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