Skip to content

Commit 4ef7a43

Browse files
author
RomaLzhih
committed
docs: update docs
1 parent f53a3de commit 4ef7a43

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

docs/ARTIFACT_EVALUATION.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

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

docs/DOCKER_QUICK_REFERENCE.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ docker run -it --rm \
5656
| Option | Description | Default |
5757
|--------|-------------|---------|
5858
| `--data-path PATH` | Host directory for datasets (required) | - |
59+
| `--download-real-world-data` | Download real-world data on host | `true` |
60+
| `--no-download-real-world-data` | Skip downloading real-world data | - |
5961
| `--node-size SIZE` | Number of data points | 1000000000 |
6062
| `--memory SIZE` | Memory limit (e.g., 512g) | No limit |
6163
| `--cpus NUM` | CPU cores limit | All cores |
@@ -103,15 +105,14 @@ docker-compose down
103105
## Cleanup
104106

105107
```bash
106-
# Remove container and image
108+
# Remove container, image, and generated files in script_ae/
107109
./docker-run.sh clean
108110

111+
# Remove container, image, generated files AND real-world data in --data-path
112+
./docker-run.sh clean --data-path /your/data/path
113+
109114
# Or manually remove the image
110115
docker rmi ghcr.io/ucrparlay/spacetreelib:latest
111-
112-
# Remove generated data
113-
rm -rf /your/data/path/*
114-
rm -rf script_ae/data/ script_ae/logs/ script_ae/plots/
115116
```
116117

117118
## Hardware Requirements

0 commit comments

Comments
 (0)