Merge pull request #311 from mlf-core/release/1.10.0

release/1.10.0

.cookietemple.yml

@@ -15,7 +15,7 @@ full_name: Lukas Heumos
 email: lukas.heumos@posteo.net
 project_name: mlf-core
 project_short_description: Reproducible machine learning pipelines using mlflow.
-version: 1.10.0-SNAPSHOT
+version: 1.10.0
 license: Apache2.0
 command_line_interface: Click
 testing_library: pytest

.github/create.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+set -e
+
+case "$1" in
+
+  pytorch)
+    echo -e "\n\n\n\n\nn\n\n\n\nn" | mlf-core create
+    ;;
+
+  tensorflow)
+    echo -e "\n\033[B\n\n\n\nn\n\n\n\nn" | mlf-core create
+    ;;
+
+  xgboost)
+    echo -e "\n\033[B\033[B\n\n\n\nn\n\n\n\nn" | mlf-core create
+    ;;
+
+  xgboost_dask)
+    echo -e "\n\033[B\033[B\033[B\n\n\n\nn\n\n\n\nn" | mlf-core create
+    ;;
+
+  *)
+    echo -n "unknown"
+    ;;
+esac

.github/workflows/check_no_SNAPSHOT_master.yml → .github/workflows/check_no_SNAPSHOT_master_main.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
     - master
+    - main
 
 jobs:
   test:

.github/workflows/check_patch_release_master_only.yml → .github/workflows/check_patch_release_master_main_only.yml

@@ -1,9 +1,10 @@
-name: PR to master branch from PATCH/release branch only
+name: PR to master/main branch from PATCH/release branch only
 
 on:
   pull_request:
     branches:
     - master
+    - main
 
 jobs:
   test:

.github/workflows/create_mlflow_tensorflow.yml → .github/workflows/create_mlflow.yml

@@ -1,13 +1,23 @@
-name: Create mlflow_tensorflow Template
+name: Create mlflow Template
 
 on: [push, pull_request]
 
 jobs:
-  build:
-
+  create:
+    name: Create mlflow-${{ matrix.template }} Template
     runs-on: ubuntu-latest
 
+    strategy:
+      fail-fast: false
+      matrix:
+        template: [ 'pytorch', 'tensorflow', 'xgboost', 'xgboost_dask' ]
+
     steps:
+      - name: Reclaim space
+        run: |
+             sudo rm -rf /usr/share/dotnet
+             sudo rm -rf /opt/ghc
+
       - uses: actions/checkout@v2
         name: Check out source-code repository
 
@@ -20,10 +30,10 @@ jobs:
         run: |
           make install
 
-      - name: Create mlflow-tensorflow Template
+      - name: Create mlflow-${{ matrix.template }} Template
         run: |
           cd ..
-          echo -e "\n\033[B\n\n\n\nn\n\n\n\nn" | mlf-core create
+          bash mlf-core/.github/create.sh ${{ matrix.template }}
 
       # https://github.com/docker/build-push-action/issues/90
       - name: Copy workaround
@@ -37,6 +47,12 @@ jobs:
       - name: Lint project with flake8
         run: flake8 ../exploding_springfield
 
+      - name: Install bandit
+        run: pip install bandit
+
+      - name: Run bandit
+        run: bandit -r ../exploding_springfield -c ../exploding_springfield/.bandit.yml
+
       - name: Build Docker container
         uses: docker/build-push-action@v1
         with:

.github/workflows/pr_to_master_from_patch_release_only.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
     - master
+    - main
 
 jobs:
   test:

CHANGELOG.rst

@@ -6,16 +6,24 @@ Changelog
 
 This project adheres to `Semantic Versioning <https://semver.org/>`_.
 
