Skip to content

refactor(performance-tools): log camera config metadata - #257

Open
rishika-y-gaur wants to merge 2 commits into
intel-retail:mainfrom
rishika-y-gaur:fix/369
Open

rishika-y-gaur wants to merge 2 commits into
intel-retail:mainfrom
rishika-y-gaur:fix/369

Conversation

@rishika-y-gaur

@rishika-y-gaur rishika-y-gaur commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Read the _about section from the selected camera config and print its scenario details at the start of terminal output and stream_density.log. Add tests for loading and printing the metadata and including it in the stream-density report.

Resolves 344 and 369

PR Checklist

  • Added label to the Pull Request for easier discoverability and search
  • Commit Message meets guidelines as indicated in the URL https://github.com/intel-retail/performance-tools/blob/main/CONTRIBUTING.md
  • Every commit is a single defect fix and does not mix feature addition or changes
  • Unit Tests have been added for new changes
  • Updated Documentation as relevant to the changes
  • All commented code has been removed
  • If you've added a dependency, you've ensured license is compatible with repository license and clearly outlined the added dependency.
  • PR change contains code related to security
  • PR introduces changes that breaks compatibility with other modules (If YES, please provide details below)

What are you changing?

Read the optional _about section from the selected camera config and print its scenario details at the start of terminal output and stream_density.log. Add tests for loading and printing the metadata and including it in the stream-density report.

image image image

Issue this PR will close

close: #344 and #369

Anything the reviewer should know when reviewing this PR?

Camera configs without an _about section remain supported. The log is opened in append mode, so the metadata appears at the start of each run’s log output, not necessarily at the top of an existing log file. All repository references to the renamed and removed workloads have been updated; no compatibility break is expected.

Test Instructions if applicable

From performance-tools/benchmark-scripts, run these three test cases

python -m unittest
stream_density_test.Testing.test_get_camera_config_about_reads_selected_config
stream_density_test.Testing.test_print_camera_config_about_shows_selected_config_and_fields
stream_density_test.Testing.test_print_stream_density_report_summary
stream_density_test.Testing.test_pipeline_iterations

If the there are associated PRs in other repositories, please link them here (i.e. intel-retail/performance-tools )

Read the _about section from the selected camera config and print its scenario details at the start of terminal output and stream_density.log.
Add tests for loading and printing the metadata and including it in the stream-density report.

Resolves 344 and 369

Signed-off-by: rishika-y-gaur <rishika.gaur@intel.com>

Copilot AI left a comment

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.

🟡 Changes recommended

Production report calls omit the metadata argument, leaving scenario details absent from result summaries.

1 open finding
What changed in this PR

Adds camera configuration scenario metadata to stream-density output.

Changes:

  • Loads optional _about metadata and prints it at terminal and log startup.
  • Adds report metadata formatting and unit tests.
File Description
benchmark-scripts/​stream_density.py Loads and prints scenario metadata; adds optional report fields.
benchmark-scripts/​stream_density_test.py Tests metadata loading, printing, and report formatting.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread benchmark-scripts/stream_density.py
Pass the selected camera config's _about metadata to both production
stream-density report calls.

Add iteration-level coverage for successful-density and minimum-pipeline
failure reports.

Signed-off-by: rishika-y-gaur <rishika.gaur@intel.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants