Skip to main content

Machine Learned Diffusion Coefficient Estimator - ML-DiCE is an ML framework that can predict five modes of elemental diffusion in alloys

Project description

ML-DiCE | Machine Learned Diffusion Coefficient Estimator


DOI PyPI

Installation

pip install mldice

Usage

Create a conda environment as

conda create --name myEnv

Activate the environment created

conda activate myEnv

In the activated environment, run

mldice -options

ML-DiCE will featurize your alloy or impure metal and predict diffusion coefficient in m^2/s. The options can be set through following arguments

Use -de to specify diffusing element -dm to specify diffusion medium. Examples:

  • -de Fe would take iron as diffusing element.
  • -dm Ni75.5Cu24Co0.5 select Ni75.5Cu24Co0.5 is the diffusion medium where constituent elements expressed as percentage
  • -t 500 would select the temperature (say, 500K in this case) of diffusion process in Kelvin.
  • -m self select self diffusion mechanism. Mechanisms include self, impurity and chemical modes.
  • -e RF would select Random Forest regression as prediction algorithm. DNN selects neural network based prediction.

Essentially, the run command shall be as follows:

ML-DiCE.py -de [diffusing element] -dm [diffusion medium] -t [temperature] -s [prediction algorithm] -e RF

Output

All outputs can be found in the Prediction.md file. It contains the following information:

Predicted parameters

Property Value
Predicted D -- m^2/s
RMSE -- m^2/s
MAE -- m^2/s
Uncertainty -- m^2/s

Online Ressources

Citation

@software{mldice,
  author       = {Kulathuvayal Arjun S., Su Yanqing },
  title        = {{Elemental Diffusion Coefficient Prediction in Conventional Alloys using Machine Learning}},
  month        = june,
  year         = 2024,
  publisher    = {--},
  version      = {v0.0.1},
  doi          = {--},
  url          = {--}
}

Under development

Advanced featurization for alloys: New featurization schemes are under developing

Project details


Download files

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

Source Distribution

mldice-0.1.6.tar.gz (72.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mldice-0.1.6-py3-none-any.whl (74.9 MB view details)

Uploaded Python 3

File details

Details for the file mldice-0.1.6.tar.gz.

File metadata

  • Download URL: mldice-0.1.6.tar.gz
  • Upload date:
  • Size: 72.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.13

File hashes

Hashes for mldice-0.1.6.tar.gz
Algorithm Hash digest
SHA256 ad8fe46098d67309c09a541d5eb05a7ec1ab331399411e9e025521c60073755c
MD5 5d10f7a34a217140429805d83f15ac72
BLAKE2b-256 92bf110efae16a995c48225dc2d95dceb156a19ecb507c898ab140b78afd9bf4

See more details on using hashes here.

File details

Details for the file mldice-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: mldice-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 74.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.13

File hashes

Hashes for mldice-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 64eb68515f67d461ddc41964328621d1d86716af649ddf5a80a4e45f104fe3f8
MD5 78ca23a01ff44f2186f71f4a2fd9ed36
BLAKE2b-256 89b534d3816ebff1f0647177b5e66b80205e962360c71e2960169c29cb893ee6

See more details on using hashes here.

Supported by

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