V0.3.0 (#3)

Author: fmind

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,17 @@
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Steps to Reproduce the Problem
+
+1.
+1.
+1.
+
+## Specifications
+
+- Version:
+- Platform:
+- Subsystem:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+Fixes #
+
+## Proposed Changes
+
+-
+-
+-

.github/actions/setup/action.yml

@@ -0,0 +1,11 @@
+name: Setup
+description: Setup for project workflows
+runs:
+  using: composite
+  steps:
+    - run: pipx install invoke poetry
+      shell: bash
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+        cache: poetry

.github/workflows/on-pull-request.yml

@@ -0,0 +1,15 @@
+on:
+  pull_request:
+    branches:
+      - main
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: poetry install --with dev,checks,formats
+      - run: poetry run invoke checks

.github/workflows/on-release-published.yml

@@ -0,0 +1,41 @@
+on:
+  release:
+    types: [published]
+env:
+  DOCKER_IMAGE: ghcr.io/fmind/mlops-python-package:latest
+concurrency:
+  cancel-in-progress: true
+  group: on-release-published
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: poetry install --with docs
+      - run: poetry run invoke docs
+      - uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: docs/
+          branch: gh-pages
+  packages:
+    permissions:
+      packages: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: poetry run invoke packages
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/setup-buildx-action@v3
+      - uses: docker/build-push-action@v5
+        with:
+          push: true
+          context: .
+          cache-to: type=gha
+          cache-from: type=gha
+          tags: ${{ env.DOCKER_IMAGE }}

.gitignore

@@ -12,17 +12,13 @@
 # Editor
 /.idea/
 /.vscode/
+.ipynb_checkpoints/
 
 # Environs
 /.venv/
-poetry.lock
-
-# Notebooks
-.ipynb_checkpoints/
 
 # Project
 /docs/*
-/models/*
 /outputs/*
 !**/.gitkeep
 

confs/inference.yaml

@@ -6,6 +6,3 @@ job:
   outputs:
     KIND: ParquetWriter
     path: outputs/predictions.parquet
-  deserializer:
-    KIND: JoblibModelDeserializer
-    path: models/model.joblib

confs/training.yaml

@@ -6,6 +6,3 @@ job:
   targets:
     KIND: ParquetReader
     path: data/targets.parquet
-  serializer:
-    KIND: JoblibModelSerializer
-    path: models/model.joblib