Skip to content
Closed
Changes from all commits
Commits
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
5 changes: 2 additions & 3 deletions sdks/python/apache_beam/testing/analyzers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,8 @@ please follow the below structure.
```
# the test_1 must be a unique id.
test_1:
test_name: Pytorch image classification on 50k images of size 224 x 224 with resnet 152
test_description: Pytorch image classification on 50k images of size 224 x 224 with resnet 152
test_target: apache_beam.testing.benchmarks.inference.pytorch_image_classification_benchmarks
source: big_query
metrics_dataset: beam_run_inference
metrics_table: torch_inference_imagenet_results_resnet152
project: apache-beam-testing
Expand All @@ -58,7 +57,7 @@ test_1:

**NOTE**: `test_target` is optional. It is used for identifying the test that was causing the regression.

**Note**: If the source is **BigQuery**, the `metrics_dataset`, `metrics_table`, `project` and `metric_name` should match with the values defined for performance/load tests.
**Note**: By default, the tool fetches metrics from BigQuery tables. `metrics_dataset`, `metrics_table`, `project` and `metric_name` should match with the values defined for performance/load tests.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The note mentions metric_name as a field that should match the performance/load test values, but this field is missing from the example configuration provided in lines 45-50. Consider adding metric_name to the example for consistency and clarity. Additionally, the sentence structure can be improved for better readability.

Suggested change
**Note**: By default, the tool fetches metrics from BigQuery tables. `metrics_dataset`, `metrics_table`, `project` and `metric_name` should match with the values defined for performance/load tests.
**Note**: By default, the tool fetches metrics from BigQuery tables. The `metrics_dataset`, `metrics_table`, `project`, and `metric_name` fields should match the values defined for performance/load tests.

The above example uses this [test configuration](https://github.com/apache/beam/blob/0a91d139dea4276dc46176c4cdcdfce210fc50c4/.test-infra/jenkins/job_InferenceBenchmarkTests_Python.groovy#L30)
to fill up the values required to fetch the data from source.

Expand Down
Loading