summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEdoardo Pasca <edo.paskino@gmail.com>2019-03-04 13:26:46 +0000
committerGitHub <noreply@github.com>2019-03-04 13:26:46 +0000
commit8b218f9fd8ef283c5d1dde0e7268301de64f47d4 (patch)
treeb8f6a1146d76f46aaeb765dc017ec7ebaea5c330
parentf3b4bae3e07d5b6808318d680429722cf7d92f48 (diff)
downloadframework-8b218f9fd8ef283c5d1dde0e7268301de64f47d4.tar.gz
framework-8b218f9fd8ef283c5d1dde0e7268301de64f47d4.tar.bz2
framework-8b218f9fd8ef283c5d1dde0e7268301de64f47d4.tar.xz
framework-8b218f9fd8ef283c5d1dde0e7268301de64f47d4.zip
use bullet point
-rw-r--r--README.md6
1 files 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