From 0998cecac7f15e3c68058d33acc21fb427f803e9 Mon Sep 17 00:00:00 2001 From: tlacombe Date: Fri, 28 Feb 2020 11:18:59 +0100 Subject: shorten < 80 char the doc --- src/python/doc/barycenter_user.rst | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) (limited to 'src/python/doc') diff --git a/src/python/doc/barycenter_user.rst b/src/python/doc/barycenter_user.rst index 59f758fa..83e9bebb 100644 --- a/src/python/doc/barycenter_user.rst +++ b/src/python/doc/barycenter_user.rst @@ -20,13 +20,17 @@ Function Basic example ------------- -This example computes the Frechet mean (aka Wasserstein barycenter) between four persistence diagrams. +This example computes the Frechet mean (aka Wasserstein barycenter) between +four persistence diagrams. It is initialized on the 4th diagram. -As the algorithm is not convex, its output depends on the initialization and is only a local minimum of the objective function. -Initialization can be either given as an integer (in which case the i-th diagram of the list is used as initial estimate) -or as a diagram. -If None, it will randomly select one of the diagram of the list as initial estimate. -Note that persistence diagrams must be submitted as (n x 2) numpy arrays and must not contain inf values. +As the algorithm is not convex, its output depends on the initialization and +is only a local minimum of the objective function. +Initialization can be either given as an integer (in which case the i-th +diagram of the list is used as initial estimate) or as a diagram. +If None, it will randomly select one of the diagram of the list +as initial estimate. +Note that persistence diagrams must be submitted as +(n x 2) numpy arrays and must not contain inf values. .. testcode:: @@ -37,8 +41,8 @@ Note that persistence diagrams must be submitted as (n x 2) numpy arrays and mus dg2 = np.array([[0.2, 0.7]]) dg3 = np.array([[0.3, 0.6], [0.7, 0.8], [0.2, 0.3]]) dg4 = np.array([]) - - bary = gudhi.barycenter.lagrangian_barycenter(pdiagset=[dg1, dg2, dg3, dg4],init=3) + pdiagset = [dg1, dg2, dg3, dg4] + bary = gudhi.barycenter.lagrangian_barycenter(pdiagset=pdiagset,init=3) message = "Wasserstein barycenter estimated:" print(message) -- cgit v1.2.3