Skip to content

Conversation

@pavelkomarov
Copy link
Collaborator

added deprecation messages to tons of functions throughtout the repo those which are really special cases/hyperparameter choices of a more general method; added a new ubermethod in the smooth_finite_difference module to simplify some plots and consolidate some thinking; updated the notebooks to agree with this brave new world; futzed with init.py files to also agree; and the optimization code; and reordered some things in the readme and tests because I now think iterated FD is logically second in the stack

… those which are really special cases/hyperparameter choices of a more general method; added a new ubermethod in the smooth_finite_difference module to simplify some plots and consolidate some thinking; updated the notebooks to agree with this brave new world; futzed with __init__.py files to also agree; and the optimization code; and reordered some things in the readme and tests because I now think iterated FD is logically second in the stack
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now manually documenting things in here so they show up in the order I want.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of sections belonged to now-deprecated methods. They can get absorbed into one.

Copy link
Collaborator Author

@pavelkomarov pavelkomarov Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added deprecation messages to the docs, as well as warnings for runtime.

'window_size': (15, 1000)})
} # Methods with nonunique parameter sets are aliased in the dictionary below
for method in [second_order, fourth_order]:
for method in [second_order, fourth_order]: # Deprecated, redundant methods
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I realized basically all these methods I'm aliasing down here are redundant. An argument to truly consider them deprecated and remove them eventually.

"""
from ._smooth_finite_difference import mediandiff, meandiff, gaussiandiff, friedrichsdiff, butterdiff, splinediff

__all__ = ['mediandiff', 'meandiff', 'gaussiandiff', 'friedrichsdiff', 'butterdiff'] # So automodule from the .rst finds them
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

__all__ can go away because I'm now listing things in the corresponding .rst.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reordered. Trying to keep to the same canonical order as the readme and Taxonomy paper. Presently updating the taxonomy paper between runs to reflect. It's good, much tighter in the corresponding section.

@pavelkomarov pavelkomarov merged commit 842f223 into master Oct 17, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants