Skip to content

Commit 0e25ddd

Browse files
committed
docs: update ae docs
1 parent c39b382 commit 0e25ddd

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

docs/ARTIFACT_EVALUATION.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,30 @@
55
- **CPU**: All available cores (preferable >128 cores)
66
- **Disk**: 100GB+ free space
77

8+
**Warning**: The scripts for results merging and figures plotting may not execute properly if a baseline failed to generate the log and exit correctly, i.e., the resource requested exceeds the RAM. Please make sure the machine where the artifact is evaluated satisfied above requirements. Thanks.
9+
810
**Quick Start:**
11+
912
```bash
1013
# Build the Docker image
1114
./docker-run.sh pull
1215

13-
# Run experiments (specify where to store generated data and the synthetic benchmark size)
16+
# Run customized experiments (specify where to store generated data and the synthetic benchmark size)
1417
./docker-run.sh run --data-path /mnt/large-disk/data --node-size 1000000
1518

16-
# Or run full evaluation
19+
# Or run the full evaluation in paper
1720
./docker-run.sh full --data-path /mnt/large-disk/data
1821
```
1922

2023
**Parameters:**
24+
2125
- `--data-path PATH` - Host directory for generated datasets (required)
2226
- `--download-real-world-data` - Download real-world data on host (default: true)
2327
- `--no-download-real-world-data` - Skip downloading real-world data
2428
- `--node-size SIZE` - Number of data points (default: 1'000'000'000, aka. 1 billion)
2529
- `--memory SIZE` - Memory limit (e.g., 512g), generally you don't want to explicitly set this value
2630
- `--cpus NUM` - CPU limit (default: all cores), generally you don't want set it as well.
2731

28-
**Results:** Found in `script_ae/data/`, `script_ae/logs/`, `script_ae/plots/` directories on host.
32+
**Results:** Found in `script_ae/data/`, `script_ae/logs/`, `script_ae/plots/` directories on the host.
2933

30-
**Documentation:** See [docker reference](DOCKER_QUICK_REFERENCE.md) for complete guides to use docker.
34+
**Documentation:** See [docker reference](https://github.com/ucrparlay/SpaceTreeLib/blob/main/docs/DOCKER_QUICK_REFERENCE.md) for complete guides to use docker. More introduction about the project can be found in the [Github page](https://github.com/ucrparlay/SpaceTreeLib).

0 commit comments

Comments
 (0)