Initial commit

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/container-build.yml

@@ -0,0 +1,17 @@
+name: Container Build
+on:
+  - pull_request
+  - push
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Builds Docker Image
+        run: docker compose build notebook
+
+      - name: Stops Containers
+        run: docker compose down

.github/workflows/dependa-auto-merge.yml

@@ -0,0 +1,23 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        if: ${{ steps.metadata.outputs.update-type == 'version-update:semver-patch' }}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.ipynb_checkpoints

Dockerfile

@@ -0,0 +1,19 @@
+FROM python:3.9-slim-buster
+
+RUN mkdir /app
+
+WORKDIR /app
+
+RUN apt-get update \
+  && apt-get install --yes --no-install-recommends \
+    build-essential
+
+COPY requirements.txt .
+
+RUN pip install -r requirements.txt
+
+COPY . .
+
+EXPOSE 8888
+
+ENTRYPOINT ["jupyter", "notebook", "--ip=0.0.0.0", "--no-browser", "--allow-root"]

Justfile

@@ -0,0 +1,19 @@
+# Prints available recipes
+default:
+    just --list
+
+# Starts the Environment using Docker
+dev:
+  docker compose up notebook
+
+# Builds Docker Environment
+build:
+  docker compose build notebook
+
+# Stops the Docker Environment
+undev:
+  docker compose down
+
+# SSH into the Docker Container
+bash:
+  docker exec -it <CONTAINER ID> bash

README.md

@@ -0,0 +1,31 @@
+<div>
+  <h1 align="center">Docker Machine Learning</h1>
+  <h4 align="center">A template for Machine Learning projects with Docker</h4>
+</div>
+
+## Motivation
+
+Spin up Machine Learning projects with ease, avoiding a virtual environment
+setup by using Docker, extending compatibility for collaboration by having
+a operative system agnostic environment.
+
+## Run Locally
+
+Build an run containers using `docker compose`
+
+```bash
+docker compose up --build notebook
+```
+
+> Using `Justfile` this is a matter of running `just build` and from
+> there on `just dev`
+
+After working you can release resources using:
+
+```bash
+docker compose down
+```
+
+> A [Justfile][1] is included!
+
+[1]: https://just.systems

docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+
+services:
+  notebook:
+    build: 
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - .:/app
+    ports:
+      - 8888:8888

requirements.txt

@@ -0,0 +1,12 @@
+h5py == 3.10.0
+jupyter == 1.0.0
+keras == 3.1.1
+matplotlib == 3.8.4
+notebook == 7.1.2
+numpy == 1.26.4
+pandas == 2.2.1
+pillow == 10.3.0
+scikit-learn == 1.4.0
+seaborn == 0.13.2
+spacy == 3.7.4
+tensorflow == 2.16.1