Skip to content

Commit 6bb0f48

Browse files
committed
Clarify READMEs
1 parent 90aae3c commit 6bb0f48

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ and work with them in terms of linear algebra.
1010
First of all you need to clone repository with its submodules:
1111

1212
```bash
13-
git clone --recurse-submodules https://github.com/JetBrains-Research/CFPQ_PyAlgo.git
13+
git clone --recurse-submodules -b murav/optimize-matrix https://github.com/JetBrains-Research/CFPQ_PyAlgo.git
1414
cd CFPQ_PyAlgo/
1515
git submodule init
1616
git submodule update
@@ -37,14 +37,15 @@ First of all you need to install [pygraphblas](https://github.com/michelp/pygrap
3737
```bash
3838
pip3 install pygraphblas==5.1.8.0
3939
```
40-
Secondly you need to install cfpq_data_devtools package and other requirements:
40+
Secondly you need to install `cfpq_data_devtools` package and other requirements:
4141

4242
```bash
4343
cd deps/CFPQ_Data
4444
pip3 install -r requirements.txt
4545
python3 setup.py install --user
4646

4747
cd ../../
48+
pip3 install pygraphblas==5.1.8.0 # optional (needed for legacy algorithms and their tests)
4849
pip3 install -r requirements.txt
4950
```
5051
To check if the installation was successful you can run simple tests

cfpq_eval/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,36 @@ integrating with both CFPQ_PyAlgo itself and third-party tools.
88
Build and run a Docker container for evaluation using [Dockerfile-all-tools](../Dockerfile-all-tools).
99

1010
Build Docker image:
11-
```
12-
docker build -f Dockerfile-all-tools -t cfpq_eval .
11+
```bash
12+
cd .. # Should be run from CFPQ_PyAlgo project root directory
13+
14+
# Load base image
15+
wget -O pearl.tar.gz https://figshare.com/ndownloader/files/42214812
16+
docker load --input pearl.tar.gz
17+
rm pearl.tar.gz
18+
19+
# Build eval image
20+
docker build -f Dockerfile-all-tools -t cfpq/py_algo_eval .
1321
```
1422

1523
Run Docker container:
16-
```
17-
docker run -it cfpq_eval bash
24+
```bash
25+
docker run -it cfpq/py_algo_eval bash
1826
```
1927

2028
## Running the Script
2129

2230
For detailed information on evaluation script options, execute the following command:
2331

24-
```
25-
# Should be run from CFPQ_PyAlgo project root directory in cfpq_eval Docker container
32+
```bash
33+
cd .. # Should be run from CFPQ_PyAlgo project root directory
2634
python3 -m cfpq_eval.eval_all_pairs_cflr --help
2735
```
2836

2937
The basic command usage is as follows:
3038

3139
```
40+
# Should be run in cfpq_eval Docker container
3241
python3 -m cfpq_eval.eval_all_pairs_cflr algo_config.csv data_config.csv results_path [--rounds ROUNDS] [--timeout TIMEOUT]
3342
```
3443

0 commit comments

Comments
 (0)