added doc for pfw to docs (#459)

ZIB-IOL · Apr 9, 2024 · 337bd61 · 337bd61
1 parent 587c221
commit 337bd61
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/src/basics.md b/docs/src/basics.md
@@ -76,6 +76,11 @@ It is implemented in the [`blended_conditional_gradient`](@ref) function, with a
 
 See [Braun, Pokutta, Tu, Wright (2018)](https://arxiv.org/abs/1805.07311).
 
+### Pairwise Frank-Wolfe (PFW)
+
+It is implemented in the [`pairwise_frank_wolfe`](@ref) function.
+See [Lacoste-Julien, Jaggi (2015)](https://arxiv.org/abs/1511.05932) for an overview.
+
 ### Blended Pairwise Conditional Gradients (BPCG)
 
 It is implemented in the [`FrankWolfe.blended_pairwise_conditional_gradient`](@ref) function, with a minor [modification](https://hackmd.io/@spokutta/B14MTMsLF) to improve sparsity.

diff --git a/docs/src/reference/1_algorithms.md b/docs/src/reference/1_algorithms.md
@@ -30,6 +30,13 @@ Modules = [FrankWolfe]
 Pages = ["afw.jl"]
 ```
 
+### Pairwise Frank-Wolfe
+
+```@autodocs
+Modules = [FrankWolfe]
+Pages = ["pairwise.jl"]
+```
+
 ### Blended Conditional Gradient
 
 ```@autodocs
@@ -44,6 +51,7 @@ Modules = [FrankWolfe]
 Pages = ["blended_pairwise.jl"]
 ```
 
+
 ## Alternating Methods
 
 Problems over intersections of convex sets, i.e.