Merge pull request #4 from InfiniTensor/test_branch

Add code check

Author: Chamberlain0w0

.flake8

@@ -0,0 +1,34 @@
+[flake8]
+# Python version target
+python-version = 3.10
+
+# Maximum line length (matches black's default, but we allow longer for URLs/paths)
+max-line-length = 127
+
+# Select only critical errors that would cause runtime issues
+# E9: Runtime errors (e.g., IndentationError, SyntaxError)
+# F63: Placeholder for assertions in pytests
+# F7: Various errors (e.g., two starred expressions in assignment)
+# F82: Undefined names
+select = E9,F63,F7,F82
+
+# Ignore specific error codes
+# E203: Whitespace before ':' (conflicts with black)
+# W503: Line break before binary operator (conflicts with black)
+extend-ignore = E203,W503
+
+# Directories to exclude from linting
+exclude =
+    .git,
+    __pycache__,
+    .venv,
+    venv,
+    build,
+    dist,
+    *.egg-info
+
+# Show source code for each error
+show-source = true
+
+# Show statistics (number of each type of error)
+statistics = true

.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: Python Code Style Check
+
+# Trigger on push to main/master branches or pull requests targeting them
+on:
+  push:
+    branches: [ "main", "master" ]
+  pull_request:
+    branches: [ "main", "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  style_check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"] # We can add more versions here, e.g., ["3.8", "3.10"]
+
+    steps:
+    # 1. Checkout code
+    - uses: actions/checkout@v4
+
+    # 2. Set up Python environment
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip' # Enable pip caching to speed up future builds
+
+    # 3. Install dependencies
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        # Install linting and formatting tools
+        pip install flake8 black==23.9.1
+
+        # Install project dependencies (if requirements.txt exists)
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        
+    # 4. Linting with flake8
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+    # 5. Check formatting with Black
+    - name: Check formatting with Black
+      run: |
+        # --check only verifies formatting without modifying files.
+        # The CI will fail if the code is not formatted correctly.
+        black . --check --verbose

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+    -   id: black
+        # Use pyproject.toml for configuration (ensures consistency)
+        args: ['--config', 'pyproject.toml']
+-   repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+    -   id: flake8
+        # Use .flake8 for configuration (separate file to avoid TOML parsing issues)
+        # --exit-zero: show warnings but don't fail pre-commit
+        args: ['--config', '.flake8', '--exit-zero']

README.md

@@ -1,7 +1,7 @@
-# InfiniMetrics
-
 <div align="center">
 
