{"id":18478630,"url":"https://github.com/facebookresearch/optimizers","last_synced_at":"2025-05-15T15:03:51.867Z","repository":{"id":37616929,"uuid":"477903724","full_name":"facebookresearch/optimizers","owner":"facebookresearch","description":"For optimization algorithm research and development.","archived":false,"fork":false,"pushed_at":"2025-03-31T15:54:57.000Z","size":649,"stargazers_count":502,"open_issues_count":10,"forks_count":39,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-03-31T20:05:31.086Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/facebookresearch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-04T23:08:20.000Z","updated_at":"2025-03-30T00:49:12.000Z","dependencies_parsed_at":"2023-12-14T22:54:33.207Z","dependency_job_id":"5b77e578-36ad-4b8a-98db-23d04b73e1ab","html_url":"https://github.com/facebookresearch/optimizers","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facebookresearch%2Foptimizers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facebookresearch%2Foptimizers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facebookresearch%2Foptimizers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facebookresearch%2Foptimizers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/facebookresearch","download_url":"https://codeload.github.com/facebookresearch/optimizers/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247730068,"owners_count":20986404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T12:10:53.364Z","updated_at":"2025-05-15T15:03:51.861Z","avatar_url":"https://github.com/facebookresearch.png","language":"Python","funding_links":[],"categories":["Optimizations and fine-tuning","Python"],"sub_categories":[],"readme":"# Optimizers\n\n[![Python3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/)\n[![tests](https://github.com/facebookresearch/optimizers/actions/workflows/tests.yaml/badge.svg)](https://github.com/facebookresearch/optimizers/actions/workflows/tests.yaml?query=branch%3Amain)\n[![gpu-tests](https://github.com/facebookresearch/optimizers/actions/workflows/gpu-tests.yaml/badge.svg)](https://github.com/facebookresearch/optimizers/actions/workflows/gpu-tests.yaml?query=branch%3Amain)\n[![pre-commit](https://github.com/facebookresearch/optimizers/actions/workflows/pre-commit.yaml/badge.svg)](https://github.com/facebookresearch/optimizers/actions/workflows/pre-commit.yaml?query=branch%3Amain)\n[![type-checking](https://github.com/facebookresearch/optimizers/actions/workflows/type-check.yaml/badge.svg)](https://github.com/facebookresearch/optimizers/actions/workflows/type-check.yaml?query=branch%3Amain)\n[![examples](https://github.com/facebookresearch/optimizers/actions/workflows/examples.yaml/badge.svg)](https://github.com/facebookresearch/optimizers/actions/workflows/examples.yaml?query=branch%3Amain)\n[![license](https://img.shields.io/badge/license-BSD--Clause-lightgrey.svg)](./LICENSE)\n\n\n*Copyright (c) Meta Platforms, Inc. and affiliates.\nAll rights reserved.*\n\n## Description\nOptimizers is a Github repository of PyTorch optimization algorithms. It is designed for external collaboration and development.\n\nCurrently includes the optimizers:\n- Distributed Shampoo\n\nSee the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.\n\n## License\nOptimizers is released under the [BSD license](LICENSE).\n\n## Installation and Dependencies\nThis code requires `python\u003e=3.12` and `torch\u003e=2.7.0`.\nInstall `distributed_shampoo` with all dependencies:\n```bash\ngit clone git@github.com:facebookresearch/optimizers.git\ncd optimizers\npip install .\n```\nIf you also want to try the [examples](./distributed_shampoo/examples/), replace the last line with `pip install \".[examples]\"`.\n\n## Usage\n\nAfter installation, basic usage looks like:\n```python\nimport torch\nfrom distributed_shampoo import AdamGraftingConfig, DistributedShampoo\n\nmodel = ...  # Instantiate model\n\noptim = DistributedShampoo(\n    model.parameters(),\n    lr=1e-3,\n    betas=(0.9, 0.999),\n    epsilon=1e-8,\n    grafting_config=AdamGraftingConfig(\n        beta2=0.999,\n        epsilon=1e-8,\n    ),\n)\n```\n\nFor more, please see the [additional documentation here](./distributed_shampoo/README.md) and especially the [How to Use](./distributed_shampoo/README.md#how-to-use) section.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffacebookresearch%2Foptimizers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffacebookresearch%2Foptimizers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffacebookresearch%2Foptimizers/lists"}