| Name | levmarq-torch JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | Basic PyTorch implementation of the Levenberg-Marquardt algorithm |
| upload_time | 2023-05-04 17:00:22 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) [2023] [Adam Coogan] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
functorch
torch
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# levmarq-torch
A basic PyTorch implementation of the Levenberg-Marquardt algorithm. This solves minimization problems of the form
$$\mathbf{x}^* = \mathrm{argmin}_{\mathbf{x}} |\mathbf{y} - \mathbf{\hat{y}}(\mathbf{x})|^2 \, .$$
The implementation is batched over the parameters $\mathbf{x}$ and datapoints $\mathbf{y}$.
Based on implementation 1 from [Gavin 2022](https://people.duke.edu/~hpgavin/ExperimentalSystems/lm.pdf)
and some help from [Connor Stone](https://github.com/ConnorStoneAstro/).
## Installation
Running
```
git clone git@github.com:adam-coogan/levmarq-torch.git
cd levmarq-torch
pip install .
```
will install the `levmarq_torch` package.
Raw data
{
"_id": null,
"home_page": "",
"name": "levmarq-torch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Adam Coogan <dr.adam.coogan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/05/f3/0c8ce59a7f3221887f1a96cb0a486e0ef361e4ecdb671fdf5e72dffc5a4c/levmarq_torch-0.0.1.tar.gz",
"platform": null,
"description": "# levmarq-torch\n\nA basic PyTorch implementation of the Levenberg-Marquardt algorithm. This solves minimization problems of the form\n\n$$\\mathbf{x}^* = \\mathrm{argmin}_{\\mathbf{x}} |\\mathbf{y} - \\mathbf{\\hat{y}}(\\mathbf{x})|^2 \\, .$$\n\nThe implementation is batched over the parameters $\\mathbf{x}$ and datapoints $\\mathbf{y}$.\n\nBased on implementation 1 from [Gavin 2022](https://people.duke.edu/~hpgavin/ExperimentalSystems/lm.pdf)\nand some help from [Connor Stone](https://github.com/ConnorStoneAstro/).\n\n## Installation\n\nRunning\n```\ngit clone git@github.com:adam-coogan/levmarq-torch.git\ncd levmarq-torch\npip install .\n```\nwill install the `levmarq_torch` package.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2023] [Adam Coogan] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Basic PyTorch implementation of the Levenberg-Marquardt algorithm",
"version": "0.0.1",
"project_urls": {
"homepage": "https://github.com/adam-coogan/levmarq-torch",
"repository": "https://github.com/adam-coogan/levmarq-torch"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0da868a90132aac346f5b81b461e73c5fd2efb72759a50729e8c241958c7027",
"md5": "edadfcb631a5d7c0792e92a2ed949f41",
"sha256": "ecaf5ce261b7eae50b62fa4cb954fe487964da58658f262520bf9de3ae55d507"
},
"downloads": -1,
"filename": "levmarq_torch-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "edadfcb631a5d7c0792e92a2ed949f41",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5695,
"upload_time": "2023-05-04T17:00:20",
"upload_time_iso_8601": "2023-05-04T17:00:20.768983Z",
"url": "https://files.pythonhosted.org/packages/f0/da/868a90132aac346f5b81b461e73c5fd2efb72759a50729e8c241958c7027/levmarq_torch-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05f30c8ce59a7f3221887f1a96cb0a486e0ef361e4ecdb671fdf5e72dffc5a4c",
"md5": "9bd6090510361d03ed2714045326fd35",
"sha256": "f40c59d1f837ccb2f1587411835f807bf853f6c31c6780a706cfcd46f5c8432a"
},
"downloads": -1,
"filename": "levmarq_torch-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9bd6090510361d03ed2714045326fd35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4974,
"upload_time": "2023-05-04T17:00:22",
"upload_time_iso_8601": "2023-05-04T17:00:22.392570Z",
"url": "https://files.pythonhosted.org/packages/05/f3/0c8ce59a7f3221887f1a96cb0a486e0ef361e4ecdb671fdf5e72dffc5a4c/levmarq_torch-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-04 17:00:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adam-coogan",
"github_project": "levmarq-torch",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "functorch",
"specs": []
},
{
"name": "torch",
"specs": [
[
"==",
"1.13.1"
]
]
}
],
"lcname": "levmarq-torch"
}
