-
Notifications
You must be signed in to change notification settings - Fork 6
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
Refactor package #36
Merged
Refactor package #36
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A preview of the docs can be found under |
6e7133f
to
473565e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I am currently refactoring the package.
The main difference is that model functions now have their own struct similar to
distributions, e.g.
Normal
, from the Distributions.jl package.Currently, there is one predefined model function,
NormalPeakUvD
, which is a Gaussian plus linear background model.But the user can of course also define his own models, see Doc.
Also, the fit syntax has changed. It is now like the
fit
function from StatsBase.jl and Distributions.jl:fit(<::Type{Dist}>, data)::<Dist>
where in our case the data areStatsBase.Histograms
:e.g.:
fit(NormalPeakUvD, hist)
which would return an instance ofNormalPeakUvD
with the fitted parameters.Two fit "backends" are implemented:
They can be chosen via a keyword:
backend = :optim
(default) orbackend = :BAT
.Both methods use the gradient of the model functions via AutoDiff.
User specific model functions need to be defined such that ForwardDiff.jl can differentiate them.
Currently, there is not yet a fallback to a non-gradient based optimizer / sampling algorithm.
But this can be easily added.
Also, NamedTuples can be used for the parameters of a model.
And the parameters can be individual set constant via ValueShapes.jl
such that they are fixed in the fits but the model does not have to be redefined.