Merge branch 'main' into release

.github/dependabot.yml

@@ -7,3 +7,4 @@ updates:
     # Check the pypi registry for updates every week
     schedule:
       interval: "weekly"
+    versioning-strategy: lockfile-only

.github/workflows/continuous_integration.yml

@@ -20,6 +20,10 @@ on:
     - make_release.sh
     - CITATION.cff
 
+env:
+  PYTHON_VERSION: "3.8"
+
+
 jobs:
 
   lint_with_pylint:
@@ -28,10 +32,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.8
+    - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: ${{ env.PYTHON_VERSION }}
     - name: Install pylint
       run: |
         python -m pip install --upgrade pip
@@ -47,10 +51,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.8
+    - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: ${{ env.PYTHON_VERSION }}
     - name: Install black
       run: |
         python -m pip install --upgrade pip
@@ -88,8 +92,25 @@ jobs:
       run: |
         sphinx-build -W -b html ./docs ./docs/_build
 
+  check_with_darglint:
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+    - name: Install darglint
+      run: |
+        python -m pip install --upgrade pip
+        pip install darglint
+    - name: Check with darglint
+      run: |
+        sh run_darglint.sh
+
   test_with_pytest:
-    needs: [lint_with_pylint, format_with_black_and_isort, check_docstrings]
+    needs: [lint_with_pylint, format_with_black_and_isort, check_docstrings, check_with_darglint]
     runs-on: ubuntu-latest
 
     steps:
@@ -98,10 +119,10 @@ jobs:
       #----------------------------------------------
       - name: Check out repository
         uses: actions/checkout@v2
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v2
+      - name: Set up Python
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: ${{ env.PYTHON_VERSION }}
 
       #----------------------------------------------
       #  -----  install & configure poetry  -----
@@ -112,23 +133,32 @@ jobs:
           virtualenvs-create: true
           virtualenvs-in-project: true
           installer-parallel: true
+      - name: Set ENV VARS
+        run: |
+          echo "POETRY_VERSION=$(poetry -V | cut -d' ' -f3)" >> $GITHUB_ENV
+
+      #----------------------------------------------
+      # cache the directory where poetry caches packages
+      #----------------------------------------------
+      - name: Cache Poetry cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pypoetry
+          key: poetry-cache-${{ runner.os }}-${{ env.PYTHON_VERSION }}-${{ env.POETRY_VERSION }}
 
       #----------------------------------------------
-      #       load cached venv if cache exists
+      # cache the directory where pip caches packages
       #----------------------------------------------
-      - name: Set up Poetry cache for Python dependencies
-        id: cached-poetry-dependencies
-        # uses: actions/cache@v2
-        uses: pat-s/always-upload-cache@v2
+      - name: Cache Pip cache
+        uses: actions/cache@v3
         with:
-          path: .venv
-          key: venvEM2-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
+          path: ~/.cache/pip
+          key: pip-cache-${{ runner.os }}-${{ env.PYTHON_VERSION }}
 
       #----------------------------------------------
-      # install dependencies if cache does not exist
+      #  ---------  install dependencies  --------
       #----------------------------------------------
       - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
         run: |
           poetry install -E ci --no-interaction --no-root
           poetry run pip install torch --extra-index-url https://download.pytorch.org/whl/cpu

.github/workflows/dummy_ci.yml

@@ -60,6 +60,15 @@ jobs:
       run: |
         sphinx-build -W -b html ./docs ./docs/_build
         
+  check_with_darglint:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check with darglint
+      run: |
+        echo "pass!"
+
   test_with_pytest:
 
     runs-on: ubuntu-latest

.gitignore

@@ -104,3 +104,5 @@ results/*
 !/ethicml/data/csvs/celeba.csv.zip
 !/ethicml/data/csvs/genfaces.csv.zip
 !/ethicml/data/csvs/health.csv.zip
+
+/darglint.out

check_all.py

@@ -3,9 +3,9 @@
 import subprocess
 
 import black
-import pytest
 from mypy import api as mypy
 from pylint import lint as pylint
+import pytest
 
 # pytest
 print("############### pytest #################")

docs/ethicml/evaluate.rst

@@ -0,0 +1,5 @@
+Model evaluation
+================
+
+.. automodule:: ethicml.evaluators.evaluate
+   :autosummary:

docs/ethicml/utility.rst

@@ -6,3 +6,5 @@ Utils
    :members:
    :imported-members:
    :autosummary:
+
+.. autoclass:: Results

ethicml/__init__.py

@@ -4,7 +4,7 @@
 """
 from .common import *
 from .evaluators.cross_validator import *
-from .evaluators.evaluate_models import *
+from .evaluators.evaluate import *
 from .evaluators.parallelism import *
 from .preprocessing.adjust_labels import *
 from .preprocessing.biased_split import *

ethicml/common.py

@@ -1,6 +1,6 @@
 """Common variables / constants that make things run smoother."""
-import os
 from importlib import util
+import os
 from pathlib import Path
 
 __all__ = ["TORCH_AVAILABLE", "ROOT_DIR", "ROOT_PATH"]

ethicml/data/csvs/make_lipton.py

@@ -18,7 +18,7 @@ def main() -> None:
     hair_length_1: np.ndarray = 35 * rng.beta(2, 2, SAMPLES)
     hair_length = np.where(z == 1, hair_length_1, hair_length_0)
 
-    pois = rng.poisson((25 + 6 * z))
+    pois = rng.poisson(25 + 6 * z)
     norm = rng.normal(20, 0.2, SAMPLES)
     work_experience: np.ndarray = pois - norm
 

ethicml/data/csvs/make_nursery.py

@@ -43,7 +43,7 @@
     ]
     x1 = df.drop(features1, axis=1)
 
-    x2 = df.drop(features, axis=1)  # type: ignore[arg-type]
+    x2 = df.drop(features, axis=1)
     x2 = pd.get_dummies(x2)
 
     df = pd.concat([x1, x2], axis=1)

ethicml/data/csvs/make_toy_dataset.py

@@ -1,6 +1,6 @@
 """Script to generate the toy dataset."""
-import random
 from pathlib import Path
+import random
 
 import numpy as np
 import pandas as pd

ethicml/data/csvs/utility.py

@@ -1,4 +1,5 @@
 """Functions used in either generating data, or pre-processing raw data."""
+from __future__ import annotations
 
 import numpy as np