Skip to content
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

Add clarity to jacobian/hessianstructure methods #247

Merged
merged 1 commit into from
Apr 1, 2024
Merged

Add clarity to jacobian/hessianstructure methods #247

merged 1 commit into from
Apr 1, 2024

Conversation

lynntf
Copy link
Contributor

@lynntf lynntf commented Apr 1, 2024

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).

Original tutorial is not entirely clear on what the jacobian/hessian jacobian/hessianstructure methods should return when providing them as sparse matrices.
@moorepants
Copy link
Collaborator

Thanks, this is an improvement.

@moorepants moorepants merged commit bb3227a into mechmotum:master Apr 1, 2024
34 checks 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