Upgrade CI (#349)

## Description  Miscellaneous upgrades to pyribs CI ## TODO  - [x] Upgrade actions/checkout to v3 - [x] Add semantic-version to pinned reqs - [x] Don't ignore test images - [x] Update visualize CI - [x] Rearrange visualize tests - [x] Ignore Python 3.10 testing on Mac - [x] Upgrade tutorial python to 3.10 - [x] Note python 3.10 ## Questions  ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [N/A] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
icaros-usc · Sep 2, 2023 · dbcf604 · dbcf604
1 parent e039862
commit dbcf604
Show file tree

Hide file tree

Showing 48 changed files with 19 additions and 14 deletions.
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -25,10 +25,11 @@ jobs:
             python-version: "3.8"
           - os: macos-latest
             python-version: "3.9"
+          - os: macos-latest
+            python-version: "3.10"
     runs-on: ${{ matrix.os }}
-
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
@@ -43,7 +44,7 @@ jobs:
   pin:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.7
         uses: actions/setup-python@v2
         with:
@@ -58,11 +59,11 @@ jobs:
       - name: Install extras deps
         run: pip install -r pinned_reqs/extras_visualize.txt
       - name: Test extras
-        run: pytest tests/visualize_test.py
+        run: pytest tests/visualize
   coverage:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.7
         uses: actions/setup-python@v2
         with:
@@ -78,7 +79,7 @@ jobs:
   benchmarks:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.7
         uses: actions/setup-python@v2
         with:
@@ -92,7 +93,7 @@ jobs:
   examples:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.7
         uses: actions/setup-python@v2
         with:
@@ -106,11 +107,12 @@ jobs:
   tutorials:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.7
+      # We use Python 3.10 instead of 3.8 here since Google Colab uses 3.10.
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
         uses: actions/setup-python@v2
         with:
-          python-version: "3.7"
+          python-version: "3.10"
       - name: Upgrade pip
         run: python -m pip install --upgrade pip
       - name: Install deps
@@ -120,7 +122,7 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.8
         uses: actions/setup-python@v2
         with:
@@ -136,7 +138,7 @@ jobs:
     needs: [test, pin, coverage, benchmarks, examples, tutorials]
     if: startsWith(github.ref, 'refs/tags')
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.7
         uses: actions/setup-python@v2
         with:

diff --git a/.gitignore b/.gitignore
@@ -118,13 +118,15 @@ ENV/
 *.pth
 MNIST/
 dask-worker-space/
-!tests/baseline_images/visualize_test/*
 !docs/_static/**/*
 !tutorials/_static/**/*
 !tutorials/mnist/*
 !readme_assets/*
 results/
 
+# Allow matplotlib baseline images.
+!tests/**/*.png
+
 # Editor, IDE, and OS settings
 .vscode/
 .*.swp

diff --git a/pinned_reqs/install.txt b/pinned_reqs/install.txt
@@ -5,3 +5,4 @@ sortedcontainers==2.0.0
 scikit-learn==0.20.0
 scipy==1.4.0
 threadpoolctl==3.0.0
+semantic-version==2.10
diff --git a/tests/visualize/__init__.py b/tests/visualize/__init__.py
diff --git a/...es/visualize_test/cvt_archive_heatmap.png → ...es/visualize_test/cvt_archive_heatmap.png b/...es/visualize_test/cvt_archive_heatmap.png → ...es/visualize_test/cvt_archive_heatmap.png
diff --git a/...sualize_test/cvt_archive_heatmap_long.png → ...sualize_test/cvt_archive_heatmap_long.png b/...sualize_test/cvt_archive_heatmap_long.png → ...sualize_test/cvt_archive_heatmap_long.png
diff --git a/..._test/cvt_archive_heatmap_long_square.png → ..._test/cvt_archive_heatmap_long_square.png b/..._test/cvt_archive_heatmap_long_square.png → ..._test/cvt_archive_heatmap_long_square.png
diff --git a/...st/cvt_archive_heatmap_long_transpose.png → ...st/cvt_archive_heatmap_long_transpose.png b/...st/cvt_archive_heatmap_long_transpose.png → ...st/cvt_archive_heatmap_long_transpose.png
diff --git a/...st/cvt_archive_heatmap_with_centroids.png → ...st/cvt_archive_heatmap_with_centroids.png b/...st/cvt_archive_heatmap_with_centroids.png → ...st/cvt_archive_heatmap_with_centroids.png
diff --git a/...vt_archive_heatmap_with_coolwarm_cmap.png → ...vt_archive_heatmap_with_coolwarm_cmap.png b/...vt_archive_heatmap_with_coolwarm_cmap.png → ...vt_archive_heatmap_with_coolwarm_cmap.png
diff --git a/..._test/cvt_archive_heatmap_with_limits.png → ..._test/cvt_archive_heatmap_with_limits.png b/..._test/cvt_archive_heatmap_with_limits.png → ..._test/cvt_archive_heatmap_with_limits.png
diff --git a/.../cvt_archive_heatmap_with_listed_cmap.png → .../cvt_archive_heatmap_with_listed_cmap.png b/.../cvt_archive_heatmap_with_listed_cmap.png → .../cvt_archive_heatmap_with_listed_cmap.png
diff --git a/...test/cvt_archive_heatmap_with_samples.png → ...test/cvt_archive_heatmap_with_samples.png b/...test/cvt_archive_heatmap_with_samples.png → ...test/cvt_archive_heatmap_with_samples.png
diff --git a/...s/visualize_test/grid_archive_heatmap.png → ...s/visualize_test/grid_archive_heatmap.png b/...s/visualize_test/grid_archive_heatmap.png → ...s/visualize_test/grid_archive_heatmap.png
diff --git a/...isualize_test/grid_archive_heatmap_1d.png → ...isualize_test/grid_archive_heatmap_1d.png b/...isualize_test/grid_archive_heatmap_1d.png → ...isualize_test/grid_archive_heatmap_1d.png
diff --git a/...t/grid_archive_heatmap_1d_aspect_gt_1.png → ...t/grid_archive_heatmap_1d_aspect_gt_1.png b/...t/grid_archive_heatmap_1d_aspect_gt_1.png → ...t/grid_archive_heatmap_1d_aspect_gt_1.png
diff --git a/...t/grid_archive_heatmap_1d_aspect_lt_1.png → ...t/grid_archive_heatmap_1d_aspect_lt_1.png b/...t/grid_archive_heatmap_1d_aspect_lt_1.png → ...t/grid_archive_heatmap_1d_aspect_lt_1.png
diff --git a/...test/grid_archive_heatmap_aspect_gt_1.png → ...test/grid_archive_heatmap_aspect_gt_1.png b/...test/grid_archive_heatmap_aspect_gt_1.png → ...test/grid_archive_heatmap_aspect_gt_1.png
diff --git a/...test/grid_archive_heatmap_aspect_lt_1.png → ...test/grid_archive_heatmap_aspect_lt_1.png b/...test/grid_archive_heatmap_aspect_lt_1.png → ...test/grid_archive_heatmap_aspect_lt_1.png
diff --git a/...grid_archive_heatmap_custom_cbar_axis.png → ...grid_archive_heatmap_custom_cbar_axis.png b/...grid_archive_heatmap_custom_cbar_axis.png → ...grid_archive_heatmap_custom_cbar_axis.png
diff --git a/...est/grid_archive_heatmap_equal_aspect.png → ...est/grid_archive_heatmap_equal_aspect.png b/...est/grid_archive_heatmap_equal_aspect.png → ...est/grid_archive_heatmap_equal_aspect.png
diff --git a/...ualize_test/grid_archive_heatmap_long.png → ...ualize_test/grid_archive_heatmap_long.png b/...ualize_test/grid_archive_heatmap_long.png → ...ualize_test/grid_archive_heatmap_long.png
diff --git a/...test/grid_archive_heatmap_long_square.png → ...test/grid_archive_heatmap_long_square.png b/...test/grid_archive_heatmap_long_square.png → ...test/grid_archive_heatmap_long_square.png
diff --git a/...t/grid_archive_heatmap_long_transpose.png → ...t/grid_archive_heatmap_long_transpose.png b/...t/grid_archive_heatmap_long_transpose.png → ...t/grid_archive_heatmap_long_transpose.png
diff --git a/...ize_test/grid_archive_heatmap_no_cbar.png → ...ize_test/grid_archive_heatmap_no_cbar.png b/...ize_test/grid_archive_heatmap_no_cbar.png → ...ize_test/grid_archive_heatmap_no_cbar.png
diff --git a/.../grid_archive_heatmap_with_boundaries.png → .../grid_archive_heatmap_with_boundaries.png b/.../grid_archive_heatmap_with_boundaries.png → .../grid_archive_heatmap_with_boundaries.png
diff --git a/...id_archive_heatmap_with_coolwarm_cmap.png → ...id_archive_heatmap_with_coolwarm_cmap.png b/...id_archive_heatmap_with_coolwarm_cmap.png → ...id_archive_heatmap_with_coolwarm_cmap.png
diff --git a/...test/grid_archive_heatmap_with_limits.png → ...test/grid_archive_heatmap_with_limits.png b/...test/grid_archive_heatmap_with_limits.png → ...test/grid_archive_heatmap_with_limits.png
diff --git a/...grid_archive_heatmap_with_listed_cmap.png → ...grid_archive_heatmap_with_listed_cmap.png b/...grid_archive_heatmap_with_listed_cmap.png → ...grid_archive_heatmap_with_listed_cmap.png
diff --git a/...mages/visualize_test/parallel_axes_2d.png → ...mages/visualize_test/parallel_axes_2d.png b/...mages/visualize_test/parallel_axes_2d.png → ...mages/visualize_test/parallel_axes_2d.png
diff --git a/...mages/visualize_test/parallel_axes_3d.png → ...mages/visualize_test/parallel_axes_3d.png b/...mages/visualize_test/parallel_axes_3d.png → ...mages/visualize_test/parallel_axes_3d.png
diff --git a/...ualize_test/parallel_axes_3d_coolwarm.png → ...ualize_test/parallel_axes_3d_coolwarm.png b/...ualize_test/parallel_axes_3d_coolwarm.png → ...ualize_test/parallel_axes_3d_coolwarm.png
diff --git a/...ze_test/parallel_axes_3d_custom_names.png → ...ze_test/parallel_axes_3d_custom_names.png b/...ze_test/parallel_axes_3d_custom_names.png → ...ze_test/parallel_axes_3d_custom_names.png
diff --git a/...allel_axes_3d_custom_objective_limits.png → ...allel_axes_3d_custom_objective_limits.png b/...allel_axes_3d_custom_objective_limits.png → ...allel_axes_3d_custom_objective_limits.png
diff --git a/...ze_test/parallel_axes_3d_custom_order.png → ...ze_test/parallel_axes_3d_custom_order.png b/...ze_test/parallel_axes_3d_custom_order.png → ...ze_test/parallel_axes_3d_custom_order.png
diff --git a/...isualize_test/parallel_axes_3d_sorted.png → ...isualize_test/parallel_axes_3d_sorted.png b/...isualize_test/parallel_axes_3d_sorted.png → ...isualize_test/parallel_axes_3d_sorted.png
diff --git a/...e_test/parallel_axes_3d_vertical_cbar.png → ...e_test/parallel_axes_3d_vertical_cbar.png b/...e_test/parallel_axes_3d_vertical_cbar.png → ...e_test/parallel_axes_3d_vertical_cbar.png
diff --git a/...e_test/parallel_axes_3d_width2_alpha2.png → ...e_test/parallel_axes_3d_width2_alpha2.png b/...e_test/parallel_axes_3d_width2_alpha2.png → ...e_test/parallel_axes_3d_width2_alpha2.png
diff --git a/...alize_test/sliding_boundaries_heatmap.png → ...alize_test/sliding_boundaries_heatmap.png b/...alize_test/sliding_boundaries_heatmap.png → ...alize_test/sliding_boundaries_heatmap.png
diff --git a/..._test/sliding_boundaries_heatmap_long.png → ..._test/sliding_boundaries_heatmap_long.png b/..._test/sliding_boundaries_heatmap_long.png → ..._test/sliding_boundaries_heatmap_long.png
diff --git a/...liding_boundaries_heatmap_long_square.png → ...liding_boundaries_heatmap_long_square.png b/...liding_boundaries_heatmap_long_square.png → ...liding_boundaries_heatmap_long_square.png
diff --git a/...ing_boundaries_heatmap_long_transpose.png → ...ing_boundaries_heatmap_long_transpose.png b/...ing_boundaries_heatmap_long_transpose.png → ...ing_boundaries_heatmap_long_transpose.png
diff --git a/...s_heatmap_mismatch_xy_with_boundaries.png → ...s_heatmap_mismatch_xy_with_boundaries.png b/...s_heatmap_mismatch_xy_with_boundaries.png → ...s_heatmap_mismatch_xy_with_boundaries.png
diff --git a/...ng_boundaries_heatmap_with_boundaries.png → ...ng_boundaries_heatmap_with_boundaries.png b/...ng_boundaries_heatmap_with_boundaries.png → ...ng_boundaries_heatmap_with_boundaries.png
diff --git a/...boundaries_heatmap_with_coolwarm_cmap.png → ...boundaries_heatmap_with_coolwarm_cmap.png b/...boundaries_heatmap_with_coolwarm_cmap.png → ...boundaries_heatmap_with_coolwarm_cmap.png
diff --git a/...liding_boundaries_heatmap_with_limits.png → ...liding_boundaries_heatmap_with_limits.png b/...liding_boundaries_heatmap_with_limits.png → ...liding_boundaries_heatmap_with_limits.png
diff --git a/...g_boundaries_heatmap_with_listed_cmap.png → ...g_boundaries_heatmap_with_listed_cmap.png b/...g_boundaries_heatmap_with_listed_cmap.png → ...g_boundaries_heatmap_with_listed_cmap.png
diff --git a/tests/visualize_test.py → tests/visualize/visualize_test.py b/tests/visualize_test.py → tests/visualize/visualize_test.py
@@ -4,7 +4,7 @@
 https://matplotlib.org/3.3.1/devel/testing.html#writing-an-image-comparison-test.
 Essentially, after running a new test for the first time in the _root_ directory
 of this repo, copy the image output from result_images/visualize_test to
-tests/extras/baseline_images/visualize_test. For instance, for
+tests/visualize/baseline_images/visualize_test. For instance, for
 ``test_cvt_archive_heatmap_with_samples``, run::
 
     cp result_images/visualize_test/cvt_archive_heatmap_with_samples.png \