From 8b218f9fd8ef283c5d1dde0e7268301de64f47d4 Mon Sep 17 00:00:00 2001 From: Edoardo Pasca Date: Mon, 4 Mar 2019 13:26:46 +0000 Subject: use bullet point --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a29eaf3..c3ba5ea 100644 --- a/README.md +++ b/README.md @@ -95,9 +95,9 @@ In `ccpi.framework` we define a number of common classes normally used in tomogr New algorithms can be easily created by extending the `Algorithm` class. The user is required to implement only 4 methods: `set_up`, `__init__`, `update` and `update_objective`. - #. `set_up` and `__init__` are used to configure the algorithm - #. `update` is the actual iteration updating the solution - #. `update_objective` defines how the objective is calculated. + * `set_up` and `__init__` are used to configure the algorithm + * `update` is the actual iteration updating the solution + * `update_objective` defines how the objective is calculated. For example, the implementation of the `update` of the Gradient Descent algorithm to minimise a `Function` will only be: ```python -- cgit v1.2.3