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.7.tar.gz (75.7 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.7-py3-none-any.whl (77.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mldice-0.1.7.tar.gz
  • Upload date:
  • Size: 75.7 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.7.tar.gz
Algorithm Hash digest
SHA256 40a4662211d5eaf401ab37568b0097928c36ad7d0eb7e741d57cdcdd52e9ca29
MD5 1252bfea3a6c4589b1bf934a36044164
BLAKE2b-256 80af7eb411c180d06c823c4460fa362e2b6979fc326f96be60ef25fc61ad5f10

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mldice-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 77.4 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 089b3cc70f1ae0ca8919da9a477dc04adb1f3710ee71b595151907ca4b4bcde5
MD5 ea4f8947a4c1c783fc4aa663fb159a37
BLAKE2b-256 c2fa544f4510e6382c9574b64002d7fda9d09a4e56581ac8ed7180c552f554a5

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