Parametric library #273

znicolaou · 2022-12-10T07:36:29Z

I think I'm ready to merge the new ParameterizedLibrary class and example notebook with master!

Changes to the core code are pretty minor. They include

The new library class in feature_libraries/parameterized_library.py, which is really just a small wrapper around the GeneralizedLibrary for a specific use case. This case is when multiple trajectories are supplied that are governed by the same equations but with different parameter values. The parameter values are supplied as control input. It is important to construct the library features carefully in this case for PDE's, since we don't want to take spatial derivatives of the constant control parameters, so the library takes an input feature_library and an input parameter_library that act on the data and control input independently. The full library is essentially a TensoredLibrary of the two, but the GeneralizedLibrary enables different input features for the libraries.
I added an exclude_libraries option to GeneralizedLibrary, which enables more control. In our case, we want to include only the tensor products of the input, and not concatenate the individual libraries as well, since that would lead to repeated columns in the usual case where the parameter_library has a constant bias term.
I added a differentiation_method option to the PDELibrary and the WeakPDELibrary, to allow the user to change the differentiation method for the spatial derivatives. This addresses issue Add differentiation_method to PDELibrary and WeakPDELibrary #221
I made a small change to the default behavior for AxesArray, so that if no axes are provided, the axes are comprehended with comprehend_axes.

Most of the work here is in the example notebook examples/17_pattern_formation/17_pattern_formation.ipynb, which has several examples including discrete maps, ODEs, and PDEs. Many of the examples are spatio-temporal and require pretty significant memory and cpu resources, so if you want to run them, you may want to do so on a cluster.

I'm hoping to merge this in the next week or so before we post an accompanying preprint on arxiv. Let me know if you want to see any details from the manuscript!

…ysindy into parametric_library

codecov-commenter · 2022-12-10T07:46:13Z

Codecov Report

Base: 92.39% // Head: 92.47% // Increases project coverage by +0.08% 🎉

Coverage data is based on head (46a8965) compared to base (a299cd8).
Patch coverage: 94.26% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #273      +/-   ##
==========================================
+ Coverage   92.39%   92.47%   +0.08%     
==========================================
  Files          36       37       +1     
  Lines        3682     3736      +54     
==========================================
+ Hits         3402     3455      +53     
- Misses        280      281       +1

Impacted Files	Coverage Δ
pysindy/feature_library/sindy_pi_library.py	`74.81% <ø> (ø)`
pysindy/feature_library/weak_pde_library.py	`94.88% <83.33%> (-0.24%)`	⬇️
pysindy/feature_library/pde_library.py	`95.21% <87.50%> (+1.77%)`	⬆️
pysindy/pysindy.py	`94.19% <91.66%> (-0.22%)`	⬇️
pysindy/feature_library/generalized_library.py	`95.76% <94.28%> (-1.61%)`	⬇️
pysindy/feature_library/base.py	`94.50% <95.45%> (+0.75%)`	⬆️
pysindy/__init__.py	`83.05% <100.00%> (+0.29%)`	⬆️
pysindy/feature_library/__init__.py	`100.00% <100.00%> (ø)`
pysindy/feature_library/parameterized_library.py	`100.00% <100.00%> (ø)`
pysindy/differentiation/finite_difference.py	`98.07% <0.00%> (-0.97%)`	⬇️
... and 1 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

akaptano · 2022-12-12T16:30:33Z

Nice! I'll try to take a look this week. By the way, it would be nice to overhaul the GeneralizedLibrary notation anyways. The inputs_per_library and array to tell it which libraries to use for which variables is super confusing to use, and I get lots of questions on it. At the very least, it might be worth putting the indexing in the backend, and having the user interface be a lot easier to specify exactly what you want the libraries to do.

znicolaou · 2022-12-12T18:56:12Z

@akaptano totally agree the input_per_library is confusing and it would be easy to simplify it. I'll take a look while this is being reviewed and maybe sneak it in later.

Jacob-Stevens-Haas

Looks good! -just a consideration with the AxesArray choice, and a few list comprehensions.

docs/conf.py

pysindy/feature_library/base.py

test/feature_library/test_feature_library.py

requirements-dev.txt

pysindy/feature_library/base.py

pysindy/feature_library/generalized_library.py

pysindy/feature_library/parameterized_library.py

test/optimizers/test_optimizers.py

znicolaou · 2022-12-16T00:29:01Z

Ok! I think I resolved issues from @Jacob-Stevens-Haas -- thanks! Let me know if anything else looks off.

znicolaou · 2022-12-28T03:07:45Z

bump @akaptano -- let me know if you want to take a look at this one before I merge with master this week

akaptano · 2022-12-28T14:24:42Z

Going to take a look at this today for some documentation/other checks but not going to get into the technical details (need to spend time getting the other PR + paper ready still). If I have any suggestions I'll let you know by the end of the day!

…ut going to put rest of the comments in the PR request

akaptano · 2022-12-28T19:04:32Z

My main comment so far is that the example notebook could be substantially cleaned up in terms of:
(1) more text cells describing what is happening
(2) Some of the loading, data processing could be moved to a utils.py type file so that the notebook can be smaller + we want the example notebooks to be relatively easy to understand for users.
(3) It would be great if the notebooks could be reformatted according to pep8 + similar formatting to the current notebooks. For instance, the spacing for assignment and other operations everywhere should be ' = ' instead of '=' and so forth.

I started to do a little bit of this in a new commit but then realized this would be a big change so commenting here instead.

