From 43e1866988005e5ce23ae8c54f81ca8d34b80134 Mon Sep 17 00:00:00 2001 From: Anton Reinhard Date: Wed, 22 Nov 2023 02:06:40 +0100 Subject: [PATCH] Add docs for optmization --- docs/src/lib/internals/estimator.md | 2 +- docs/src/lib/internals/optimization.md | 41 ++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 docs/src/lib/internals/optimization.md diff --git a/docs/src/lib/internals/estimator.md b/docs/src/lib/internals/estimator.md index 5484a07..3cea858 100644 --- a/docs/src/lib/internals/estimator.md +++ b/docs/src/lib/internals/estimator.md @@ -1,4 +1,4 @@ -# Models +# Estimation ## Interface diff --git a/docs/src/lib/internals/optimization.md b/docs/src/lib/internals/optimization.md new file mode 100644 index 0000000..8f563e8 --- /dev/null +++ b/docs/src/lib/internals/optimization.md @@ -0,0 +1,41 @@ +# Optimization + +## Interface + +The interface that has to be implemented for an optimization algorithm. + +```@autodocs +Modules = [MetagraphOptimization] +Pages = ["optimization/interafce.jl"] +Order = [:type, :constant, :function] +``` + +## Random Walk Optimizer + +Implementation of a random walk algorithm. + +```@autodocs +Modules = [MetagraphOptimization] +Pages = ["estimator/random_walk.jl"] +Order = [:type, :function] +``` + +## Reduction Optimizer + +Implementation of a an optimizer that reduces as far as possible. + +```@autodocs +Modules = [MetagraphOptimization] +Pages = ["estimator/reduce.jl"] +Order = [:type, :function] +``` + +## Greedy Optimizer + +Implementation of a greedy optimization algorithm. + +```@autodocs +Modules = [MetagraphOptimization] +Pages = ["estimator/greedy.jl"] +Order = [:type, :function] +```