Skip to content

Commit e6b4b99

Browse files
committed
update README.
1 parent 450cd2c commit e6b4b99

1 file changed

Lines changed: 6 additions & 16 deletions

File tree

Readme.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# IterativeAlgorithmsInterface.jl
1+
# 🧮 AlgorithmsInterface.jl
22

3-
`IterativeAlgorithmsInterface.jl` is a Julia package to provide a common interface to run iterative tasks. **Algorithm** here refers to an iterative sequence of commands, that are run until a certain stopping criterion is met.
3+
`AlgorithmsInterface.jl` is a Julia package to provide a common interface to run iterative tasks. **Algorithm** here refers to an iterative sequence of commands, that are run until a certain stopping criterion is met.
44

55
# Statement of need
66

@@ -13,20 +13,10 @@ Finally, a common interface also allows to easily combine existing algorithms, h
1313

1414
# Main features
1515

16-
We consider solving _Tasks_, which consist of
16+
See the [intial discussion](https://github.com/JuliaManifolds/AlgorithmsInterface.jl/discussions/1)
17+
as well as the [overview on existing things](https://github.com/JuliaManifolds/AlgorithmsInterface.jl/discussions/2)
1718

18-
* An `AbstractProblem` to solve, which contains all information that is static to the problem and usually does not change during the iterations, this might for example be a cost function and its gradient in an optimisation problem.
19-
* An `AbstractAlgorithmState` that both specifies which algorithm to use to _solve_ the problem, but also stores all parameters that an algorithm needs as well as everything the algorithm needs to store between two iterations.
20-
21-
This generic data structures are accompanied by the methods
22-
23-
* `step!(problem::Problem, state::AlgorithmState, k)` to perform the `k`th iteration of the algorithm.
24-
* `solve!(problem::Problem, state::AlgorithmState)` to solve a problem with a given algorithm, which is identified by the `AlgorithmState`.
25-
* `stop(problem::Problem, state::AlgorithmState)` to check whether the algorithm should stop.
26-
27-
where the first is the main one to implement for a new algorithm.
28-
29-
# Further ideas
19+
## Further ideas
3020

3121
* generic stopping criteria `<:AbstractStoppingCriterion`
3222
* `StopAfterIteration(i)` for example
@@ -35,7 +25,7 @@ where the first is the main one to implement for a new algorithm.
3525
* by default `stop()` from above would check such a stopping criterion
3626
* generic debug and record functionality – together with hooks even
3727

38-
# possible extensions
28+
## Possible extensions
3929

4030
* to `LineSearches.jl`
4131
*

0 commit comments

Comments
 (0)