Merge pull request #144 from scikit-learn-contrib/fix_typing

Fix typing

Author: vtaquet

.github/ISSUE_TEMPLATE/bug_report.md

@@ -26,7 +26,7 @@ If applicable, add screenshots to help explain your problem.
 **Desktop (please complete the following information):**
  - OS: [e.g. iOS]
  - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+ - MAPIE Version [e.g. 0.3.2]
 
 **Additional context**
 Add any other context about the problem here.

.github/workflows/publish.yml

@@ -8,19 +8,19 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.9'
-    - name: Install build dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build package
-      run: python setup.py sdist bdist_wheel
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN_VBL }}
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Build package
+        run: python setup.py sdist bdist_wheel
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN_VBL }}

.github/workflows/test.yml

@@ -9,43 +9,40 @@ jobs:
       matrix:
         include:
           - os: ubuntu-latest
-            python-version: 3.7
-            numpy-version: 1.18.5
+            python-version: "3.7"
+            numpy-version: 1.21.4
           - os: ubuntu-latest
-            python-version: 3.8
-            numpy-version: 1.19.5
+            python-version: "3.8"
+            numpy-version: 1.21.4
           - os: ubuntu-latest
-            python-version: 3.9
-            numpy-version: 1.20.3
-          - os: windows-latest
-            python-version: 3.7
-            numpy-version: 1.18.5
-          - os: windows-latest
-            python-version: 3.8
-            numpy-version: 1.19.5
+            python-version: "3.9"
+            numpy-version: 1.21.4
+          - os: ubuntu-latest
+            python-version: "3.10"
+            numpy-version: 1.22.3
           - os: windows-latest
-            python-version: 3.9
-            numpy-version: 1.20.3
+            python-version: "3.10"
+            numpy-version: 1.22.3
     defaults:
       run:
         shell: bash -l {0}
 
     steps:
-    - name: Git clone
-      uses: actions/checkout@v2
-    - name: Set up virtual environment
-      uses: conda-incubator/setup-miniconda@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-        environment-file: environment.ci.yml
-        channels: defaults, conda-forge
-    - name: Install numpy
-      run: conda install numpy=${{ matrix.numpy-version }}
-    - name: Check linting
-      run: make lint
-    - name: Check static typing
-      run: make type-check
-    - name: Test with pytest
-      run: make coverage
-    - name: Code coverage
-      run: codecov
+      - name: Git clone
+        uses: actions/checkout@v2
+      - name: Set up virtual environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          environment-file: environment.ci.yml
+          channels: defaults, conda-forge
+      - name: Install numpy
+        run: conda install numpy=${{ matrix.numpy-version }}
+      - name: Check linting
+        run: make lint
+      - name: Check static typing
+        run: make type-check
+      - name: Test with pytest
+        run: make coverage
+      - name: Code coverage
+        run: codecov

HISTORY.rst

@@ -2,6 +2,10 @@
 History
 =======
 
+0.3.3 (2022-XX-XX)
+------------------
+* Relax and fix typing
+
 0.3.2 (2022-03-11)
 ------------------
 * Refactorize unit tests

Makefile

@@ -1,9 +1,10 @@
 .PHONY: tests doc build
+
 lint:	
 	flake8 . --exclude=doc
 
 type-check:
-	mypy mapie examples --strict --allow-untyped-calls
+	mypy mapie examples
 
 tests:
 	pytest -vs --doctest-modules mapie

README.rst

@@ -54,7 +54,7 @@ Python 3.7+
 
 **MAPIE** stands on the shoulders of giants.
 
-Its only internal dependency is `scikit-learn <https://scikit-learn.org/stable/>`_.
+Its only internal dependencies are `scikit-learn <https://scikit-learn.org/stable/>`_ and `numpy=>1.21 <https://numpy.org/>`_.
 
 
 🛠 Installation

environment.ci.yml

@@ -8,6 +8,5 @@ dependencies:
     - mypy
     - pandas
     - pytest-cov
-    - python
     - scikit-learn
     - typed-ast

environment.dev.yml

@@ -5,12 +5,15 @@ channels:
 dependencies:
     - bump2version=1.0.1
     - flake8=4.0.1
-    - mypy=0.910
+    - ipykernel=6.9.0
+    - jupyter=1.0.0
+    - mypy=0.941
     - numpydoc=1.1.0
+    - numpy=1.22.3
     - pandas=1.3.5
     - pytest=6.2.5
     - pytest-cov=3.0.0
-    - python=3.10.1
+    - python=3.10
     - scikit-learn=1.0.1
     - sphinx=4.3.2
     - sphinx-gallery=0.10.1

environment.notebooks.yml

@@ -13,7 +13,7 @@ dependencies:
     - pip=22.0.3
     - pip:
         - scikeras==0.4.1
-    - python=3.10.1
+    - python=3.10
     - scikit-learn=1.0.1
     - tensorflow=2.7.0
     - xgboost=1.5.1

examples/classification/1-quickstart/plot_comp_methods_on_2d_dataset.py

@@ -57,7 +57,7 @@
     classification_coverage_score,
     classification_mean_width_score
 )
-from mapie._typing import ArrayLike
+from mapie._typing import NDArray
 
 
 centers = [(0, 3.5), (-2, 0), (2, 0)]
@@ -144,8 +144,8 @@
 
 def plot_scores(
     alphas: List[float],
-    scores: ArrayLike,
-    quantiles: ArrayLike,
+    scores: NDArray,
+    quantiles: NDArray,
     method: str,
     ax: plt.Axes,
 ) -> None:
@@ -183,7 +183,7 @@ def plot_scores(
 
 
 def plot_results(
-    alphas: List[float], y_pred_mapie: ArrayLike, y_ps_mapie: ArrayLike
+    alphas: List[float], y_pred_mapie: NDArray, y_ps_mapie: NDArray
 ) -> None:
     tab10 = plt.cm.get_cmap("Purples", 4)
     colors = {