diff --git a/README.md b/README.md index bec6f93c0e8ea2c9b9cf6292752c22535aad9f3b..55085686b5aad058026850751e1679d93ec0ba9f 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,33 @@ This is the documentation of the code for the project - - -### Dependencies +### Install Third party As the script depends on the ArcFace library to compute the scores, this library needs to be installed first. The library installation can be found here: https://github.com/deepinsight/insightface It also depends on a third party DET script. + +### Computing the baseline. +One can use the code present in main.py to compute the baseline. In order to achive this, one needs to + +1. Change the projectpath the project paht as it is on your local machine + +`` projectpath = "my/project/path/ `` + +2. Uncomment the following lines: + +``` +QualEval = QualityEvaluator("Instance-Name", projectpath, imgsdir, "subjectnr/samplenr") +QualEval.ArcFace_init() +QualEval.readInDataset(params, projectpath, imgsdir, "ArcFaceCasia", True ) +QualEval.ComputeBaselines() +QualEval.SaveBaslines() + +``` + + +### Compute quality metrics + +### Plot quality metrics + +