You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: benchmarking/README.md
+6-10Lines changed: 6 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,11 +33,10 @@ Note: you may only need to do this periodically when the environment needs to be
33
33
34
34
**2. Update config:**
35
35
36
-
Update `results_path`, `artifacts_path`, and `datasets_path` in the YAML config file based on your preferences. In this example, we'll edit the YAML config `./benchmarking/nightly-benchmark.yaml`
36
+
Update `results_path` and `datasets_path` in the YAML config file based on your preferences. In this example, we'll edit the YAML config `./benchmarking/nightly-benchmark.yaml`
37
37
38
38
```yaml
39
39
results_path: /path/where/results/are/stored
40
-
artifacts_path: /path/where/artifacts/are/stored
41
40
datasets_path: /path/to/datasets
42
41
```
43
42
@@ -67,7 +66,7 @@ Results are written to the `results_path` specified in your configuration, organ
67
66
A **session** represents a single invocation of the benchmarking framework. Each session:
68
67
- Has a unique name with timestamp (e.g., `benchmark-run__2025-01-23__14-30-00`)
69
68
- Contains one or more benchmark entries
70
-
- Produces a session directory with results and artifacts
@@ -113,7 +112,7 @@ See [Sinks: Custom Reporting & Actions](#sinks-custom-reporting--actions) for de
113
112
114
113
The framework uses one or more YAML files to configure benchmark sessions. Multiple configuration files are merged, allowing separation of concerns (e.g., machine-specific paths vs. benchmark definitions).
115
114
116
-
A useful pattern is to use multiple YAML files, where configuration that does not typically change is in one or more files, and user or machine-specific configuration is others. For example, `my_paths_and_reports.yaml` could have results / artifacts / datasets paths and personal sink settings (individual slack channel, etc.), and `release-benchmarks.yaml` could have the team-wide configuration containing the individual benchmark entries and performance requirements.
115
+
A useful pattern is to use multiple YAML files, where configuration that does not typically change is in one or more files, and user or machine-specific configuration is others. For example, `my_paths_and_reports.yaml` could have results / datasets paths and personal sink settings (individual slack channel, etc.), and `release-benchmarks.yaml` could have the team-wide configuration containing the individual benchmark entries and performance requirements.
117
116
118
117
This can be especially useful during development. During development you'll not only want to use your own paths and report settings, you'll also want to use the standard benchmarking environment (i.e. a container), but cannot afford to rebuild the Docker image for each code change you're evaluating. The `--use-host-curator` flag is intended for this case. This flag will use your Curator source dir on host inside the container via a volume mount (this works because the container has curator installed in editable mode), and no image rebuild step is needed.
119
118
@@ -125,13 +124,11 @@ An example of a development scenario using this pattern looks like this:
125
124
### Configuration Structure
126
125
127
126
```yaml
128
-
# Required: Base paths for results, artifacts, and datasets
127
+
# Required: Base paths for results and datasets
129
128
# These paths must exist on the host machine
130
129
# When running in Docker with tools/run.sh, paths are automatically mapped to container volumes
131
-
# These base paths can be referenced in other configuration values using {results_path}, {artifacts_path}, {datasets_path}
132
-
# NOTE: the current version of the framework does not use artifacts_path
130
+
# These base paths can be referenced in other configuration values using {results_path}, {datasets_path}
133
131
results_path: /path/to/results
134
-
artifacts_path: /path/to/artifacts
135
132
datasets_path: /path/to/datasets
136
133
137
134
# Optional: Global timeout for all entries (seconds)
@@ -247,7 +244,6 @@ datasets:
247
244
248
245
Available base path placeholders:
249
246
- `{results_path}` - Resolves to the configured `results_path`
250
-
- `{artifacts_path}` - Resolves to the configured `artifacts_path` *Note: unused in current version of the framework*
251
247
- `{datasets_path}`- Resolves to the configured `datasets_path`
252
248
253
249
**Dataset references** - Reference datasets in entry arguments:
@@ -312,7 +308,7 @@ Run benchmarks using a configuration file:
312
308
```
313
309
314
310
This command:
315
-
- Reads the configuration file and extracts `results_path`, `artifacts_path`, and `datasets_path`
311
+
- Reads the configuration file and extracts `results_path` and `datasets_path`
316
312
- Automatically creates volume mounts to map these paths into the container
317
313
- Runs the benchmarking framework with the Curator code built into the Docker image
318
314
- Passes environment variables like `SLACK_WEBHOOK_URL` and `MLFLOW_TRACKING_URI` to the container
0 commit comments