diff --git a/README.md b/README.md index d83d6d56834f2118b7911a8de6ffed71d7c90c0b..a37dd8f155f7769f9cf7c848420af9e2250716f8 100644 --- a/README.md +++ b/README.md @@ -42,27 +42,43 @@ This repository is organised as follows: ## Running the pipeline 1. Download the database from the following link: https://www.idiap.ch/en/dataset/phymatt -2. Create a list of the videos to be used for the experiment. The list should contain the path for each video you want in the experiment. If you want all videos, you can use the following command: -`find <path_to_database> -name "*.mp4" > <path_to_list>` +2. Create a list of the videos to be used for the experiment. The list should contain the path for each video you want in the experiment. If you want all videos, you can use the following command: + ``` bash + `find <path_to_database> -name "*.mp4" > <path_to_list>` + ``` 3. Run the frames extraction code as follows: -`python preprocessor/extract_frames.py -l <path_to_list> -o <path_to_output_folder>` + ``` bash + python preprocessor/extract_frames.py -l <path_to_list> -o <path_to_output_folder>` + ``` 4. Run the database organization code as follows: -`python database/create_database_dataframe.py --frames_list --output_path -metadata_filename -save_mode --min_face_size` + ``` bash + python database/create_database_dataframe.py --frames_list --output_path -metadata_filename -save_mode --min_face_size` + ``` 5. Run the pipeline as follows: -`python pipeline_vuln.py --database_path --output_path --metadata_filename --save_mode --min_face_size --attack_type --attack_params --attac` + ``` bash + python pipeline_vuln.py --database_path --output_path --metadata_filename --save_mode --min_face_size --attack_type --attack_params --attac + ``` 6. Once you have the score files, namely the `score-dev.csv`, you can use the script `utils/split_scores.sh` to split the scores into bona-fide and attack scores. The script will create three files: `scores-dev_print-attack.csv`, `scores-dev_replay-attack.csv` and `scores-dev_hyg-maks.csv`. -7. You can then use these files to compute the metrics as follows: +7. Activate your `bob` environment: + + ```bash + conda activate bob + ``` + +8. You can then use these files to compute the metrics as follows: -`bob vuln metrics scores-dev_print-attack.csv scores-dev_replay-attack.csv scores-dev_hyg-maks.csv` + ```bash + bob vuln metrics scores-dev_print-attack.csv scores-dev_replay-attack.csv scores-dev_hyg-maks.csv + ``` ## Contact For questions or reporting issues to this software package, contact our development [mailing list](https://www.idiap.ch/software/bob/discuss).