Skip to content

Add paths.buffer config key to redirect buffer snapshot storage #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oleg-savchenko wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add paths.buffer config key to redirect buffer snapshot storage #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,17 @@ Configure file paths:
```yaml
paths:
import: "."
graph: ${run_dir}/graph
graph: ${run_dir}/graph
samples: ${run_dir}/samples
buffer: ${run_dir}/buffer # optional; redirect to a separate volume (e.g. scratch)
```

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| `import` | str | `"."` | Path to import custom modules |
| `graph` | str | `${run_dir}/graph` | Trained models directory |
| `graph` | str | `${run_dir}/graph` | Trained model checkpoints directory |
| `samples` | str | `${run_dir}/samples` | Output samples directory |
| `buffer` | str | `${run_dir}/buffer` | Buffer snapshots directory (`snapshots/` is appended); useful for routing large temporary simulation data to a separate scratch volume while keeping `run_dir` on persistent storage |

### `buffer`

Expand All @@ -65,7 +67,7 @@ buffer:
| `simulate_count` | int | `64` | Number of new samples generated per simulation round. For simulators taking >1s per sample, keep this small (4–16) to avoid long delays between buffer updates; for fast simulators, increase to reduce Ray overhead. |
| `simulate_interval` | float | `1` | Seconds between simulation rounds |
| `simulate_when_full` | bool | `true` | If `true`, simulation continues after `max_samples` is reached and old samples are replaced; if `false`, simulation stops once the buffer is full |
| `store_fraction` | float | `0.0` | Fraction of simulated samples written to `buffer/snapshots/` for inspection (0 = none, 1 = all) |
| `store_fraction` | float | `0.0` | Fraction of simulated samples written to `{paths.buffer}/snapshots/` for inspection (0 = none, 1 = all) |

### `graph`

Expand Down
5 changes: 3 additions & 2 deletions falcon/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -668,9 +668,10 @@ def stop_check():
from omegaconf import OmegaConf as _OmegaConf
from falcon.core.raystore import BufferConfig as _BufferConfig
buffer_cfg = _OmegaConf.merge(_OmegaConf.structured(_BufferConfig), cfg.buffer)
buffer_base = cfg.paths.get("buffer", str(Path(cfg.run_dir) / "buffer"))
dataset_manager = falcon.get_ray_dataset_manager(
buffer_cfg,
snapshots_path=str(Path(cfg.run_dir) / "buffer" / "snapshots"),
snapshots_path=str(Path(buffer_base) / "snapshots"),
log_config=logging_cfg,
)

Expand Down Expand Up @@ -899,7 +900,7 @@ def parse_args():
elif arg.startswith("--refresh="):
refresh = float(arg.split("=", 1)[1])
i += 1
return mode, None, None, None, None, False, 16, address, refresh
return mode, None, None, None, None, False, 16, True, None, address, refresh

sample_type = None
if mode == "sample":
Expand Down