Add docstrings to state and stats #657
Merged
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
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #657 +/- ##
======================================
Coverage 8.93% 8.93%
======================================
Files 31 31
Lines 2506 2506
======================================
Hits 224 224
Misses 2282 2282 ☔ View full report in Codecov by Sentry. |
src/stats_state.jl
Outdated
| - `objective`: current objective value | ||
| - `gradient`: current gradient | ||
| - `hessian`: current hessian | ||
| - `solver_state`: if the solver has its own state object then it is stored here |
There was a problem hiding this comment.
Suggested change
| - `solver_state`: if the solver has its own state object then it is stored here | |
| - `original`: if the solver has its own state object then it is stored here |
for uniformity.
src/stats_state.jl
Outdated
| and is passed to the callback function as the first argument. | ||
|
|
||
| ## Fields | ||
| - `iteration`: current iteration |
There was a problem hiding this comment.
Suggested change
| - `iteration`: current iteration | |
| - `iter`: current iteration |
Comment on lines
+40
to
+41
| - `gradient`: current gradient | ||
| - `hessian`: current hessian |
There was a problem hiding this comment.
Suggested change
| - `gradient`: current gradient | |
| - `hessian`: current hessian | |
| - `gradient`: current gradient | |
| - `hessian`: current hessian |
grad, hes
Make the naming match everything else, we can't just have one thing different.
| @@ -117,7 +117,7 @@ function SciMLBase.__solve(cache::Optimization.OptimizationCache{ | |||
| else | |||
| n_steps = BlackBoxOptim.num_steps(trace) | |||
| curr_u = decompose_trace(trace, cache.progress) | |||
| opt_state = Optimization.OptimizationState(iteration = n_steps, u = curr_u, objective = x[1], solver_state = trace) | |||
| opt_state = Optimization.OptimizationState(; iteration = n_steps, u = curr_u, objective = x[1], original = trace) | |||
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.
Checklist
contributor guidelines, in particular the SciML Style Guide and
COLPRAC.
Additional context
Add any other context about the problem here.