podman

• podman + jupyterlab is now default setup for local development
• fix issues with prometheus

shift to mlops

What's Changed

• Change of name from ml_project_template to mlops-template, because of the clarified use case of API-streamed ML. Exploratory work now has a separate repository template with identical container base for compatibility.
• Refined structure, lighter documentation, single-container
• Upgrade to nbdev2, but focus nbdev use for ML model development. Less-prone-to-change code parts are now defined in .py files
• New features: api, prometheus metrics, logging, model store
• Improved model & experiment versioning
• Environment options: Codespaces, VSC, jupyterlab & offline install
• Ethical principles and issues
• Working examples

Full Changelog: v0.0.1...v0.0.2

v0.0.1 - Production Ready

What's Changed

• add .devcontainer & Dockerfile
• change from pip to pip-tools on default dependency control protocol
• make Codespaces the default working environment. However, still works in any environment, instructions included.
• add API notebook
• add badges for easy adoption
• add Compliance with GitHub Community Standards
• make github README main documentation. Doc pages still exist, but they are more useful for the child projects.

• remove example project, so now no cleaning is required when a new project is launched
• move best practice to Atlassian Wiki

Changelog:

• Setup Python dependencies using pip-tools by @jussiarpalahti in #3
• Fix notebook tags for papermill, pypi dependencies and slight modifications to Dockerfile, add devcontainer. Resolves #4 and #5. by @nakytoe in #6
• Create CODE_OF_CONDUCT.md by @nakytoe in #8
• Rename pull-request-template.md to pull_request_template.md by @nakytoe in #9
• Create v001_manual_acceptance_tests.md by @nakytoe in #10
• Cleaned documentation & changed requirement install & naming by @nakytoe in #7
• Remove examples & bestpractice, add Docker & devcontainer for ease of install, use and reproducibility, add notebook template for defining API for trained model by @nakytoe in #11
• Rename .github/ISSUE_TEMPLATE/pull_request_template.md to .github/pul… by @nakytoe in #14
• fixes to issues found in testing by @nakytoe in #15

New Contributors

• @jussiarpalahti made their first contribution in #3
• @nakytoe made their first contribution in #6
  (@nuuttisten username changed to @nakytoe)

Known issues

Issue #16

Full Changelog: v0.0.1-beta...v0.0.1

v0.0.1 Beta release

This is beta release of the Helsinki machine learning project template.
There may be unexpected bugs. We are now actively testing the template with real projects. Any feedback is welcome!