akaptano · 2022-12-28T19:10:23Z

Other random comments:

Would be good to name the example notebook something more descriptive
It would be good to add an example to the Example 1 notebook for a tiny demonstration of this new library. It might also be good to show a quick example in the Example 1 (or other notebook) using the "exclude_libraries" and "differentiation_method" changes you mentioned.

Anyways, this is awesome and my main comment is to clean up the notebook considerably. Let me know if you need a hand with anything, and sorry for my slowness on this!

znicolaou · 2022-12-28T19:53:38Z

Thanks for the feedback @akaptano! All very reasonable--I'll clean things up and organize some short examples for the other notebooks.

…. Added automatic reshaping and broadcasting to control parameter input and included short example in notebook 1 also.

akaptano · 2023-01-05T13:23:38Z

Hey Zack, the notebook is looking much better. I think you could probably move even more functions/plotting into the utils.py file, but this has a green light for me when you're happy to merge it in.

znicolaou · 2023-01-05T23:33:04Z

Thanks @akaptano ! I am pushing just one more clean up and am going to merge later tonight!

Parametric library

znicolaou added 30 commits June 1, 2022 14:16

added library files

d503dda

updated example notebook

0eb82e9

fixed weak tensor and concat

d936056

fixed linting

9cff224

fixed weak feature names

1b10070

updated example

9e4ce50

partial merge of simplify-fitting

f4d9520

finished merging

69cdf8a

fixed axes merge

a84304f

fixed concat and tensor calc_trajectory

227193d

updated notebook

2826b5e

tried some noise

5719ab6

added noise sweep

b21cc67

updated notebook

15a2064

merged simplify-fitting

143b0e9

fixed linting

e60a1e7

finished merge with simplify-fitting

cbde100

fixed merge problem

e268764

fixed linting

44a2f72

added pde and weakpde differentiation_method

7e23466

updated test

e8040a5

updated test

9b71b66

updated notebooks

08e37e4

updated notebook

99589d7

updated notebook

16646ab

updated notebook

ff7c0ef

updated notebook

288315d

I updated the notebook

5a16727

Merge branch 'parametric_library' of https://github.com/dynamicslab/p…

e6b862f

…ysindy into parametric_library

updated notebook

2eb0492

znicolaou added 3 commits December 9, 2022 12:53

oregonator animation

8e27101

saved score sweep

ded5139

added unit tests and cleaned up

ee66a71

znicolaou requested review from Jacob-Stevens-Haas and akaptano December 10, 2022 07:36

Jacob-Stevens-Haas requested changes Dec 13, 2022

View reviewed changes

added testing example.py

dde340c

Added a bit of documentation and formatting to the example notebook b…

5f3e5cf

…ut going to put rest of the comments in the PR request

znicolaou added 4 commits January 4, 2023 23:34

major clean up of example notebook 17, with details moved to utils.py…

74cc9fc

…. Added automatic reshaping and broadcasting to control parameter input and included short example in notebook 1 also.

major clean up of example notebook 17, with details moved to utils.py…

d2c94c3

…. Added automatic reshaping and broadcasting to control parameter input and included short example in notebook 1 also.

major clean up of example notebook 17, with details moved to utils.py…

75a9c47

…. Added automatic reshaping and broadcasting to control parameter input and included short example in notebook 1 also.

fixed notebook test error

b9a9319

Small fix to first example notebook.

0c4d9c3

znicolaou added 2 commits January 5, 2023 15:36

final clean up

ff24ce2

fixed merge conflict examples/1_feature_overview.ipynb

46a8965

znicolaou merged commit f6b970b into master Jan 6, 2023

znicolaou deleted the parametric_library branch January 6, 2023 05:00

Jacob-Stevens-Haas mentioned this pull request Apr 5, 2023

Gurobipy requirement prevents Python 3.11 support #303

Closed

jpcurbelo pushed a commit to jpcurbelo/pysindy_fork that referenced this pull request Apr 30, 2024

Merge pull request dynamicslab#273 from dynamicslab/parametric_library

c6acfcb

Parametric library

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Parametric library #273

Parametric library #273

znicolaou commented Dec 10, 2022

codecov-commenter commented Dec 10, 2022 •

edited

Loading

akaptano commented Dec 12, 2022

znicolaou commented Dec 12, 2022

Jacob-Stevens-Haas left a comment •

edited

Loading

znicolaou commented Dec 16, 2022

znicolaou commented Dec 28, 2022

akaptano commented Dec 28, 2022

akaptano commented Dec 28, 2022

akaptano commented Dec 28, 2022

znicolaou commented Dec 28, 2022

akaptano commented Jan 5, 2023

znicolaou commented Jan 5, 2023

Parametric library #273

Parametric library #273

Conversation

znicolaou commented Dec 10, 2022

codecov-commenter commented Dec 10, 2022 • edited Loading

Codecov Report

akaptano commented Dec 12, 2022

znicolaou commented Dec 12, 2022

Jacob-Stevens-Haas left a comment • edited Loading

Choose a reason for hiding this comment

znicolaou commented Dec 16, 2022

znicolaou commented Dec 28, 2022

akaptano commented Dec 28, 2022

akaptano commented Dec 28, 2022

akaptano commented Dec 28, 2022

znicolaou commented Dec 28, 2022

akaptano commented Jan 5, 2023

znicolaou commented Jan 5, 2023

codecov-commenter commented Dec 10, 2022 •

edited

Loading

Jacob-Stevens-Haas left a comment •

edited

Loading