1
1
# CFPQ Evaluation
2
2
3
- The ` cfpq_eval ` module in CFPQ_PyAlgo evaluates performance of CFPQ solvers,
3
+ The ` cfpq_eval ` module evaluates performance of various CFPQ solvers,
4
4
integrating with both CFPQ_PyAlgo itself and third-party tools.
5
5
6
6
## Setting up the environment
@@ -21,8 +21,8 @@ docker run -it cfpq_eval bash
21
21
22
22
For detailed information on evaluation script options, execute the following command:
23
23
24
- ``` bash
25
- cd .. # Should be run from CFPQ_PyAlgo project root directory
24
+ ```
25
+ # Should be run from CFPQ_PyAlgo project root directory in cfpq_eval Docker container
26
26
python3 -m cfpq_eval.eval_all_pairs_cflr --help
27
27
```
28
28
@@ -32,14 +32,17 @@ The basic command usage is as follows:
32
32
python3 -m cfpq_eval.eval_all_pairs_cflr algo_config.csv data_config.csv results_path [--rounds ROUNDS] [--timeout TIMEOUT]
33
33
```
34
34
35
- - ` algo_config.csv ` specifies algorithm configurations.
36
- - ` data_config.csv ` specifies the dataset.
35
+ - ` algo_config.csv ` specifies algorithm configurations (e.g. ` configs/algo/fast_matrix_cfpq.csv ` ) .
36
+ - ` data_config.csv ` specifies the dataset (e.g. ` configs/data/small_examples.csv ` ) .
37
37
- ` results_path ` specifies path for saving raw results.
38
38
- ` --rounds ` sets run times per config (default is 1).
39
39
- ` --timeout ` limits each configuration's execution time in seconds (optional).
40
40
41
41
## Configuration Files
42
42
43
+ ### Premade Configurations
44
+
45
+ The CFPQ_eval Docker image includes premade configurations located in the ` /py_algo/configs ` folder.
43
46
### Algorithm Configuration
44
47
45
48
The ` algo_config.csv ` outlines algorithms and settings. Supported algorithms:
@@ -51,7 +54,7 @@ The `algo_config.csv` outlines algorithms and settings. Supported algorithms:
51
54
- ` graspan `
52
55
- ` gigascale `
53
56
54
- For Matrix-based algorithms options described in [ cfpq_cli/README] ( ../cfpq_cli/README.md ) .
57
+ For Matrix-based algorithms options described in [ cfpq_cli/README] ( ../cfpq_cli/README.md )
55
58
can be used to alter the behaviour.
56
59
57
60
#### Example
@@ -82,5 +85,5 @@ memory usage, and output size are rendered in standard output stream.
82
85
83
86
## Custom Tools Integration
84
87
85
- Additional CFPQ solvers can be supported to evaluation by implementing ` AllPairsCflrToolRunner ` interface
88
+ Custom CFPQ solvers can be evaluated by implementing ` AllPairsCflrToolRunner ` interface
86
89
and updating ` run_appropriate_all_pairs_cflr_tool() ` function.
0 commit comments