Skip to content

mlf-core/mlf-core

Repository files navigation

mlf-core logo

mlf-core

PyPI Python Version License Read the documentation at https://mlf-core.readthedocs.io/ Build Package Status Run Tests Status Codecov pre-commit Black

Pepy Downloads

Discord

Preprint

mlf-core: a framework for deterministic machine learning

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.

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.

run

See a mlf-core project in action.

config

Configure mlf-core to get started.

See Configuring mlf-core

list

List all available mlf-core templates.

See Listing all templates.

info

Get detailed information on a mlf-core template.

See Get detailed template information.

create

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

See Create a project.

lint

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

image

See Linting your project

bump-version

Bump your project version across several files.

See Bumping the version of an existing project.

sync

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

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.