Skip to main content

Predict materials properties using only the composition information.

Reason this release was yanked:

error spiked for odd since ~1.3.1, fixed in 2.0.5

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 get_model. 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 and extensible, 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-1.3.5.tar.gz (52.2 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: crabnet-1.3.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-1.3.5.tar.gz
Algorithm Hash digest
SHA256 29994bf726bf35b083f82d2a5fa2c4099b56e4e2608db2305100ba5a7c8554bc
MD5 719c28d34f502f7d29ded4b3084422d0
BLAKE2b-256 f01da62af99a18f0ee13955642f108bc9f4db1ed0db138ce87528ad105f30066

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: crabnet-1.3.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-1.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 39e94b6443619a78c3d561182a9f2e5883e467303cf9ad985091d3a0179dd186
MD5 6adbeceb2eb6e2716a2049e33dabc84f
BLAKE2b-256 1a15d051adc124c0f4d853f2ff889112d1c146968a9774e09c006f5374ed488c

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