[RFC] API planning
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 5
- Forks
- 7
- Avg merge
- 1h 51m
- Merged PRs (30d)
- 12
Description
Broad Scope
This package will serve as the source for line search algorithms in SciML packages for nonlinear and optimization solvers. Multiple dispatch should be ensured so that downstream packages can use this package almost as a blackbox.
File/Code Organisation
- An implementation of the Wolfe and Goldstein conditions - each as a struct. Associated dispatches for each for checking.
- Each linesearch method will be defined as a struct with all the method specific hyperparameters and the common ones are arguments to the associated method dispatches
- A kernel (function) for the method to be called in a loop, basically the update equation for the method.
- Termination checking, no errors should be thrown but a nothing/NaN return when failure happens.
- Extensions for supported AD packages.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points, so start by reviewing the proposed API organization and the package's current structure. Done means an agreed design covering Wolfe and Goldstein conditions, line-search method structs and dispatches, the loop kernel, termination behavior, and AD extensions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100