# mlip-arena
MLIP Arena is an open-source platform for benchmarking machine learning interatomic potentials (MLIPs). The platform provides a unified interface for users to evaluate the performance of their models on a variety of tasks, including single-point density functional theory calculations and molecular dynamics simulations. The platform is designed to be extensible, allowing users to contribute new models, benchmarks, and training data to the platform.
## Contribute
### Add new MLIP models
If you have pretrained MLIP models that you would like to contribute to the MLIP Arena and show benchmark in real-time, please follow these steps:
1. Create a new [Hugging Face Model](https://huggingface.co/new) repository and upload the model file.
2. Follow the template to code the I/O interface for your model, and upload the script along with metadata to the MLIP Arena [here]().
3. CPU benchmarking will be performed automatically. Due to the limited amount GPU compute, if you would like to be considered for GPU benchmarking, please create a pull request to demonstrate the offline performance of your model (published paper or preprint). We will review and select the models to be benchmarked on GPU.
### Add new benchmarks
#### Molecular dynamics calculations
#### Single-point density functional theory calculations
### Add new training datasets
[Hugging Face Auto-Train](https://huggingface.co/docs/hub/webhooks-guide-auto-retrain)
Raw data
{
"_id": null,
"home_page": null,
"name": "atomind-mlip",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pytorch, machine-learning-interatomic-potentials, huggingface, deep-learning, graph-neural-networks",
"author": null,
"author_email": "Yuan Chiang <cyrusyc@lbl.gov>",
"download_url": "https://files.pythonhosted.org/packages/fb/18/adab24bec3eaf58d8587857068d4827736096bcb71e3cf88be1db2cc7ff4/atomind_mlip-0.0.1.tar.gz",
"platform": null,
"description": "# mlip-arena\n\nMLIP Arena is an open-source platform for benchmarking machine learning interatomic potentials (MLIPs). The platform provides a unified interface for users to evaluate the performance of their models on a variety of tasks, including single-point density functional theory calculations and molecular dynamics simulations. The platform is designed to be extensible, allowing users to contribute new models, benchmarks, and training data to the platform.\n\n## Contribute\n\n### Add new MLIP models\n\nIf you have pretrained MLIP models that you would like to contribute to the MLIP Arena and show benchmark in real-time, please follow these steps:\n\n1. Create a new [Hugging Face Model](https://huggingface.co/new) repository and upload the model file.\n2. Follow the template to code the I/O interface for your model, and upload the script along with metadata to the MLIP Arena [here]().\n3. CPU benchmarking will be performed automatically. Due to the limited amount GPU compute, if you would like to be considered for GPU benchmarking, please create a pull request to demonstrate the offline performance of your model (published paper or preprint). We will review and select the models to be benchmarked on GPU.\n\n### Add new benchmarks\n\n#### Molecular dynamics calculations\n\n\n#### Single-point density functional theory calculations\n\n### Add new training datasets\n\n[Hugging Face Auto-Train](https://huggingface.co/docs/hub/webhooks-guide-auto-retrain)\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/atomind-ai/mlip-arena",
"Issues": "https://github.com/atomind-ai/mlip-arena/issues"
},
"split_keywords": [
"pytorch",
" machine-learning-interatomic-potentials",
" huggingface",
" deep-learning",
" graph-neural-networks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ccee654176ffa30421af29ec1ca7f10f5bbe0e1b4754fa151fbd1333aca5fc5",
"md5": "d69b947fafcbe53385964f83561e658d",
"sha256": "4cd7768ee555ae08a2b7f57f052f50d73fc250f96a9ba9ddc271550b038515b8"
},
"downloads": -1,
"filename": "atomind_mlip-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d69b947fafcbe53385964f83561e658d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1864,
"upload_time": "2024-03-25T06:46:05",
"upload_time_iso_8601": "2024-03-25T06:46:05.555849Z",
"url": "https://files.pythonhosted.org/packages/2c/ce/e654176ffa30421af29ec1ca7f10f5bbe0e1b4754fa151fbd1333aca5fc5/atomind_mlip-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb18adab24bec3eaf58d8587857068d4827736096bcb71e3cf88be1db2cc7ff4",
"md5": "1b1415ec627406de0c51c65f4864c904",
"sha256": "f48d818cd1277e3bf231042c7e3e69c28057f47c95301311e76f2dd89975d8ee"
},
"downloads": -1,
"filename": "atomind_mlip-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "1b1415ec627406de0c51c65f4864c904",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1625,
"upload_time": "2024-03-25T06:46:06",
"upload_time_iso_8601": "2024-03-25T06:46:06.817484Z",
"url": "https://files.pythonhosted.org/packages/fb/18/adab24bec3eaf58d8587857068d4827736096bcb71e3cf88be1db2cc7ff4/atomind_mlip-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 06:46:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "atomind-ai",
"github_project": "mlip-arena",
"github_not_found": true,
"lcname": "atomind-mlip"
}
JSON
