Skip to main content

Predict materials properties using only the composition information.

Project description

Compositionally-Restricted Attention-Based Network (CrabNet)

The Compositionally-Restricted Attention-Based Network (CrabNet), inspired by natural language processing transformers, uses compositional information to predict material properties.

DOI

Open In Colab (PyPI) Read the Docs GitHub Workflow Status

PyPI Code style: black Lines of code GitHub

Conda Conda Conda Anaconda-Server Badge

:warning: This is a fork of the original CrabNet repository :warning:

This is a refactored version of CrabNet, published to PyPI (pip) and Anaconda (conda). In addition to using .csv files, it allows direct passing of Pandas DataFrames as training and validation datasets, similar to automatminer. It also exposes many of the model parameters at the top-level via CrabNet and uses the sklearn-like "instantiate, fit, predict" workflow. An extend_features is implemented which allows utilization of data other than the elemental compositions (e.g. state variables such as temperature or applied load). These changes make CrabNet portable, extensible, and more broadly applicable, and will be incorporated into the parent repository at a later date. Please refer to the CrabNet documentation for details on installation and usage. If you find CrabNet useful, please consider citing the following publication in npj Computational Materials:

Citing

@article{Wang2021crabnet,
 author = {Wang, Anthony Yu-Tung and Kauwe, Steven K. and Murdock, Ryan J. and Sparks, Taylor D.},
 year = {2021},
 title = {Compositionally restricted attention-based network for materials property predictions},
 pages = {77},
 volume = {7},
 number = {1},
 doi = {10.1038/s41524-021-00545-1},
 publisher = {{Nature Publishing Group}},
 shortjournal = {npj Comput. Mater.},
 journal = {npj Computational Materials}
}

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crabnet-2.0.8.tar.gz (52.4 MB view details)

Uploaded Source

Built Distribution

crabnet-2.0.8-py3-none-any.whl (34.7 MB view details)

Uploaded Python 3

File details

Details for the file crabnet-2.0.8.tar.gz.

File metadata

  • Download URL: crabnet-2.0.8.tar.gz
  • Upload date:
  • Size: 52.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for crabnet-2.0.8.tar.gz
Algorithm Hash digest
SHA256 53a4d3b5da398ad87b1aae72c24754ea76a90975ed9fa8073565ca67f85393c6
MD5 275332ecd7643f6ff5160297f04927e0
BLAKE2b-256 13c013be5043fdfc8e3234f5cf7f9581ef508c18edf71270a2d812fbab91f9f1

See more details on using hashes here.

File details

Details for the file crabnet-2.0.8-py3-none-any.whl.

File metadata

  • Download URL: crabnet-2.0.8-py3-none-any.whl
  • Upload date:
  • Size: 34.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for crabnet-2.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4901565abaa5b4cd1a7841b9de647a3906df21676b226a7abf972d113f92054a
MD5 e7232c5db0b96ca8c9d4411dcb5d651c
BLAKE2b-256 7d662b1c538d419b62c67226ee02d01167a3721e3f2b127fe10726b7383ef834

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page