Skip to content

Commit 29de4e1

Browse files
nosnelmilleokondrashov
authored andcommitted
update multi loader docs
Signed-off-by: Lenson <nosnelmil@gmail.com> update multi-loader docs Signed-off-by: Lenson <nosnelmil@gmail.com>
1 parent 7526c24 commit 29de4e1

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/multi_loader.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ As a wrapper around loader, multi-loader requires the initial cluster setup to b
1919
### LoaderStudy
2020
| Parameter name | Data type | Possible values | Default value | Description |
2121
|-----------------------|------------------------|-------------------------------|---------------|--------------------------------------------------------------------|
22-
| Config | map[string]interface{} | Any field in [LoaderConfiguration](https://github.com/vhive-serverless/invitro/blob/main/docs/configuration.md#loader-configuration-file-format) except `Platform `| N/A | The configuration for each loader experiment which overrides configurations in baseLoaderConfig |
22+
| Config | map[string]interface{} | Any field in [LoaderConfiguration](https://github.com/vhive-serverless/invitro/blob/main/docs/configuration.md#loader-configuration-file-format) except `Platform`| N/A | The configuration for each loader experiment which overrides configurations in baseLoaderConfig |
2323
| Name | string | N/A | N/A | The name of the loader experiment |
2424
| TracesDir | string | N/A | N/A | Directory containing the traces for the experiment |
2525
| TracesFormat | string | "data/traces/example_{}" | N/A | Format of the trace files **The format string "{}" is required** |
@@ -29,7 +29,9 @@ As a wrapper around loader, multi-loader requires the initial cluster setup to b
2929
| PreScript | string | any bash Command | "" | (Optional) Local script that runs this specific experiment |
3030
| PostScript | string | any bash Command | "" | (Optional) Local script that runs this specific experiment |
3131

32-
> **_Important_**: Only one of the following is required:
32+
> **_Important_**:
33+
>
34+
> Only one of the following is required:
3335
> 1. `TracesDir`, or
3436
> 2. `TracesFormat` and `TraceValues`, or
3537
> 3. `TracePath` within the `LoaderExperiment`'s `Config` field
@@ -38,10 +40,13 @@ As a wrapper around loader, multi-loader requires the initial cluster setup to b
3840
> 1. `TracesDir`,
3941
> 2. `TracesFormat` and `TraceValues`,
4042
> 3. `TracePath`
41-
> The `Platform` field must not be overridden and should only defined in the base config.
42-
> The `IatGeneration` and `Generated` fields might not work as expected for multiple experiments due to limitations of loader.
43+
>
44+
> The `Platform` field must not be overridden and should only be defined in the base config.
45+
>
46+
> The `IatGeneration` and `Generated` fields may not function as expected when handling multiple experiments due to limitations in the loader implementation.
4347
4448
> **_Note_**:
49+
>
4550
> The `Config` field follows the same structure as the [LoaderConfiguration](https://github.com/vhive-serverless/invitro/blob/main/docs/configuration.md#loader-configuration-file-format).
4651
> Any field defined in `Config` will override the corresponding value from the configuration in `BaseConfigPath`, but only for that specific experiment.
4752
> For example, if `BaseConfigPath` has `ExperimentDuration` set to 5 minutes, and you define `ExperimentDuration` as 10 minutes in `Config`, that particular experiment will run for 10 minutes instead.

0 commit comments

Comments
 (0)