Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate FilterGrid, Python 3.6 and 3.7 #371

Merged
merged 19 commits into from
Apr 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
16ba230
update dependencies for 'safety' checks
SarthakJariwala Nov 5, 2021
243b9f3
add FilterGrid deprecation, rename to ParamGrid
SarthakJariwala Nov 5, 2021
8b30f9f
change FilterGrid to ParamGrid in examples
SarthakJariwala Nov 5, 2021
c968b43
add ParamGrid to docs as FilterGrid replacement
SarthakJariwala Nov 5, 2021
4b6174b
add ParamGrid to api docs
SarthakJariwala Nov 5, 2021
e7aa2ba
remove quickstart - was not using it
SarthakJariwala Nov 5, 2021
404ab13
create a separate tutorial for ParamGrid
SarthakJariwala Nov 5, 2021
b3fdb18
replace missed FilterGrid -> ParamGrid
SarthakJariwala Nov 5, 2021
5c7a6c4
pulling new changes from main
SarthakJariwala Jan 20, 2022
780419b
Merge remote-tracking branch 'origin' into v0.5.x
SarthakJariwala Apr 19, 2022
4468e0b
update dependencies for 'safety' checks; min python version reqd is 3.8
SarthakJariwala Apr 19, 2022
f19ec7d
remove 3.6, 3.7 from test matrix, add 3.9. 3.10
SarthakJariwala Apr 19, 2022
03d6239
remove 3.6, 3.7 from test matrix, add 3.9. 3.10
SarthakJariwala Apr 19, 2022
e3f80fd
udpate constraints - pip and poetry
SarthakJariwala Apr 19, 2022
a057201
fix scipy installation with python deps specifications
SarthakJariwala Apr 19, 2022
e74c818
update python version to 3.10
SarthakJariwala Apr 19, 2022
77f318d
update python version to 3.8 - 3.10 is not supported
SarthakJariwala Apr 19, 2022
d9e881d
fix missing img that was dynamically generated using filtergrid
SarthakJariwala Apr 19, 2022
34b1dac
fix minor docstring issue; import median filter from scipy
SarthakJariwala Apr 19, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/constraints.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pip==21.3.1
pip==22.0.4
nox==2022.1.7
poetry==1.1.12
poetry==1.1.13
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/[email protected]
with:
python-version: '3.8'
python-version: '3.10'
architecture: x64
- run: pip install --constraint=.github/workflows/constraints.txt pip
- run: pip install --constraint=.github/workflows/constraints.txt nox
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ jobs:
fail-fast: false
matrix:
include:
- { python-version: 3.8, os: ubuntu-latest }
- { python-version: 3.7, os: ubuntu-latest }
- { python-version: 3.6, os: ubuntu-latest }
- { python-version: 3.8, os: windows-latest }
- { python-version: 3.8, os: macos-latest }
- { python-version: "3.10", os: ubuntu-latest }
- { python-version: "3.9", os: ubuntu-latest }
- { python-version: "3.8", os: ubuntu-latest }
- { python-version: "3.10", os: windows-latest }
- { python-version: "3.10", os: macos-latest }

steps:
- uses: actions/[email protected]
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sphinx:
configuration: docs/conf.py
formats: all
python:
version: 3.7
version: 3.8
install:
- requirements: docs/requirements.txt
- path: .
152 changes: 9 additions & 143 deletions docs/Tutorial/Image Filters.ipynb

Large diffs are not rendered by default.

185 changes: 185 additions & 0 deletions docs/Tutorial/ParamGrid.ipynb

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions docs/api/ParamGrid.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
seaborn_image.ParamGrid
========================

.. autoclass:: seaborn_image.ParamGrid
:members:
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ seaborn-image: image data visualization
:width: 120px
:height: 120px

.. |img4| image:: /auto_examples/images/thumb/sphx_glr_plot_filtergrid_thumb.png
.. |img4| image:: /auto_examples/images/thumb/sphx_glr_plot_paramgrid_thumb.png
:width: 140px
:height: 140px

Expand Down
114 changes: 0 additions & 114 deletions docs/quickstart.rst

This file was deleted.

14 changes: 12 additions & 2 deletions docs/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,11 @@ Axes level function to apply image filters and visualize them.
Axes level function to visualize the fast-fourier transform of the input image.


:doc:`FilterGrid <api/FilterGrid>`
:doc:`ParamGrid <api/ParamGrid>`
----------------------------------

Figure level function to explore interplay between different parameters of the input filter.
Figure level function that maps a function to input image and
allows exploration of the interplay between different parameters of the mapped function.


:doc:`load_image <api/datasets>`
Expand All @@ -65,3 +66,12 @@ Set global settings for drawing images.
--------------------------------------

Handy utility functions for despining axes, setting scientific ticks, etc.


Deprecated
++++++++++

:doc:`FilterGrid <api/FilterGrid>`
----------------------------------

`FilterGrid` is deprecated. Use :doc:`ParamGrid <api/ParamGrid>` instead.
9 changes: 9 additions & 0 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,15 @@ Working with a Collection of Images
Collection of images <Tutorial/Image Collection.ipynb>


Exploring Relationships between Parameters
------------------------------------------

.. toctree::
:maxdepth: 2

Explore Parameter Interplays <Tutorial/ParamGrid.ipynb>


Image Filters - Individual Filters and Exploring Relationships between Parameters
---------------------------------------------------------------------------------

Expand Down
6 changes: 3 additions & 3 deletions examples/plot_filtergrid.py → examples/plot_paramgrid.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
"""
Interplay between filter parameters using FilterGrid
====================================================
Interplay between function parameters using ParamGrid
=====================================================
"""

import seaborn_image as isns

img = isns.load_image("polymer")

g = isns.FilterGrid(
g = isns.ParamGrid(
img,
"gaussian",
row="sigma",
Expand Down
Loading