Add clarity to jacobian/hessianstructure methods #247
Merged
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.
This is an edit to the tutorial documentation.
Original tutorial is not entirely clear on what the jacobian/hessian jacobian/hessianstructure methods should return when providing them as sparse matrices.
I'm not sure if this is the best way to add this information. The structure of the method returns is shown in the example below it, but, as a user, it took me some time to see how best to structure the returns (I also mistakenly tried to use a scipy sparse matrix structure as a return at one point).