aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornunzip <np.scarh@gmail.com>2018-12-13 21:02:38 +0000
committernunzip <np.scarh@gmail.com>2018-12-13 21:02:38 +0000
commitee670ce4ae832b7c63ade15ddd75294d11855807 (patch)
treeb2ae4acdb9c8fff694026bbf785684c9169216af
parentf9b5da526d0aa60f342d3bec26dcceb565db5f7d (diff)
downloadvz215_np1915-ee670ce4ae832b7c63ade15ddd75294d11855807.tar.gz
vz215_np1915-ee670ce4ae832b7c63ade15ddd75294d11855807.tar.bz2
vz215_np1915-ee670ce4ae832b7c63ade15ddd75294d11855807.zip
Formatting README
-rw-r--r--README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index 84d9fc9..eb525ee 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ optional arguments:
Save ranklist pics id in a txt file for first SHOWRANK
queries
-1, --normalise Normalise features
- -2, --standardise Standardise features
+ -2, --standardise Standardise features
-M MULTRANK, --multrank MULTRANK
Run for different ranklist sizes equal to MULTRANK
-C, --comparison Compare baseline and improved metric
@@ -39,13 +39,13 @@ optional arguments:
```
-**EXAMPLE 1** for `evaluate.py`:
+**EXAMPLES 1** for `evaluate.py`:
**EXAMPLE 1.1**: Run euclidean distance with top n
-`evaluate.py -e -n 10`
+`evaluate.py -e -n 10`
-or simply
+*or simply*
`evaluate.py -n 10`
@@ -87,15 +87,15 @@ or simply
**EXAMPLE 1.11**: Run euclidean distance specifying a different data folder location
-for data int the same folder as evaluate.py:
+*for data int the same folder as evaluate.py:*
`evaluate.py --data ./`
-or for data in another folder:
+*or for data in another folder:*
`evaluate.py --data ./foo/bar/`
-**EXAMPLE 2** for `opt.py`:
+**EXAMPLES 2** for `opt.py`:
**EXAMPLE 2.1**: optimize top 1 accuracy for k1, k2, lambda speeding up the process with PCA, top 50 eigenvectors