Skip to content

[doc] updated kernel-related optimisers' docstring #2385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FrankLeeeee merged 2 commits into from
Jan 9, 2023
Merged

[doc] updated kernel-related optimisers' docstring #2385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e734f33
[doc] updated kernel-related optimisers' docstring
FrankLeeeee Jan 7, 2023
8e48fcb
polish doc
FrankLeeeee Jan 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion colossalai/nn/optimizer/cpu_adam.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class CPUAdam(NVMeOptimizer):
* Parameters on GPU and gradients on GPU is allowed.
* Parameters on GPU and gradients on CPU is **not** allowed.

Requires ColossalAI to be installed via ``pip install .``.
`CPUAdam` requires CUDA extensions which can be built during installation or runtime.

This version of CPU Adam accelates parameters updating on CPU with SIMD.
Support of AVX2 or AVX512 is required.
Expand Down
3 changes: 1 addition & 2 deletions colossalai/nn/optimizer/fused_adam.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
class FusedAdam(torch.optim.Optimizer):
"""Implements Adam algorithm.

Currently GPU-only. Requires ColossalAI to be installed via
``pip install .``.
`FusedAdam` requires CUDA extensions which can be built during installation or runtime.

This version of fused Adam implements 2 fusions.

Expand Down
3 changes: 1 addition & 2 deletions colossalai/nn/optimizer/fused_lamb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
class FusedLAMB(torch.optim.Optimizer):
"""Implements LAMB algorithm.

Currently GPU-only. Requires ColossalAI to be installed via
``pip install .``.
`FusedLAMB` requires CUDA extensions which can be built during installation or runtime.

This version of fused LAMB implements 2 fusions.

Expand Down
3 changes: 1 addition & 2 deletions colossalai/nn/optimizer/fused_sgd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
class FusedSGD(Optimizer):
r"""Implements stochastic gradient descent (optionally with momentum).

Currently GPU-only. Requires ColossalAI to be installed via
``pip install .``.
`FusedSGD` requires CUDA extensions which can be built during installation or runtime.

This version of fused SGD implements 2 fusions.

Expand Down
2 changes: 1 addition & 1 deletion colossalai/nn/optimizer/hybrid_adam.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class HybridAdam(NVMeOptimizer):
* Parameters on GPU and gradients on GPU is allowed.
* Parameters on GPU and gradients on CPU is **not** allowed.

Requires ColossalAI to be installed via ``pip install .``
`HybriadAdam` requires CUDA extensions which can be built during installation or runtime.

This version of Hybrid Adam is an hybrid of CPUAdam and FusedAdam.

Expand Down