-1.10.0-SNAPSHOT (2021-02-21)
-----------------------------
+1.10.0 (2021-03-11)
+-------------------
 
 **Added**
 
 * Tutorial accessible at: mlf-core.com/tutorial (#159)
-* Removed AUTHORS.rst and moved content into docs/authors.rst (#267)
+* [ALL TEMPLATES] Removed AUTHORS.rst and moved content into docs/authors.rst (#267)
+* [ALL TEMPLATES] Added boto3 to environment to allow for S3 accessibility (#278)
+* [ALL TEMPLATES] Workflows, that were triggered when pusing/pr to default master branch do now accept main as default branch
 
 **Fixed**
 
+* Bandit complaining about insecure md5
+* mlf-core pytorch template creation and updated its dependencies versions accordingly (#298)
+* Pytorch template hparam logging with tensorboard now working
+* blacklisted files for sync defined by the user are now correctly picked up
+* blacklisted sync files, that are newly introduced by a PR are now included in the sync PR, they were introduced but not in the following ones
+
 **Dependencies**
 
 **Deprecated**

README.rst

@@ -19,7 +19,7 @@ mlf-core
 .. image:: https://img.shields.io/pypi/v/mlf-core.svg
         :target: https://pypi.python.org/pypi/mlf-core
         :alt: PyPI Status
-        
+
 .. image:: https://static.pepy.tech/personalized-badge/mlf-core?units=international_system&left_color=grey&right_color=green&left_text=Downloads
         :target: https://pepy.tech/project/mlf-core
         :alt: Pepy Downloads
@@ -37,18 +37,14 @@ mlf-core
         :alt: Dependabot Enabled
 
 
-Fully GPU deterministic machine learning project templates using MLflow_.
-
-* Free software: Apache2.0
-* Documentation: https://mlf-core.readthedocs.io.
-
-
-Features
+Overview
 --------
 
-* Jumpstart your machine learning project with fully fledged, (multi) GPU deterministic mlflow project templates
-* Pytorch, Tensorflow, XGBoost supported
-* Conda and Docker support out of the box
+.. figure:: https://user-images.githubusercontent.com/31141763/110704981-02921c80-81f6-11eb-8775-bd73f565568c.png
+   :alt: mlf-core soverview
+
+   mlf-core provides CPU and GPU deterministic machine learning templates based on MLflow, Conda, Docker and a strong Github integration.
+   A custom linter ensures that projects stay deterministic in all phases of development and deployment.
 
 Installing
 ---------------
@@ -120,14 +116,6 @@ Check whether you are using the latest mlf-core version and update automatically
 See `<https://mlf_core.readthedocs.io/en/latest/upgrade.html>`_.
 
 
-.. figure:: https://user-images.githubusercontent.com/21954664/98472352-c2dd0900-21f2-11eb-9fe3-929b2a21bd4c.png
-   :scale: 100 %
-   :alt: mlf-core summary
-
-   mlf-core enables deterministic machine learning. MLflow and a provided Read the Docs setup ensure that all hyperparameters, metrics and model details are well documented.
-   Reproducible environments are provided with the use of Conda and Docker. Finally, the mlf-core ecosystem ensures that all library specific settings required for determinism are enabled,
-   no non-deterministic algorithms are used and that the used hardware is tracked.
-
 Credits
 -------
 

cookietemple.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.10.0-SNAPSHOT
+current_version = 1.10.0
 
 [bumpversion_files_whitelisted]
 setup_file = setup.py

docs/_static/custom_cookietemple.css

@@ -57,12 +57,17 @@ div, span, code {
     background: #2D2E2F !important;
 }
 
-/*Current hovered item has a blue background*/
+/*Current hovered item has a blue background for corresponding parent section*/
 .wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a:hover {
     color: #FFFFFF !important;
     background: #005fff !important;
 }
 
+.wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a:hover {
+    color: #FFFFFF !important;
+    background: #005fff !important;
+}
+
 .wy-menu-vertical li.toctree-l2.current > a:hover {
     color: #FFFFFF !important;
     background: #005fff !important;
@@ -72,6 +77,12 @@ div, span, code {
     color: #FFFFFF !important;
     background: #2D2E2F !important;
 }
+/* Child items of current expanded parent section are white font on dark background*/
+
+.wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a {
+    color: #FFFFFF !important;
+    background: #2D2E2F !important;
+}
 
 .wy-menu-vertical li.toctree-l1.current {
     color: #FFFFFF !important;