Skip to content

Conversation

@xin3he
Copy link
Contributor

@xin3he xin3he commented Oct 21, 2025

PR Type

Enhancement


Description

  • Mark incbench as deprecated in documentation

  • Update introduction to reflect incbench movement


Diagram Walkthrough

flowchart LR
  A["Update Benchmark Title"] -- "Add Deprecated Note" --> B["Modify Introduction"]
Loading

File Walkthrough

Relevant files
Documentation
benchmark.md
Deprecate `incbench` in documentation                                       

docs/source/3x/benchmark.md

  • Change title to "Benchmark (Deprecated)"
  • Add deprecation note for incbench
  • Update introduction to mention incbench movement
+3/-1     

Signed-off-by: He, Xin3 <xin3.he@intel.com>
@xin3he
Copy link
Contributor Author

xin3he commented Oct 21, 2025

Mainly used in run_benchmark.py.
If it's still needed by validation, we can move it to validation repo. @chensuyue @XuehaoSun @thuang6

@PRAgent4INC
Copy link
Collaborator

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Clarification Needed

The deprecation message could be more detailed. It would be helpful to specify where incbench has been moved or what users should use instead.

> Since version >= 3.6, `incbench` has been moved.

@PRAgent4INC
Copy link
Collaborator

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Update incbench location

Clarify the destination or provide a link to the new location of incbench.

docs/source/3x/benchmark.md [12]

-> Since version >= 3.6, `incbench` has been moved.
+> Since version >= 3.6, `incbench` has been moved to the new tools section. Please refer to [New Tools Section](link_to_new_section).
Suggestion importance[1-10]: 8

__

Why: Clarifying the destination or providing a link to the new location of incbench improves the documentation's usefulness and helps users find the necessary information.

Medium

@thuang6
Copy link
Contributor

thuang6 commented Oct 21, 2025

@xin3he , the security issue was reported in 2.x API benchmark feature not incbench in 3.x version

Signed-off-by: He, Xin3 <xin3.he@intel.com>
@xin3he
Copy link
Contributor Author

xin3he commented Oct 22, 2025

Thanks, both 2x and 3x are removed now.
BTW, I saw some codes in .azure_pipeline are using inc_bench, will contact @chensuyue to update when she is back.

Signed-off-by: He, Xin3 <xin3.he@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants