Modular optimization library for PyTorch.
Project description
torchzero
This is a work-in-progress optimizers library for pytorch with composable zeroth, first, second order and quasi newton methods, gradient approximation, line searches and a whole lot of other stuff.
Most optimizers are modular, meaning you can chain them like this:
optimizer = torchzero.optim.Modular(model.parameters(), [*list of modules*])`
For example you might use [ClipNorm(4), LR(1e-3), NesterovMomentum(0.9)] for standard SGD with gradient clipping and nesterov momentum. Move ClipNorm to the end to clip the update instead of the gradients. If you don't have access to gradients, add a RandomizedFDM() at the beginning to approximate them via randomized finite differences. Add Cautious() to make the optimizer cautious.
Each new module takes previous module update and works on it. That way there is no need to reimplement stuff like laplacian smoothing for all optimizers, and it is easy to experiment with grafting, interpolation between different optimizers, and perhaps some weirder combinations like nested momentum.
How to use
All modules are defined in torchzero.modules. You can generally mix and match them however you want. Some pre-made optimizers are available in torchzero.optim.
Some optimizers require closure, which should look like this:
def closure(backward = True):
preds = model(inputs)
loss = loss_fn(preds, targets)
# if you can't call loss.backward(), and instead use gradient-free methods,
# they always call closure with backward=False.
# so you can remove the part below, but keep the unused backward argument.
if backward:
optimizer.zero_grad()
loss.backward()
return loss
optimizer.step(closure)
This closure will also work with all built in pytorch optimizers, including LBFGS, all optimizers in this library, as well as most custom ones.
Contents
Docs are available at torchzero.readthedocs.io. A preliminary list of all modules is available here https://torchzero.readthedocs.io/en/latest/autoapi/torchzero/modules/index.html#classes. Some of the implemented algorithms:
- SGD/Rprop/RMSProp/AdaGrad/Adam as composable modules. They are also tested to exactly match built in pytorch versions.
- Cautious Optimizers (https://huggingface.co/papers/2411.16085)
- Optimizer grafting (https://openreview.net/forum?id=FpKgG31Z_i9)
- Laplacian smoothing (https://arxiv.org/abs/1806.06317)
- Polyak momentum, nesterov momentum
- Gradient norm and value clipping, gradient normalization
- Gradient centralization (https://arxiv.org/abs/2004.01461)
- Learning rate droput (https://pubmed.ncbi.nlm.nih.gov/35286266/).
- Forward gradient (https://arxiv.org/abs/2202.08587)
- Gradient approximation via finite difference or randomized finite difference, which includes SPSA, RDSA, FDSA and Gaussian smoothing (https://arxiv.org/abs/2211.13566v3)
- Various line searches
- Exact Newton's method (with Levenberg-Marquardt regularization), newton with hessian approximation via finite difference, subspace finite differences newton.
- Directional newton via one additional forward pass
All modules should be quite fast, especially on models with many different parameters, due to _foreach operations.
I am getting to the point where I can start focusing on good docs and tests. As of now, the code should be considered experimental, untested and subject to change, so feel free but be careful if using this for actual project.
Wrappers
scipy.optimize.minimize wrapper
scipy.optimize.minimize wrapper with support for both gradient and hessian via batched autograd
from torchzero.optim.wrappers.scipy import ScipyMinimize
opt = ScipyMinimize(model.parameters(), method = 'trust-krylov')
Use as any other optimizer (make sure closure accepts backward argument like one from How to use). Note that it performs full minimization on each step.
Nevergrad wrapper
opt = NevergradOptimizer(bench.parameters(), ng.optimizers.NGOptBase, budget = 1000)
Use as any other optimizer (make sure closure accepts backward argument like one from How to use).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file torchzero-0.1.4.tar.gz.
File metadata
- Download URL: torchzero-0.1.4.tar.gz
- Upload date:
- Size: 103.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb549359c9d5e73c18ad61968dd88bdc31a658bc65851a0be0ced95ee65eb0f1
|
|
| MD5 |
0a3b72d795a7e276e77eedfb7abf043c
|
|
| BLAKE2b-256 |
2f39303a7ab174e6899c925b58acbe01eac34597847d70f4873b321ea2fe89ad
|
Provenance
The following attestation bundles were made for torchzero-0.1.4.tar.gz:
Publisher:
python-publish.yml on inikishev/torchzero
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
torchzero-0.1.4.tar.gz -
Subject digest:
cb549359c9d5e73c18ad61968dd88bdc31a658bc65851a0be0ced95ee65eb0f1 - Sigstore transparency entry: 170024575
- Sigstore integration time:
-
Permalink:
inikishev/torchzero@de44dffee769c3324e5d357b3ba09515d1ef4a3a -
Branch / Tag:
refs/tags/0.1.4 - Owner: https://github.com/inikishev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@de44dffee769c3324e5d357b3ba09515d1ef4a3a -
Trigger Event:
push
-
Statement type:
File details
Details for the file torchzero-0.1.4-py3-none-any.whl.
File metadata
- Download URL: torchzero-0.1.4-py3-none-any.whl
- Upload date:
- Size: 139.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7768bc09359bc9379ac6666afae0673e5f45f5174f25ccb6891535a1387d7491
|
|
| MD5 |
a6b9f1fae637684f721d5073d6b5fe1c
|
|
| BLAKE2b-256 |
4409f1165866e174266c82ebfade942a2be81c33d38329c644713c8d012d94df
|
Provenance
The following attestation bundles were made for torchzero-0.1.4-py3-none-any.whl:
Publisher:
python-publish.yml on inikishev/torchzero
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
torchzero-0.1.4-py3-none-any.whl -
Subject digest:
7768bc09359bc9379ac6666afae0673e5f45f5174f25ccb6891535a1387d7491 - Sigstore transparency entry: 170024578
- Sigstore integration time:
-
Permalink:
inikishev/torchzero@de44dffee769c3324e5d357b3ba09515d1ef4a3a -
Branch / Tag:
refs/tags/0.1.4 - Owner: https://github.com/inikishev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@de44dffee769c3324e5d357b3ba09515d1ef4a3a -
Trigger Event:
push
-
Statement type: