Rewrite

1 files changed, 37 insertions, 50 deletions

diff --git a/README.md b/README.md
index 92f592d..fbbd86d 100644
--- a/README.md
+++ b/README.md
@@ -1,50 +1,37 @@
-```

-usage: evaluate.py [-h] [-t] [-c] [-k] [-m] [-e] [-r] [-p RERANKA]

-                   [-q RERANKB] [-l RERANKL] [-n NEIGHBORS] [-v] [-s SHOWRANK]

-                   [-1] [-M MULTRANK] [-C COMPARISON] [--data DATA] [-K KMEAN]

-                   [-P] [-2 PCA]

-

-optional arguments:

-  -h, --help            show this help message and exit

-  -t, --train           Use train data instead of query and gallery

-  -c, --conf_mat        Show visual confusion matrix

-  -k, --kmean_alt       Perform clustering with generalized labels(not actual

-                        kmean)

-  -m, --mahalanobis     Perform Mahalanobis Distance metric

-  -e, --euclidean       Use standard euclidean distance

-  -r, --rerank          Use k-reciprocal rernaking

-  -p RERANKA, --reranka RERANKA

-                        Parameter k1 for rerank -p '$k1val' -ARGUMENT

-                        REQUIRED, default=9-

-  -q RERANKB, --rerankb RERANKB

-                        Parameter k2 for rerank -q '$k2val' -ARGUMENT

-                        REQUIRED, default=3-

-  -l RERANKL, --rerankl RERANKL

-                        Coefficient to combine distances(lambda) -l

-                        '$lambdaval' -ARGUMENT REQUIRED, default=0.3-

-  -n NEIGHBORS, --neighbors NEIGHBORS

-                        Use customized ranklist size -n 'size' -ARGUMENT

-                        REQUIRED, default=1-

-  -v, --verbose         Use verbose output

-  -s SHOWRANK, --showrank SHOWRANK

-                        Save ranklist pics id in a txt file. Number of

-                        ranklists saved specified as -s '$number' -ARGUMENT

-                        REQUIRED, default=0-

-  -1, --normalise       Normalise features

-  -M MULTRANK, --multrank MULTRANK

-                        Run for different ranklist sizes equal to M -ARGUMENT

-                        REQUIRED, default=1-

-  -C COMPARISON, --comparison COMPARISON

-                        Set to 2 to obtain a comparison of baseline and

-                        improved metric -ARGUMENT REQUIRED, default=1-

-  --data DATA           You can either put the data in a folder called 'data',

-                        or specify the location with --data 'path' -ARGUMENT

-                        REQUIRED, default='data'-

-  -K KMEAN, --kmean KMEAN

-                        Perform Kmean clustering of size specified through -K

-                        '$size' -ARGUMENT REQUIRED, default=0-

-  -P, --mAP             Display Mean Average Precision for ranklist of size -n

-                        '$size'

-  -2 PCA, --PCA PCA     Use PCA with -2 '$n_components' -ARGUMENT REQUIRED,

-                        default=0-

-```

+```
+usage: evaluate.py [-h] [-t] [-c] [-k] [-m] [-e] [-r] [-a RERANKA]
+                   [-b RERANKB] [-l RERANKL] [-n NEIGHBORS] [-v] [-s SHOWRANK]
+                   [-1] [-M MULTRANK] [-C] [--data DATA] [-K KMEAN] [-A]
+                   [-P PCA]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -t, --train           Use train data instead of query and gallery
+  -c, --conf_mat        Show visual confusion matrix
+  -k, --kmean_alt       Perform clustering with generalized labels(not actual
+                        kmean)
+  -m, --mahalanobis     Perform Mahalanobis Distance metric
+  -e, --euclidean       Use standard euclidean distance
+  -r, --rerank          Use k-reciprocal rernaking
+  -a RERANKA, --reranka RERANKA
+                        Parameter k1 for rerank
+  -b RERANKB, --rerankb RERANKB
+                        Parameter k2 for rerank
+  -l RERANKL, --rerankl RERANKL
+                        Parameter lambda fo rerank
+  -n NEIGHBORS, --neighbors NEIGHBORS
+                        Use customized ranklist size NEIGHBORS
+  -v, --verbose         Use verbose output
+  -s SHOWRANK, --showrank SHOWRANK
+                        Save ranklist pics id in a txt file for first SHOWRANK
+                        queries
+  -1, --normalise       Normalise features
+  -M MULTRANK, --multrank MULTRANK
+                        Run for different ranklist sizes equal to MULTRANK
+  -C, --comparison      Compare baseline and improved metric
+  --data DATA           Folder containing data
+  -K KMEAN, --kmean KMEAN
+                        Perform Kmean clustering, KMEAN number of clusters
+  -A, --mAP             Display Mean Average Precision
+  -P PCA, --PCA PCA     Perform pca with PCA eigenvectors
+  ```