Skip to content

docs: markdown improvements #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 20, 2025
Merged

Conversation

antoniomtz
Copy link

@antoniomtz antoniomtz commented Mar 20, 2025

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/automated-self-checkout/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?

Issue this PR will close

close: #693

Anything the reviewer should know when reviewing this PR?

Test Instructions if applicable

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

Signed-off-by: Antonio Martinez <[email protected]>
Copy link
Contributor

@NeethuES-intel NeethuES-intel left a comment

Choose a reason for hiding this comment

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

LGTM, added some minor changes

@@ -30,30 +34,30 @@ make PIPELINE_SCRIPT=yolov5s_effnetb0.sh DEVICE_ENV=res/all-gpu.env BATCH_SIZE=8

## dGPU only (GPU.1)

Run with GPU only Batch size 1
Run with dGPU only Batch size 1
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Run with dGPU only Batch size 1
Run with Batch size 1 on dGPU only

```

Run with GPU only Batch size 8
Run with dGPU only Batch size 8
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Run with dGPU only Batch size 8
Run with Batch size 8 on dGPU only

```

## NPU only

Run with GPU only Batch size 1
Run with NPU only Batch size 1
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Run with NPU only Batch size 1
Run with Batch size 1 on NPU only

```

Run with GPU only Batch size 8
Run with NPU only Batch size 8
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Run with NPU only Batch size 8
Run with Batch size 8 on NPU only

Copy link
Contributor

@ejlee3 ejlee3 left a comment

Choose a reason for hiding this comment

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

Agree with Neethu's changes. otherwise LGTM

Antonio Martinez added 2 commits March 20, 2025 16:15
Signed-off-by: Antonio Martinez <[email protected]>
Signed-off-by: Antonio Martinez <[email protected]>
@antoniomtz antoniomtz merged commit 05f8452 into intel-retail:main Mar 20, 2025
6 of 8 checks passed
@antoniomtz antoniomtz deleted the doc-fixes branch March 20, 2025 23:16
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.

docs: Improve benchmark commands markdown and main README
4 participants