From 855a1eb3c5d271d5c10dd3b9424f415b690ea617 Mon Sep 17 00:00:00 2001 From: guillemdb Date: Fri, 8 Nov 2024 11:16:43 +0100 Subject: [PATCH] Update README and workflow names. Add config draft Signed-off-by: guillemdb --- .github/workflows/build.yml | 4 ++-- README.md | 14 ++++++++++++++ config/config.yml | 0 mloq-template | 2 +- 4 files changed, 17 insertions(+), 3 deletions(-) create mode 100644 config/config.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4fef3201..9d4ae719 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -81,13 +81,13 @@ jobs: rye pin --relaxed cpython@${{ matrix.python-version }} rye sync --all-features - - name: Run Pytest on MacOS + - name: Run Pytest on MacOS with rye if: ${{ matrix.os == 'macos-latest' }} run: | set -x rye run test - - name: Run code coverage on Ubuntu + - name: Run code coverage on Ubuntu with rye if: ${{ matrix.os == 'ubuntu-latest' }} run: | set -x diff --git a/README.md b/README.md index 2de89179..65746df8 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,20 @@ Automate project creation following ML best practices. * License: MIT license +## Setting up the repository + +1. Clone the repository: +2. Initialize the submodules: +```bash +git submodule update --init --recursive +``` + +# Testing the templates +1. Navigate to the project root directory. +2. run cookiecutter with the template directory: +```bash +cookiecutter templates/mlops --no-input --overwrite-if-exists +``` ## Features diff --git a/config/config.yml b/config/config.yml new file mode 100644 index 00000000..e69de29b diff --git a/mloq-template b/mloq-template index f13ae31b..faff5db6 160000 --- a/mloq-template +++ b/mloq-template @@ -1 +1 @@ -Subproject commit f13ae31b88554df2ec8fd182fe41b3df55337524 +Subproject commit faff5db63b7b306158a23047b6e5b9ce977f3194