Skip to content

Add logistic decay #18

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.

Sign up for GitHub

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

Open
florence-bockting wants to merge 7 commits into
base: add_polynomial_decay
Choose a base branch
from
Open

Add logistic decay #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e4bac71
initial implementation of logistic-decay
florence-bockting Apr 3, 2025
95d0b70
adjust logistic-decay function
florence-bockting Apr 3, 2025
6fc3916
add example for logistic-decay into getting-started tutorial
florence-bockting Apr 3, 2025
a0a1931
add changelog
florence-bockting Apr 3, 2025
2b8837e
update logistic decay formula
florence-bockting Apr 3, 2025
95ec353
fix ruff and mypy
florence-bockting Apr 3, 2025
e6c05ae
update changelop
florence-bockting Apr 3, 2025
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
12 changes: 12 additions & 0 deletions changelog/18.feature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
+ include support for logistic-decay
+ we added three new classes/functions to the API in the module `convergence`
+ `LogisticDecaySplineHelper`
+ `LogisticDecaySplineHelperDerivative`
+ `get_logistic_decay_harmonised_spline`
+ whereby the function `get_logistic_decay_harmonised_spline` is mainly meant as user-interface
This function can be used as value for the `get_harmonise_spline` parameter in `harmonise`.
The function takes the same arguments as `get_cosine_decay_harmonised_spline` and additionally a
`slope` and `shift` argument.
+ These arguments determine slope and location of the logistic function and can be passed using
`functools.partial(get_logistic_decay_harmonised_spline, slope = 0., shift = 0.)`
+ An example use-case is added to the `getting-started-tutorial`.
Comment on lines +1 to +12
Copy link
Contributor

@znichollscr znichollscr Apr 7, 2025

Choose a reason for hiding this comment

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

Suggested change
+ include support for logistic-decay
+ we added three new classes/functions to the API in the module `convergence`
+ `LogisticDecaySplineHelper`
+ `LogisticDecaySplineHelperDerivative`
+ `get_logistic_decay_harmonised_spline`
+ whereby the function `get_logistic_decay_harmonised_spline` is mainly meant as user-interface
This function can be used as value for the `get_harmonise_spline` parameter in `harmonise`.
The function takes the same arguments as `get_cosine_decay_harmonised_spline` and additionally a
`slope` and `shift` argument.
+ These arguments determine slope and location of the logistic function and can be passed using
`functools.partial(get_logistic_decay_harmonised_spline, slope = 0., shift = 0.)`
+ An example use-case is added to the `getting-started-tutorial`.
+ Include supported for logistic-decay
+ Added new features to [convergence][gradient_aware_harmonisation.convergence]
+ [LogisticDecaySplineHelper][gradient_aware_harmonisation.convergence.LogisticDecaySplineHelper]
+ [LogisticDecaySplineHelperDerivative][gradient_aware_harmonisation.convergence.LogisticDecaySplineHelperDerivative]
+ [get_logistic_decay_harmonised_spline][gradient_aware_harmonisation.convergence.get_logistic_decay_harmonised_spline]
+ The function [get_logistic_decay_harmonised_spline][gradient_aware_harmonisation.convergence.get_logistic_decay_harmonised_spline] is an adapter between the underlying classes and the interface required for the `get_harmonise_spline` parameter in [harmonise][gradient_aware_harmonisation.harmonise].
The function takes the same arguments as [get_cosine_decay_harmonised_spline][gradient_aware_harmonisation.convergence.get_cosine_decay_harmonised_spline] and additional
`slope` and `shift` arguments. These arguments determine the slope and location of the logistic function and can be can be 'pre-passed' to the function using [functools.partial](https://docs.python.org/3/library/functools.html#functools.partial) e.g. `harmonise(..., get_harmonise_spline=functools.partial(get_logistic_decay_harmonised_spline, slope = 0., shift = 0.)...)`
+ An example use-case is included in the [getting started tutorial][gradient-aware-harmonisation-getting-started].

Same reasoning as #16 (comment)

25 changes: 25 additions & 0 deletions docs/tutorials/tutorial.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@

from gradient_aware_harmonisation import harmonise
from gradient_aware_harmonisation.convergence import (
get_logistic_decay_harmonised_spline,
get_polynomial_decay_harmonised_spline,
)
from gradient_aware_harmonisation.plotting import plotting
Expand Down Expand Up @@ -115,6 +116,30 @@
get_harmonised_spline=partial(get_polynomial_decay_harmonised_spline, power=2.0),
)

plotting(
harmonisee_timeseries,
target_timeseries,
harmonised_timeseries,
harmonisation_time,
convergence_time,
)

# %% [markdown]
# ### Use logistic-decay

# %%
convergence_time = 8.0

harmonised_timeseries = harmonise(
target_timeseries=target_timeseries,
harmonisee_timeseries=harmonisee_timeseries,
harmonisation_time=harmonisation_time,
convergence_time=convergence_time,
get_harmonised_spline=partial(
get_logistic_decay_harmonised_spline, slope=-1.0, shift=-8.0
),
)

plotting(
harmonisee_timeseries,
target_timeseries,
Expand Down
Loading