Skip to content

Commit e113f12

Browse files
committed
Improve cfpq_eval/README
1 parent 93814d3 commit e113f12

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

cfpq_eval/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CFPQ Evaluation
22

3-
The `cfpq_eval` module in CFPQ_PyAlgo evaluates performance of CFPQ solvers,
3+
The `cfpq_eval` module evaluates performance of various CFPQ solvers,
44
integrating with both CFPQ_PyAlgo itself and third-party tools.
55

66
## Setting up the environment
@@ -21,8 +21,8 @@ docker run -it cfpq_eval bash
2121

2222
For detailed information on evaluation script options, execute the following command:
2323

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
2626
python3 -m cfpq_eval.eval_all_pairs_cflr --help
2727
```
2828

@@ -32,14 +32,17 @@ The basic command usage is as follows:
3232
python3 -m cfpq_eval.eval_all_pairs_cflr algo_config.csv data_config.csv results_path [--rounds ROUNDS] [--timeout TIMEOUT]
3333
```
3434

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`).
3737
- `results_path` specifies path for saving raw results.
3838
- `--rounds` sets run times per config (default is 1).
3939
- `--timeout` limits each configuration's execution time in seconds (optional).
4040

4141
## Configuration Files
4242

43+
### Premade Configurations
44+
45+
The CFPQ_eval Docker image includes premade configurations located in the `/py_algo/configs` folder.
4346
### Algorithm Configuration
4447

4548
The `algo_config.csv` outlines algorithms and settings. Supported algorithms:
@@ -51,7 +54,7 @@ The `algo_config.csv` outlines algorithms and settings. Supported algorithms:
5154
- `graspan`
5255
- `gigascale`
5356

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)
5558
can be used to alter the behaviour.
5659

5760
#### Example
@@ -82,5 +85,5 @@ memory usage, and output size are rendered in standard output stream.
8285

8386
## Custom Tools Integration
8487

85-
Additional CFPQ solvers can be supported to evaluation by implementing `AllPairsCflrToolRunner` interface
88+
Custom CFPQ solvers can be evaluated by implementing `AllPairsCflrToolRunner` interface
8689
and updating `run_appropriate_all_pairs_cflr_tool()` function.

0 commit comments

Comments
 (0)