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.5.tar.gz (52.2 MB view details)

Uploaded Source

Built Distribution

crabnet-2.0.5-py3-none-any.whl (34.6 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for crabnet-2.0.5.tar.gz
Algorithm Hash digest
SHA256 fd6be296aa8bfffb389fd1f0e8994d321cc460a52d29257995570ce72748a098
MD5 550dc08c6e9405bb46b0230df7e28595
BLAKE2b-256 fb27ab314d864bb0fae18e9716a551da725e4789e0949f2761b96b47bd66221f

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for crabnet-2.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0caee9ffd94cd6f662a40f8f61f9bb13ec1ed9c1e3c662be2b08f86c27c9caa4
MD5 5c92f740ee851ba417412d52b34414d2
BLAKE2b-256 8bf0fdeb1ce11272fcfe470975d71fdedd6a5d3d7face5ca149cf144620527e8

See more details on using hashes here.

Provenance

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