mlf-core logo

mlf-core

Github Workflow Build mlf-core Status Github Workflow Tests Status PyPI Status Pepy Downloads Discord Documentation Status Dependabot Enabled

Overview

mlf-core overview

mlf-core provides CPU and GPU deterministic machine learning templates based on MLflow, Conda, Docker and a strong Github integration. Templates are available for PyTorch, TensorFlow and XGBoost. A custom linter ensures that projects stay deterministic in all phases of development and deployment.

Installing

Start your journey with mlf-core by installing it via $ pip install mlf-core.

See Installation.

config

Configure mlf-core to get started.

https://user-images.githubusercontent.com/31141763/102669098-f6199d00-418d-11eb-9ae6-26c12d9c1231.gif

See Configuring mlf-core

list

List all available mlf-core templates.

https://user-images.githubusercontent.com/31141763/102668939-8d322500-418d-11eb-8b2c-acd895fc50e3.gif

See Listing all templates.

info

Get detailed information on a mlf-core template.

https://user-images.githubusercontent.com/31141763/102669191-324cfd80-418e-11eb-9542-d2995b7318a9.gif

See Get detailed template information.

create

Kickstart your deterministic machine laerning project with one of mlf-core’s templates in no time.

https://user-images.githubusercontent.com/31141763/102669143-1184a800-418e-11eb-853b-0deb0387efc6.gif

See Create a project.

lint

Use advanced linting to ensure your project always adheres to mlf-core’s standards and stays deterministic.

https://user-images.githubusercontent.com/31141763/102668893-696edf00-418d-11eb-888e-822244a6f5dc.gif

See Linting your project

bump-version

Bump your project version across several files.

https://user-images.githubusercontent.com/31141763/102668987-aaff8a00-418d-11eb-9292-dc512f77f09b.gif

See Bumping the version of an existing project.

sync

Sync your project with the latest mlf-core release to get the latest template features.

https://user-images.githubusercontent.com/31141763/102669065-de421900-418d-11eb-9e1b-a76487d02b2a.gif

See Syncing a project.

upgrade

Check whether you are using the latest mlf-core version and update automatically to benefit from the latest features.

See https://mlf_core.readthedocs.io/en/latest/upgrade.html.

Credits

Primary idea and main development by Lukas Heumos. mlf-core is inspired by nf-core. This package was created with cookietemple based on a modified audreyr/cookiecutter-pypackage project template using cookiecutter.