Skip to content

Regression model package predicting the energy above hull of perovskite oxides.

License

Notifications You must be signed in to change notification settings

machinelurning/stableperovskites-pkg

Repository files navigation

stableperovskites

A regression model that predicts the energy above hull of a perovskite oxide. API available here.

Table of Contents

General Information

As a data scientist, my coding experience, as of a few months ago, have mostly been via Jupyter Notebooks so for the last few months, I have been trying to learn how to write production-ready code that isn't just spaghetti code in a notebook. This package is a culmination of sorts of my learnings, so while stableperovskites is technically a regression model, I intended this project to show my skills in writing production-ready code, such as (but not limited to):

  • Unit testing with pytest
  • Type checking with mypy
  • Data validation and settings management with pydantic
  • Package building and publishing
  • Error handling
  • Automated building, testing, and deployment with tox and GitHub Actions

Usage

The project is meant to be consumed via API. The code for said API is also available in a separate repo.

About

Regression model package predicting the energy above hull of perovskite oxides.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages