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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mldice-0.1.9.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.9.tar.gz
Algorithm Hash digest
SHA256 fc099b8b65a919e26389ac61f58812740a0b49d2faede0dfa6fafedc50515a80
MD5 d3bc39299776c0411bf662a1ef879b86
BLAKE2b-256 3ae119cb6a63ef6f20293c81243bdd2176ea2c1030ef98d1316e934b7d464dc6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mldice-0.1.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 dda496b1fc5b5cdfc0e9cc31ba8a70305c5364b88c423111ca4090c350bf5cb1
MD5 36d214d405df9e4af561cb90e9a4a977
BLAKE2b-256 ad83a32320cc59f2faa2a9c146903ac861177d0cd2734ca465e6dea4453ec950

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