# Log and Results Analysis ## Log Analysis ### Introduction of log analysis tool `tools/analysis_tools/analyze_logs.py` plots curves of given keys according to the log files.
```shell python tools/analysis_tools/analyze_logs.py plot_curve \ ${JSON_LOGS} \ [--keys ${KEYS}] \ [--title ${TITLE}] \ [--legend ${LEGEND}] \ [--backend ${BACKEND}] \ [--style ${STYLE}] \ [--out ${OUT_FILE}] \ [--window-size ${WINDOW_SIZE}] ``` **Description of all arguments**： - `json_logs` : The paths of the log files, separate multiple files by spaces. - `--keys` : The fields of the logs to analyze, separate multiple keys by spaces. Defaults to 'loss'. - `--title` : The title of the figure. Defaults to use the filename. - `--legend` : The names of legend, the number of which must be equal to `len(${JSON_LOGS}) * len(${KEYS})`. Defaults to use `"${JSON_LOG}-${KEYS}"`. - `--backend` : The backend of matplotlib. Defaults to auto selected by matplotlib. - `--style` : The style of the figure. Default to `whitegrid`. - `--out` : The path of the output picture. If not set, the figure won't be saved. - `--window-size`: The shape of the display window. The format should be `'W*H'`. Defaults to `'12*7'`. ```{note} The `--style` option depends on `seaborn` package, please install it before setting it. ``` ### How to plot the loss/accuracy curve We present some examples here to show how to plot the loss curve of accuracy curve by using the `tools/analysis_tools/analyze_logs.py` #### Plot the loss curve in training. ```shell python tools/analysis_tools/analyze_logs.py plot_curve your_log_json --keys loss --legend loss ``` #### Plot the top-1 accuracy and top-5 accuracy curves, and save the figure to results.jpg. ```shell python tools/analysis_tools/analyze_logs.py plot_curve your_log_json --keys accuracy_top-1 accuracy_top-5 --legend top1 top5 --out results.jpg ``` #### Compare the top-1 accuracy of two log files in the same figure. ```shell python tools/analysis_tools/analyze_logs.py plot_curve log1.json log2.json --keys accuracy_top-1 --legend exp1 exp2 ``` ```{note} The tool will automatically select to find keys in training logs or validation logs according to the keys. Therefore, if you add a custom evaluation metric, please also add the key to `TEST_METRICS` in this tool. ``` ### How to calculate training time `tools/analysis_tools/analyze_logs.py` can also calculate the training time according to the log files. ```shell python tools/analysis_tools/analyze_logs.py cal_train_time \ ${JSON_LOGS} [--include-outliers] ``` **Description of all arguments**: - `json_logs` : The paths of the log files, separate multiple files by spaces. - `--include-outliers` : If set, include the first iteration in each epoch (Sometimes the time of first iterations is longer). Example: ```shell python tools/analysis_tools/analyze_logs.py cal_train_time work_dirs/some_exp/20200422_153324.log.json ``` The output is expected to be like the below. ```text -----Analyze train time of work_dirs/some_exp/20200422_153324.log.json----- slowest epoch 68, average time is 0.3818 fastest epoch 1, average time is 0.3694 time std over epochs is 0.0020 average iter time: 0.3777 s/iter ``` ## Result Analysis With the `--out` argument in `tools/test.py`, we can save the inference results of all samples as a file. And with this result file, we can do further analysis. ### How to conduct offline metric evaluation We provide `tools/analysis_tools/eval_metric.py` to enable the user evaluate the model from the prediction files. ```shell python tools/analysis_tools/eval_metric.py \ ${CONFIG} \ ${RESULT} \ [--metrics ${METRICS}] \ [--cfg-options ${CFG_OPTIONS}] \ [--metric-options ${METRIC_OPTIONS}] ``` Description of all arguments: - `config` : The path of the model config file. - `result`: The Output result file in json/pickle format from `tools/test.py`. - `--metrics` : Evaluation metrics, the acceptable values depend on the dataset. - `--cfg-options`: If specified, the key-value pair config will be merged into the config file, for more details please refer to [Learn about Configs](../user_guides/config.md) - `--metric-options`: If specified, the key-value pair arguments will be passed to the `metric_options` argument of dataset's `evaluate` function. ```{note} In `tools/test.py`, we support using `--out-items` option to select which kind of results will be saved. Please ensure the result file includes "class_scores" to use this tool. ``` **Examples**: ```shell python tools/analysis_tools/eval_metric.py configs/t2t_vit/t2t-vit-t-14_8xb64_in1k.py your_result.pkl --metrics accuracy --metric-options "topk=(1,5)" ``` ### How to visualize the prediction results We can also use this tool `tools/analysis_tools/analyze_results.py` to save the images with the highest scores in successful or failed prediction. ```shell python tools/analysis_tools/analyze_results.py \ ${CONFIG} \ ${RESULT} \ [--out-dir ${OUT_DIR}] \ [--topk ${TOPK}] \ [--cfg-options ${CFG_OPTIONS}] ``` **Description of all arguments**: - `config` : The path of the model config file. - `result`: Output result file in json/pickle format from `tools/test.py`. - `--out_dir`: Directory to store output files. - `--topk`: The number of images in successful or failed prediction with the highest `topk` scores to save. If not specified, it will be set to 20. - `--cfg-options`: If specified, the key-value pair config will be merged into the config file, for more details please refer to [Learn about Configs](../user_guides/config.md) ```{note} In `tools/test.py`, we support using `--out-items` option to select which kind of results will be saved. Please ensure the result file includes "pred_score", "pred_label" and "pred_class" to use this tool. ``` **Examples**: ```shell python tools/analysis_tools/analyze_results.py \ configs/resnet/resnet50_b32x8_imagenet.py \ result.pkl \ --out_dir results \ --topk 50 ```