# Adam-atan2 Fused Operator
## Usage
Drop-in replacement of `torch.optim.AdamW`.
- Doesn't support `foreach`, `fused` argument, as the optimizer is already fused
- Doesn't support `amsgrad`, `maximize`, `capturable`, `differentiable` argument yet
```bash
pip install adam_atan2
```
```python
from adam_atan2 import AdamATan2
# All supported arguments are listed below
optim = AdamATan2(model.parameters(),
lr=1e-3,
weight_decay=0.1,
betas=(0.9, 0.95)
)
```
## Consistency Tests
We tested the consistency against reference AdamW-atan2 PyTorch implementation. To run tests, clone this repository, run pytest:
```bash
pip install -e .
pytest
```
## References
- https://arxiv.org/pdf/2407.05872
Raw data
{
"_id": null,
"home_page": "https://github.com/imoneoi/adam_atan2",
"name": "adam-atan2",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "One",
"author_email": "imonenext@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f1/bd/ad1ab87c661ddcd62add898a819bd3c32569e683196fa54515bea8816000/adam_atan2-0.0.1.tar.gz",
"platform": null,
"description": "# Adam-atan2 Fused Operator\n\n## Usage\n\nDrop-in replacement of `torch.optim.AdamW`.\n \n - Doesn't support `foreach`, `fused` argument, as the optimizer is already fused\n - Doesn't support `amsgrad`, `maximize`, `capturable`, `differentiable` argument yet\n\n```bash\npip install adam_atan2\n```\n\n```python\nfrom adam_atan2 import AdamATan2\n\n# All supported arguments are listed below\noptim = AdamATan2(model.parameters(),\n lr=1e-3,\n weight_decay=0.1,\n betas=(0.9, 0.95)\n)\n```\n\n## Consistency Tests\n\nWe tested the consistency against reference AdamW-atan2 PyTorch implementation. To run tests, clone this repository, run pytest:\n\n```bash\npip install -e .\npytest\n```\n\n## References\n\n - https://arxiv.org/pdf/2407.05872\n",
"bugtrack_url": null,
"license": null,
"summary": "Adam-atan2 Fused Optimizer",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/imoneoi/adam_atan2"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f1bdad1ab87c661ddcd62add898a819bd3c32569e683196fa54515bea8816000",
"md5": "99d8ae28125b858751a53c41f3ef885d",
"sha256": "ad53c141aea967758357db461c5ff17b1f4d2eaa40b6a378838717a8ce9d1101"
},
"downloads": -1,
"filename": "adam_atan2-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "99d8ae28125b858751a53c41f3ef885d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11987,
"upload_time": "2025-04-01T08:42:59",
"upload_time_iso_8601": "2025-04-01T08:42:59.247598Z",
"url": "https://files.pythonhosted.org/packages/f1/bd/ad1ab87c661ddcd62add898a819bd3c32569e683196fa54515bea8816000/adam_atan2-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-01 08:42:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "imoneoi",
"github_project": "adam_atan2",
"github_not_found": true,
"lcname": "adam-atan2"
}