Skip to content

Commit 5c68c3a

Browse files
committed
Fix markdown linting issues with list items
Signed-off-by: Karan Goel <[email protected]>
1 parent 1069544 commit 5c68c3a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

benchmarks/auto_tune/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -161,16 +161,16 @@ The `batch_auto_tune.sh` script allows you to run multiple `auto_tune.sh` experi
161161

162162
### How to Run
163163

164-
1. **Create a JSON configuration file**: Create a file (e.g., `runs_config.json`) containing an array of JSON objects. Each object defines the parameters for a single `auto_tune.sh` run.
164+
1. **Create a JSON configuration file**: Create a file (e.g., `runs_config.json`) containing an array of JSON objects. Each object defines the parameters for a single `auto_tune.sh` run.
165165

166-
2. **Execute the script**:
166+
2. **Execute the script**:
167167

168168
```bash
169169
bash batch_auto_tune.sh <path_to_json_file> [gcs_upload_path]
170170
```
171171

172-
- `<path_to_json_file>`: **Required.** Path to your JSON configuration file.
173-
- `[gcs_upload_path]`: **Optional.** A GCS path (e.g., `gs://my-bucket/benchmark-results`) where the detailed results and profiles for each run will be uploaded.
172+
- `<path_to_json_file>`: **Required.** Path to your JSON configuration file.
173+
- `[gcs_upload_path]`: **Optional.** A GCS path (e.g., `gs://my-bucket/benchmark-results`) where the detailed results and profiles for each run will be uploaded.
174174

175175
### Configuration File
176176

@@ -210,9 +210,9 @@ Here is an example `runs_config.json` with two benchmark configurations:
210210
211211
The script modifies the input JSON file in place, adding the results of each run to the corresponding object. The following fields are added:
212212
213-
- `run_id`: A unique identifier for the run, derived from the timestamp.
214-
- `status`: The outcome of the run (`SUCCESS`, `FAILURE`, or `WARNING_NO_RESULT_FILE`).
215-
- `results`: The content of the `result.txt` file from the `auto_tune.sh` run.
216-
- `gcs_results`: The GCS URL where the run's artifacts are stored (if a GCS path was provided).
213+
- `run_id`: A unique identifier for the run, derived from the timestamp.
214+
- `status`: The outcome of the run (`SUCCESS`, `FAILURE`, or `WARNING_NO_RESULT_FILE`).
215+
- `results`: The content of the `result.txt` file from the `auto_tune.sh` run.
216+
- `gcs_results`: The GCS URL where the run's artifacts are stored (if a GCS path was provided).
217217

218218
A summary of successful and failed runs is also printed to the console upon completion.

0 commit comments

Comments
 (0)