Skip to content

Conversation

@XuehaoSun
Copy link
Contributor

@XuehaoSun XuehaoSun commented Oct 28, 2025

User description

Type of Change

feature or bug fix or documentation or validation or others
API changed or not

Description

detail description

Expected Behavior & Potential Risk

the expected behavior that triggered by this PR

How has this PR been tested?

how to reproduce the test (including hardware information)

Dependency Change?

any library dependency introduced or removed


PR Type

Documentation


Description

  • Updated Python version requirements to 3.10+

  • Enhanced installation instructions with optional framework-specific installations

  • Updated supported hardware and software environments


Diagram Walkthrough

flowchart LR
  A["Update README.md"] -- "Python version 3.10+" --> B["Update installation_guide.md"]
  B -- "Optional framework-specific installations" --> C["Update supported hardware"]
  C -- "Update supported software" --> D["Complete"]
Loading

File Walkthrough

Relevant files
Documentation
README.md
Update Python version badge                                                           

README.md

  • Updated Python version badge to 3.10+
+1/-1     
installation_guide.md
Enhance installation instructions and update environment details

docs/source/installation_guide.md

  • Updated Python version requirements to 3.10, 3.11, 3.12
  • Added optional framework-specific installation commands
  • Updated supported hardware list
  • Updated supported software environment details
+35/-20 

@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

Version Update

Ensure that the updated Python version requirement is accurate and that all dependencies are compatible with Python 3.10+.

[![python](https://img.shields.io/badge/python-3.10%2B-blue)](https://github.com/intel/neural-compressor)

@PRAgent4INC
Copy link
Collaborator

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Add clarity to optional steps

Ensure that the optional installation steps are clearly marked and provide context
for their usage.

docs/source/installation_guide.md [82-84]

 ```Shell
-# PyTorch framework extension API + PyTorch dependency
+# Optional: PyTorch framework extension API + PyTorch dependency
 INC_PT_ONLY=1 pip install .
<details><summary>Suggestion importance[1-10]: 6</summary>

__

Why: The suggestion adds clarity to the optional installation steps by prefixing them with "Optional:". This improves readability and helps users understand that these steps are not mandatory.


</details></details></td><td align=center>Low

</td></tr></tr></tbody></table>

Copy link
Contributor

@yiliu30 yiliu30 left a comment

Choose a reason for hiding this comment

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

LGTM, thx!

@XuehaoSun XuehaoSun merged commit 7d92630 into master Oct 28, 2025
12 checks passed
@XuehaoSun XuehaoSun deleted the xuehao/doc branch October 28, 2025 06:15
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.

5 participants