# CGCNN2
As the original Crystal Graph Convolutional Neural Networks (CGCNN) repository is no longer actively maintained, this repository is a reproduction of [CGCNN](https://github.com/txie-93/cgcnn) by Xie et al. It includes necessary updates for deprecated components and a few additional functions to ensure smooth operation. Despite its age, CGCNN remains a straightforward and fast deep learning framework that is easy to learn and use.
The package provides following major functions:
- **Training** a CGCNN model with a customized dataset.
- **Predicting** material properties with a pre-trained CGCNN model.
- **Fine-tuning** a pre-trained CGCNN model on a new dataset.
- **Extracting** atomic features as descriptors for the downstream task.
## Installation
Make sure you have a Python interpreter, preferably version 3.10 or higher. Then, you can simply install xdatbus from
PyPI using `pip`:
```bash
pip install cgcnn2
```
If you'd like to use the latest unreleased version on the main branch, you can install it directly from GitHub:
```bash
pip install git+https://github.com/jcwang587/cgcnn2
```
## Get Started
```bash
cgcnn-ft --help
```
## References
The original paper describes the details of the CGCNN framework:
```bibtex
@article{PhysRevLett.120.145301,
title = {Crystal Graph Convolutional Neural Networks for an Accurate and Interpretable Prediction of Material Properties},
author = {Xie, Tian and Grossman, Jeffrey C.},
journal = {Phys. Rev. Lett.},
volume = {120},
issue = {14},
pages = {145301},
numpages = {6},
year = {2018},
month = {Apr},
publisher = {American Physical Society},
doi = {10.1103/PhysRevLett.120.145301},
url = {https://link.aps.org/doi/10.1103/PhysRevLett.120.145301}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/jcwang587/cgcnn2/",
"name": "cgcnn2",
"maintainer": "Jiacheng Wang",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "python, gnn, vasp, crystal",
"author": "Jiacheng Wang",
"author_email": "jiachengwang@umass.edu",
"download_url": "https://files.pythonhosted.org/packages/09/35/6adaf0557e18ab3b548eaccdf8c17f095a069ff57ff7760ee0feddafd1a5/cgcnn2-0.1.7.tar.gz",
"platform": null,
"description": "# CGCNN2\n\nAs the original Crystal Graph Convolutional Neural Networks (CGCNN) repository is no longer actively maintained, this repository is a reproduction of [CGCNN](https://github.com/txie-93/cgcnn) by Xie et al. It includes necessary updates for deprecated components and a few additional functions to ensure smooth operation. Despite its age, CGCNN remains a straightforward and fast deep learning framework that is easy to learn and use.\n\nThe package provides following major functions:\n\n- **Training** a CGCNN model with a customized dataset.\n- **Predicting** material properties with a pre-trained CGCNN model.\n- **Fine-tuning** a pre-trained CGCNN model on a new dataset.\n- **Extracting** atomic features as descriptors for the downstream task.\n\n## Installation\n\nMake sure you have a Python interpreter, preferably version 3.10 or higher. Then, you can simply install xdatbus from\nPyPI using `pip`:\n\n```bash\npip install cgcnn2\n```\n\nIf you'd like to use the latest unreleased version on the main branch, you can install it directly from GitHub:\n\n```bash\npip install git+https://github.com/jcwang587/cgcnn2\n```\n\n## Get Started\n\n```bash\ncgcnn-ft --help\n```\n\n\n## References\n\nThe original paper describes the details of the CGCNN framework:\n\n```bibtex\n@article{PhysRevLett.120.145301,\n title = {Crystal Graph Convolutional Neural Networks for an Accurate and Interpretable Prediction of Material Properties},\n author = {Xie, Tian and Grossman, Jeffrey C.},\n journal = {Phys. Rev. Lett.},\n volume = {120},\n issue = {14},\n pages = {145301},\n numpages = {6},\n year = {2018},\n month = {Apr},\n publisher = {American Physical Society},\n doi = {10.1103/PhysRevLett.120.145301},\n url = {https://link.aps.org/doi/10.1103/PhysRevLett.120.145301}\n}\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Crystal Graph Convolutional Neural Networks",
"version": "0.1.7",
"project_urls": {
"Homepage": "https://github.com/jcwang587/cgcnn2/",
"Repository": "https://github.com/jcwang587/cgcnn2/"
},
"split_keywords": [
"python",
" gnn",
" vasp",
" crystal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73337902b044f6ffd68440b3b30c256ed9c950b210f0e39433561cc2b269eac7",
"md5": "40020d6cf5e0ff0d263c039c39559427",
"sha256": "cd8d0ba815ab4ea2da07c0ac478322f70f414ccd6401573e2c89d89b97720ce1"
},
"downloads": -1,
"filename": "cgcnn2-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "40020d6cf5e0ff0d263c039c39559427",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15778,
"upload_time": "2024-11-12T03:27:42",
"upload_time_iso_8601": "2024-11-12T03:27:42.846416Z",
"url": "https://files.pythonhosted.org/packages/73/33/7902b044f6ffd68440b3b30c256ed9c950b210f0e39433561cc2b269eac7/cgcnn2-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "09356adaf0557e18ab3b548eaccdf8c17f095a069ff57ff7760ee0feddafd1a5",
"md5": "40ab6582ad447264d3350808f6146f9a",
"sha256": "38ad19cb99e617963f8cd3cdf2efa1193f8edec83c30ca6e4fedb2e357c1f9c5"
},
"downloads": -1,
"filename": "cgcnn2-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "40ab6582ad447264d3350808f6146f9a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14589,
"upload_time": "2024-11-12T03:27:44",
"upload_time_iso_8601": "2024-11-12T03:27:44.853511Z",
"url": "https://files.pythonhosted.org/packages/09/35/6adaf0557e18ab3b548eaccdf8c17f095a069ff57ff7760ee0feddafd1a5/cgcnn2-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 03:27:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jcwang587",
"github_project": "cgcnn2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cgcnn2"
}
JSON
