90 lines
2.6 KiB
Markdown
90 lines
2.6 KiB
Markdown
|
<!--Copyright 2020 The HuggingFace Team. All rights reserved.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
|
||
|
|
the License. You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
|
||
|
|
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
|
||
|
|
specific language governing permissions and limitations under the License.
|
||
|
|
|
||
|
|
⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
|
||
|
|
rendered properly in your Markdown viewer.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Optimization
|
||
|
|
|
||
|
|
The `.optimization` module provides:
|
||
|
|
|
||
|
|
- an optimizer with weight decay fixed that can be used to fine-tuned models, and
|
||
|
|
- several schedules in the form of schedule objects that inherit from `_LRSchedule`:
|
||
|
|
- a gradient accumulation class to accumulate the gradients of multiple batches
|
||
|
|
|
||
|
|
## AdaFactor
|
||
|
|
|
||
|
|
[[autodoc]] Adafactor
|
||
|
|
|
||
|
|
## Schedules
|
||
|
|
|
||
|
|
### SchedulerType
|
||
|
|
|
||
|
|
[[autodoc]] SchedulerType
|
||
|
|
|
||
|
|
### get_scheduler
|
||
|
|
|
||
|
|
[[autodoc]] get_scheduler
|
||
|
|
|
||
|
|
### get_constant_schedule
|
||
|
|
|
||
|
|
[[autodoc]] get_constant_schedule
|
||
|
|
|
||
|
|
### get_constant_schedule_with_warmup
|
||
|
|
|
||
|
|
[[autodoc]] get_constant_schedule_with_warmup
|
||
|
|
|
||
|
|
<img alt="" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/warmup_constant_schedule.png"/>
|
||
|
|
|
||
|
|
### get_cosine_schedule_with_warmup
|
||
|
|
|
||
|
|
[[autodoc]] get_cosine_schedule_with_warmup
|
||
|
|
|
||
|
|
<img alt="" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/warmup_cosine_schedule.png"/>
|
||
|
|
|
||
|
|
### get_cosine_with_hard_restarts_schedule_with_warmup
|
||
|
|
|
||
|
|
[[autodoc]] get_cosine_with_hard_restarts_schedule_with_warmup
|
||
|
|
|
||
|
|
### get_cosine_with_min_lr_schedule_with_warmup
|
||
|
|
|
||
|
|
[[autodoc]] get_cosine_with_min_lr_schedule_with_warmup
|
||
|
|
|
||
|
|
### get_cosine_with_min_lr_schedule_with_warmup_lr_rate
|
||
|
|
|
||
|
|
[[autodoc]] get_cosine_with_min_lr_schedule_with_warmup_lr_rate
|
||
|
|
|
||
|
|
<img alt="" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/warmup_cosine_hard_restarts_schedule.png"/>
|
||
|
|
|
||
|
|
### get_linear_schedule_with_warmup
|
||
|
|
|
||
|
|
[[autodoc]] get_linear_schedule_with_warmup
|
||
|
|
|
||
|
|
<img alt="" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/warmup_linear_schedule.png"/>
|
||
|
|
|
||
|
|
### get_polynomial_decay_schedule_with_warmup
|
||
|
|
|
||
|
|
[[autodoc]] get_polynomial_decay_schedule_with_warmup
|
||
|
|
|
||
|
|
### get_inverse_sqrt_schedule
|
||
|
|
|
||
|
|
[[autodoc]] get_inverse_sqrt_schedule
|
||
|
|
|
||
|
|
### get_reduce_on_plateau_schedule
|
||
|
|
|
||
|
|
[[autodoc]] get_reduce_on_plateau_schedule
|
||
|
|
|
||
|
|
### get_wsd_schedule
|
||
|
|
|
||
|
|
[[autodoc]] get_wsd_schedule
|