| Name | lean-dojo JSON |
| Version |
1.8.2
JSON |
| download |
| home_page | None |
| Summary | LeanDojo: Machine Learning for Theorem Proving in Lean |
| upload_time | 2024-04-11 13:35:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.12,>=3.9 |
| license | MIT License
Copyright (c) 2023 LeanDojo Team
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 |
lean
machine learning
theorem proving
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
LeanDojo: Machine Learning for Theorem Proving in Lean
======================================================
[LeanDojo](https://leandojo.org/) is a Python library for learning–based theorem provers in Lean, providing two main features:
* Extracting data (proof states, tactics, premises, etc.) from Lean repos.
* Interacting with Lean programmatically.
LeanDojo's current version is compatible with Lean 4 `v4.3.0-rc2` or later. We strongly suggest using the current version. However, you may use the [`legacy`](https://github.com/lean-dojo/LeanDojo/tree/legacy) branch if you want to work with earlier versions (including Lean 3).
[](https://leandojo.readthedocs.io/en/latest/?badge=latest) [](https://pypi.org/project/lean-dojo/) [](https://github.com/lean-dojo/LeanDojo/blob/main/LICENSE) [](https://github.com/psf/black)
______________________________________________________________________
## Requirements
* Supported platforms: Linux, Windows WSL, and macOS
* Git >= 2.25
* 3.9 <= Python < 3.11
* wget
* [elan](https://github.com/leanprover/elan)
* Generate a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) and set the environment variable `GITHUB_ACCESS_TOKEN` to it
## Installation
LeanDojo is available on [PyPI](https://pypi.org/project/lean-dojo/) and can be installed via pip:
```bash
pip install lean-dojo
```
It can also be installed locally from the Git repo:
```bash
pip install .
```
## Documentation
* [Getting Started](https://leandojo.readthedocs.io/en/latest/getting-started.html)
* Demos: [Lean 3](https://github.com/lean-dojo/LeanDojo/blob/main/scripts/demo-lean3.ipynb), [Lean 4](https://github.com/lean-dojo/LeanDojo/blob/main/scripts/demo-lean4.ipynb)
* [Full documentation](https://leandojo.readthedocs.io/en/latest/index.html)
## Questions and Bugs
* For general questions and discussions, please use [GitHub Discussions](https://github.com/lean-dojo/LeanDojo/discussions).
* To report a potential bug, please open an issue. In the issue, please include your OS information, the version of LeanDojo, the exact steps to reproduce the error, and complete logs in debug mode (setting the environment variable `VERBOSE` to 1). The more details you provide, the better we will be able to help you.
## Related Links
* [LeanDojo Website](https://leandojo.org/): The official website of LeanDojo.
* [LeanDojo Benchmark](https://doi.org/10.5281/zenodo.8016385) [](https://doi.org/10.5281/zenodo.8016385): The dataset used in our paper, consisting of theorems and proofs extracted from [mathlib](https://github.com/leanprover-community/mathlib/commits/19c869efa56bbb8b500f2724c0b77261edbfa28c) by [generate-benchmark-lean3.ipynb](./scripts/generate-benchmark-lean3.ipynb).
* [LeanDojo Benchmark 4](https://doi.org/10.5281/zenodo.8040109) [](https://doi.org/10.5281/zenodo.8040109): The Lean 4 version of LeanDojo Benchmark, consisting of theorems and proofs extracted from [mathlib4](https://github.com/leanprover-community/mathlib4/commit/fe4454af900584467d21f4fd4fe951d29d9332a7) by [generate-benchmark-lean4.ipynb](./scripts/generate-benchmark-lean4.ipynb).
* [ReProver](https://github.com/lean-dojo/ReProver): The ReProver (Retrieval-Augmented Prover) model in our paper.
* [LeanDojo ChatGPT Plugin](https://github.com/lean-dojo/LeanDojoChatGPT)
* [Lean Copilot: Running language models as copilots for theorem proving in Lean](https://github.com/lean-dojo/LeanCopilot)
## Citation
[LeanDojo: Theorem Proving with Retrieval-Augmented Language Models](https://leandojo.org/)
Neural Information Processing Systems (NeurIPS), 2023
[Kaiyu Yang](https://yangky11.github.io/), [Aidan Swope](https://aidanswope.com/about), [Alex Gu](https://minimario.github.io/), [Rahul Chalamala](https://rchalamala.github.io/),
[Peiyang Song](https://peiyang-song.github.io/), [Shixing Yu](https://billysx.github.io/), [Saad Godil](https://www.linkedin.com/in/saad-godil-9728353/), [Ryan Prenger](https://www.linkedin.com/in/ryan-prenger-18797ba1/), [Anima Anandkumar](http://tensorlab.cms.caltech.edu/users/anima/)
```bibtex
@inproceedings{yang2023leandojo,
title={{LeanDojo}: Theorem Proving with Retrieval-Augmented Language Models},
author={Yang, Kaiyu and Swope, Aidan and Gu, Alex and Chalamala, Rahul and Song, Peiyang and Yu, Shixing and Godil, Saad and Prenger, Ryan and Anandkumar, Anima},
booktitle={Neural Information Processing Systems (NeurIPS)},
year={2023}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "lean-dojo",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": "Lean, machine learning, theorem proving",
"author": null,
"author_email": "Kaiyu Yang <kaiyuy@caltech.edu>",
"download_url": "https://files.pythonhosted.org/packages/1c/e3/efbd2e740951b8d7b841958b51fc91141f8859b3ae2daaac41af9995947c/lean_dojo-1.8.2.tar.gz",
"platform": null,
"description": "LeanDojo: Machine Learning for Theorem Proving in Lean\n======================================================\n\n\n\n[LeanDojo](https://leandojo.org/) is a Python library for learning\u2013based theorem provers in Lean, providing two main features:\n\n* Extracting data (proof states, tactics, premises, etc.) from Lean repos.\n* Interacting with Lean programmatically.\n\nLeanDojo's current version is compatible with Lean 4 `v4.3.0-rc2` or later. We strongly suggest using the current version. However, you may use the [`legacy`](https://github.com/lean-dojo/LeanDojo/tree/legacy) branch if you want to work with earlier versions (including Lean 3).\n\n[](https://leandojo.readthedocs.io/en/latest/?badge=latest) [](https://pypi.org/project/lean-dojo/) [](https://github.com/lean-dojo/LeanDojo/blob/main/LICENSE) [](https://github.com/psf/black) \n\n______________________________________________________________________\n\n## Requirements\n\n* Supported platforms: Linux, Windows WSL, and macOS\n* Git >= 2.25\n* 3.9 <= Python < 3.11\n* wget\n* [elan](https://github.com/leanprover/elan)\n* Generate a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) and set the environment variable `GITHUB_ACCESS_TOKEN` to it\n\n\n## Installation\n\nLeanDojo is available on [PyPI](https://pypi.org/project/lean-dojo/) and can be installed via pip:\n```bash\npip install lean-dojo\n```\n\nIt can also be installed locally from the Git repo:\n```bash\npip install .\n```\n\n\n## Documentation\n\n* [Getting Started](https://leandojo.readthedocs.io/en/latest/getting-started.html)\n* Demos: [Lean 3](https://github.com/lean-dojo/LeanDojo/blob/main/scripts/demo-lean3.ipynb), [Lean 4](https://github.com/lean-dojo/LeanDojo/blob/main/scripts/demo-lean4.ipynb)\n* [Full documentation](https://leandojo.readthedocs.io/en/latest/index.html)\n\n\n## Questions and Bugs\n\n* For general questions and discussions, please use [GitHub Discussions](https://github.com/lean-dojo/LeanDojo/discussions). \n* To report a potential bug, please open an issue. In the issue, please include your OS information, the version of LeanDojo, the exact steps to reproduce the error, and complete logs in debug mode (setting the environment variable `VERBOSE` to 1). The more details you provide, the better we will be able to help you. \n\n\n## Related Links\n\n* [LeanDojo Website](https://leandojo.org/): The official website of LeanDojo.\n* [LeanDojo Benchmark](https://doi.org/10.5281/zenodo.8016385) [](https://doi.org/10.5281/zenodo.8016385): The dataset used in our paper, consisting of theorems and proofs extracted from [mathlib](https://github.com/leanprover-community/mathlib/commits/19c869efa56bbb8b500f2724c0b77261edbfa28c) by [generate-benchmark-lean3.ipynb](./scripts/generate-benchmark-lean3.ipynb). \n* [LeanDojo Benchmark 4](https://doi.org/10.5281/zenodo.8040109) [](https://doi.org/10.5281/zenodo.8040109): The Lean 4 version of LeanDojo Benchmark, consisting of theorems and proofs extracted from [mathlib4](https://github.com/leanprover-community/mathlib4/commit/fe4454af900584467d21f4fd4fe951d29d9332a7) by [generate-benchmark-lean4.ipynb](./scripts/generate-benchmark-lean4.ipynb).\n* [ReProver](https://github.com/lean-dojo/ReProver): The ReProver (Retrieval-Augmented Prover) model in our paper.\n* [LeanDojo ChatGPT Plugin](https://github.com/lean-dojo/LeanDojoChatGPT)\n* [Lean Copilot: Running language models as copilots for theorem proving in Lean](https://github.com/lean-dojo/LeanCopilot)\n\n## Citation\n\n[LeanDojo: Theorem Proving with Retrieval-Augmented Language Models](https://leandojo.org/) \nNeural Information Processing Systems (NeurIPS), 2023 \n[Kaiyu Yang](https://yangky11.github.io/), [Aidan Swope](https://aidanswope.com/about), [Alex Gu](https://minimario.github.io/), [Rahul Chalamala](https://rchalamala.github.io/), \n[Peiyang Song](https://peiyang-song.github.io/), [Shixing Yu](https://billysx.github.io/), [Saad Godil](https://www.linkedin.com/in/saad-godil-9728353/), [Ryan Prenger](https://www.linkedin.com/in/ryan-prenger-18797ba1/), [Anima Anandkumar](http://tensorlab.cms.caltech.edu/users/anima/)\n\n```bibtex\n@inproceedings{yang2023leandojo,\n title={{LeanDojo}: Theorem Proving with Retrieval-Augmented Language Models},\n author={Yang, Kaiyu and Swope, Aidan and Gu, Alex and Chalamala, Rahul and Song, Peiyang and Yu, Shixing and Godil, Saad and Prenger, Ryan and Anandkumar, Anima},\n booktitle={Neural Information Processing Systems (NeurIPS)},\n year={2023}\n}\n```\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2023 LeanDojo Team\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "LeanDojo: Machine Learning for Theorem Proving in Lean",
"version": "1.8.2",
"project_urls": {
"Bug Tracker": "https://github.com/lean-dojo/LeanDojo/issues",
"Homepage": "https://leandojo.org/"
},
"split_keywords": [
"lean",
" machine learning",
" theorem proving"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a612534fe0a15d224712e275628372339a3b4ae256f4894f7ea720efe4e721de",
"md5": "a551964f3fa8d9e46bc6f13f2cfb832e",
"sha256": "6e002100594e96f32dc96d1887e066c9eb26f6b85c616ce96e5c050ac45cc0a1"
},
"downloads": -1,
"filename": "lean_dojo-1.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a551964f3fa8d9e46bc6f13f2cfb832e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 55533,
"upload_time": "2024-04-11T13:35:28",
"upload_time_iso_8601": "2024-04-11T13:35:28.089802Z",
"url": "https://files.pythonhosted.org/packages/a6/12/534fe0a15d224712e275628372339a3b4ae256f4894f7ea720efe4e721de/lean_dojo-1.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1ce3efbd2e740951b8d7b841958b51fc91141f8859b3ae2daaac41af9995947c",
"md5": "a5f27096ce40e55038fabd7695e626f3",
"sha256": "39021cc03d311eebfd63c4cf7cec724b987c809ab4ae45e602213f4f147dbbdf"
},
"downloads": -1,
"filename": "lean_dojo-1.8.2.tar.gz",
"has_sig": false,
"md5_digest": "a5f27096ce40e55038fabd7695e626f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 52977,
"upload_time": "2024-04-11T13:35:26",
"upload_time_iso_8601": "2024-04-11T13:35:26.421246Z",
"url": "https://files.pythonhosted.org/packages/1c/e3/efbd2e740951b8d7b841958b51fc91141f8859b3ae2daaac41af9995947c/lean_dojo-1.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 13:35:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lean-dojo",
"github_project": "LeanDojo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lean-dojo"
}
