https://github.com/skaftenicki/mlops_template

https://github.com/skaftenicki/mlops_template

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/skaftenicki/mlops_template
• Owner: SkafteNicki
• Created: 2023-01-09T07:36:13.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-09T14:02:36.000Z (5 months ago)
• Last Synced: 2024-10-23T21:56:01.280Z (3 months ago)
• Language: Makefile
• Size: 39.1 KB
• Stars: 12
• Watchers: 2
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🍪 A up-to-date Cookiecutter template for MLOps

---

Inspired by the [cookiecutter-data-science](https://github.com/drivendata/cookiecutter-data-science) template. This

template has been updated to better fit machine learning-based projects and is being used as the core template in

this [MLOps course](https://github.com/SkafteNicki/dtu_mlops).

## Requirements to use the template:

* Python 3.11

* Cookiecutter v2.4.0

## Start a new project

Start by creating a repository either using the Github GUI in the webbrowser or alternatively you can use the

[Github command line interface](https://cli.github.com/) if you have set it up:

```bash

gh repo create  --public --confirm

```

Afterwards on your local machine run

```bash

cookiecutter https://github.com/SkafteNicki/mlops_template

```

and input starting values for the project. When asked for the repository name when creating the template,

input the same name as when you created the repository. Note that when asked for the project name, you should input

a [valid Python package name](https://peps.python.org/pep-0008/#package-and-module-names). This means that the name 

should be all lowercase and only contain letters, numbers and underscores. The project name will be used as the name of 

the Python package. This will automatically be validated by the template.

To commit to the remote repository afterwards execute the following set of commands:

```bash

cd 

git init

git add .

git commit -m "init cookiecutter project"

git remote add origin https://github.com//

git push origin master

```

## The stack

🐍 Python projects using `pyproject.toml` 

🔥 Models in `pytorch` 

📦 Containerized using `docker` 

📄 Documentation in `mkdocs` 

👕 Linting and formatting with `ruff` 

✅ Checking using `pre-commit` 

🛠️ CI with `Github actions`