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

Naming and documentation of optimisation solvers #761

Open
pietercollins opened this issue Oct 5, 2023 · 0 comments
Open

Naming and documentation of optimisation solvers #761

pietercollins opened this issue Oct 5, 2023 · 0 comments
Assignees
Labels
docs Documentation solvers Solvers module

Comments

@pietercollins
Copy link
Contributor

pietercollins commented Oct 5, 2023

Improve the naming, documentation and internal consistency of optimisation solvers. In particular, rename Solver to Optimiser, remove Nonlinear tag and add Linear tag where appropriate. Correct copy/paste errors in class documentation. Add details on methods used, add extra documentation on utility methods, and make general theory more closely related to problem formulation used.

@pietercollins pietercollins added docs Documentation solvers Solvers module labels Oct 5, 2023
@pietercollins pietercollins self-assigned this Oct 5, 2023
@pietercollins pietercollins changed the title Naming and documentation of optimization solvers Naming and documentation of optimisation solvers Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation solvers Solvers module
Development

No branches or pull requests

1 participant