+# InfiniMetrics
+
 **An InfiniTensor-Featured Comprehensive Accelerator Evaluation Framework**
 
 [![Format Check](https://img.shields.io/badge/Format_Check-passing-success)](https://github.com/InfiniTensor/InfiniMetrics)
@@ -42,6 +42,7 @@ For detailed guides, configuration, and examples, see the [full documentation](.
 
 - [Installation Guide](./docs/installation.md) - Prerequisites and dependencies
 - [Configuration](./docs/configuration.md) - Input format and parameters
+- [Development Guide](./docs/development.md) - Development setup and extending the framework
 
 ---
 

docs/development.md

@@ -1,6 +1,48 @@
 # Development Guide
 
-This guide explains how to extend InfiniMetrics by adding new adapters and metrics.
+This guide explains how to set up the development environment and extend InfiniMetrics by adding new adapters and metrics.
+
+## Development Setup
+
+### Pre-commit Setup
+
+This project uses **pre-commit** to automatically enforce code style (Black) and linting (Flake8) before every commit.
+
+#### Installation
+
+```bash
+pip install pre-commit
+```
+
+#### Setup (Run Once)
+
+Run the following command in the project root directory to activate the git hooks:
+
+```bash
+pre-commit install
+```
+
+*Output should be: `pre-commit installed at .git/hooks/pre-commit`*
+
+#### Usage
+
+- **Automatic:** Just run `git commit` as usual.
+  - If **Black** modifies your files: Run `git add .` again and re-commit.
+  - If **Flake8** reports errors: Fix the errors, `git add`, and re-commit.
+- **Manual:** To check all files in the repository without committing:
+  ```bash
+  pre-commit run --all-files
+  ```
+
+#### Skip Checks (Emergency Only)
+
+If you need to bypass the checks for a specific commit:
+
+```bash
+git commit -m "your message" --no-verify
+```
+
+---
 
 ## Adding a New Adapter
 

infinimetrics/adapter.py

@@ -104,9 +104,15 @@ def _create_error_response(
         if test_input:
             response.update(
                 {
-                    InfiniMetricsJson.RUN_ID: test_input.get(InfiniMetricsJson.RUN_ID, ""),
-                    InfiniMetricsJson.TESTCASE: test_input.get(InfiniMetricsJson.TESTCASE, ""),
-                    InfiniMetricsJson.CONFIG: test_input.get(InfiniMetricsJson.CONFIG, {}),
+                    InfiniMetricsJson.RUN_ID: test_input.get(
+                        InfiniMetricsJson.RUN_ID, ""
+                    ),
+                    InfiniMetricsJson.TESTCASE: test_input.get(
+                        InfiniMetricsJson.TESTCASE, ""
+                    ),
+                    InfiniMetricsJson.CONFIG: test_input.get(
+                        InfiniMetricsJson.CONFIG, {}
+                    ),
                 }
             )
 

infinimetrics/common/constants.py

@@ -174,7 +174,9 @@ class InfiniCoreResult:
 STREAM_OPERATIONS = ["copy", "scale", "add", "triad"]
 
 # Regex patterns for parsing hardware test output
-L1_CACHE_PATTERN = r"L1 Cache Bandwidth Sweep Test.*?Eff\. bw\s*-+\s*\n(.*?)(?=L2 Cache|\Z)"
+L1_CACHE_PATTERN = (
+    r"L1 Cache Bandwidth Sweep Test.*?Eff\. bw\s*-+\s*\n(.*?)(?=L2 Cache|\Z)"
+)
 L2_CACHE_PATTERN = r"L2 Cache Bandwidth Sweep Test.*?Eff\. bw\s*-+\s*\n(.*?)(?=\Z)"
 
 STREAM_PATTERN_TEMPLATE = r"STREAM_{op}\s+(\d+\.\d+)"
@@ -195,25 +197,27 @@ class InfiniCoreResult:
 # Error Code Constants
 # ============================================================
 
+
 class ErrorCode:
     """Error code values for different types of failures, organized by severity layer"""
+
     # Success
-    SUCCESS = 0              # Test succeeded
+    SUCCESS = 0  # Test succeeded
 
     # Layer 1: Input/Configuration issues (not stability issues)
-    CONFIG = 1               # Invalid configuration or input (user error)
+    CONFIG = 1  # Invalid configuration or input (user error)
 
     # Layer 2: Framework internal errors (tested framework's fault)
-    INTERNAL = 2             # InfiniLM/InfiniCore internal error or non-zero return
+    INTERNAL = 2  # InfiniLM/InfiniCore internal error or non-zero return
 
     # Layer 3: Incompatibility issues
-    INCOMPAT = 3             # Compilation errors, version incompatibility
+    INCOMPAT = 3  # Compilation errors, version incompatibility
 
     # Layer 4: System resource issues
-    SYSTEM = 4               # OS/Hardware issues (OOM, disk full, GPU driver)
+    SYSTEM = 4  # OS/Hardware issues (OOM, disk full, GPU driver)
 
     # Layer 5: Test framework issues (our fault)
-    GENERIC = 5              # Test framework logic error
+    GENERIC = 5  # Test framework logic error
 
     # Layer 6: Timeout issues
-    TIMEOUT = 6              # Test started but hung/timeout
+    TIMEOUT = 6  # Test started but hung/timeout

infinimetrics/common/csv_utils.py

@@ -91,6 +91,7 @@ def _sort_data(data: List[Dict[str, Any]], sort_by: str) -> List[Dict[str, Any]]
     Returns:
         Sorted list of dictionaries
     """
+
     def sort_key(x: Dict[str, Any]) -> float:
         # Handle explicit sort key
         if "_sort_key" in x:

infinimetrics/common/prompt_data.py

@@ -15,25 +15,23 @@
         "What are the ethical considerations surrounding {topic}?",
         "How does {topic} impact our daily lives?",
         "What are the future trends in {topic}?",
-        "What are the key challenges in {topic} research?"
+        "What are the key challenges in {topic} research?",
     ],
-    
     "general_qa": [
         "Tell me about {topic}.",
         "What is {topic}?",
         "Can you explain {topic}?",
         "I need information about {topic}.",
         "Please provide details about {topic}.",
-        "Help me understand {topic}."
+        "Help me understand {topic}.",
     ],
-    
     "technical": [
         "Discuss the technical implementation of {topic}.",
         "What are the algorithms used in {topic}?",
         "Explain the architecture of {topic} systems.",
         "What are the performance considerations for {topic}?",
-        "Describe the scalability challenges in {topic}."
-    ]
+        "Describe the scalability challenges in {topic}.",
+    ],
 }
 
 # ==================== Preset Topic Library ====================
@@ -48,9 +46,8 @@
         "neural networks",
         "transformers",
         "large language models",
-        "generative AI"
+        "generative AI",
     ],
-    
     "tech": [
         "cloud computing",
         "blockchain technology",
@@ -60,38 +57,41 @@
         "distributed systems",
         "cybersecurity",
         "databases",
-        "software engineering"
+        "software engineering",
     ],
-    
     "science": [
         "climate change",
         "genetic engineering",
         "space exploration",
         "renewable energy",
         "quantum physics",
         "biotechnology",
-        "nanotechnology"
-    ]
+        "nanotechnology",
+    ],
 }
 
 # ==================== Default Configuration ====================
 DEFAULT_TEMPLATE_NAME = "ai_qa"
 DEFAULT_TOPIC_NAME = "ai_ml"
 DEFAULT_CHARS_PER_TOKEN = 4
 
+
 # ==================== Helper Functions ====================
 def get_template_names() -> list:
     """Get all available template names"""
     return list(PRESET_TEMPLATES.keys())
 
+
 def get_topic_names() -> list:
     """Get all available topic names"""
     return list(PRESET_TOPICS.keys())
 
+
 def get_template(template_name: str, fallback_name: str = "ai_qa") -> list:
     """Get the template list for the specified name"""
     return PRESET_TEMPLATES.get(template_name, PRESET_TEMPLATES.get(fallback_name, []))
 
+
 def get_topics(topic_name: str, fallback_name: str = "ai_ml") -> list:
     """Get the topic list for the specified name"""
     return PRESET_TOPICS.get(topic_name, PRESET_TOPICS.get(fallback_name, []))