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

This version

2.0.7

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

Uploaded Source

Built Distribution

crabnet-2.0.7-py3-none-any.whl (35.2 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for crabnet-2.0.7.tar.gz
Algorithm Hash digest
SHA256 5cac6a9c9fc5980cefec22b084edc526356795428327366280943793cdf3a86b
MD5 95a014dc2dfef21c8cb6946a51877f4e
BLAKE2b-256 355f83e32c12555e73f2016eded04d1087267ed76d7b18189a8652455752b4e0

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for crabnet-2.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9562940abedf8e5e7198ff8b1d2e186ab9d7f922a833cc671ca9371fbd34bfef
MD5 d7b5e72a062850ab6495da72473870d1
BLAKE2b-256 77c009d31a40ec2d0ff72c4c4428ce5e58452e734d2179666e68979bc2f68e47

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