Add README.md

1 files changed, 48 insertions, 52 deletions

diff --git a/report2/README.md b/report2/README.md
index 1313d40..0e43ccf 100644
--- a/report2/README.md
+++ b/report2/README.md
@@ -1,52 +1,48 @@
-# IEEE Paper Template for Pandoc
-
-[![Build Status](https://travis-ci.org/stsewd/ieee-pandoc-template.svg?branch=master)](https://travis-ci.org/stsewd/ieee-pandoc-template)
-
-## Requirements
-
-- [Pandoc](http://pandoc.org/)
-- [Texlive](https://www.tug.org/texlive/)
-
-### Ubuntu
-
-```sh
-sudo apt update
-sudo apt install pandoc pandoc-citeproc texlive-full
-```
-
-### Fedora
-
-```sh
-sudo dnf install pandoc pandoc-citeproc texlive-scheme-full
-```
-
-## Quickly Usage
-
-- Clone or download this repo.
-- Put all your paper content in `paper.md`.
-- Change the title and author in `metadata.yaml`.
-- Run `make` in a terminal.
-- The pdf will be on `build/paper.pdf`.
-
-## Files
-
-| File               | Description                                                                                                                       |
-|--------------------|-----------------------------------------------------------------------------------------------------------------------------------|
-| `metadata.yml`     | On this file put all your metadata (author, title, abstract, etc) that will be use for rendering the final pdf.                   |
-| `paper.md`         | Here you put all your paper content, if you wish, you could put your content on separate files, but you must edit the `makefile`. |
-| `bibliography.bib` | Here put all the bibliography that is used in the paper.                                                                          |
-| `bibliography.csl` | This file is for specify to pandoc how to display the cites (ieee format).                                                        |
-| `template.latex`   | It is used to tell pandoc how to render the paper using the metadata and content of your paper.                                   |
-| `makefile`         | It is used to compile the pdf, usually the default options are fine.                                                              |
-| `build/`           | On this directory will be final pdf. Make sure to add this to your `.gitignore` file if you are using git.                        |
-
-## Recommended Tools
-
-### Editors
-
-- [Vim](http://vim.org)/[Neovim](https://neovim.io/) + [vim-pandoc extension](https://github.com/vim-pandoc/vim-pandoc)
-- [Atom](http://atom.io) + [language-pfm extension](https://atom.io/packages/language-pfm) + [autocomplete-bibtex extension](https://atom.io/packages/autocomplete-bibtex)
-
-### Bibliography manager
-
-- [Zotero](https://www.zotero.org/) + [Better Bibtext extension](https://github.com/retorquere/zotero-better-bibtex)
+```

+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]

+

+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'

+```