Change comment strategy for low-q2 retraining (#216)

Author: simonge

benchmarks/lowq2_reconstruction/PRfunctions.py

@@ -7,6 +7,7 @@
 import xml.etree.ElementTree as ET
 from pathlib import Path
 from datetime import datetime, timezone
+import os
 
 # =============================================================================
 # Utility Functions
@@ -21,24 +22,6 @@ def parse_repository(repository):
         print(f"❌ Invalid repository format: {repository}. Expected: 'owner/name'")
         return None, None
 
-def make_github_request(url, headers, method='GET', data=None):
-    """Make a GitHub API request with consistent error handling"""
-    try:
-        if method.upper() == 'GET':
-            response = requests.get(url, headers=headers)
-        elif method.upper() == 'POST':
-            response = requests.post(url, headers=headers, json=data)
-        elif method.upper() == 'PATCH':
-            response = requests.patch(url, headers=headers, json=data)
-        else:
-            print(f"❌ Unsupported HTTP method: {method}")
-            return None
-        
-        return response
-    except requests.RequestException as e:
-        print(f"❌ Request failed: {e}")
-        return None
-
 # =============================================================================
 # GitHub API Functions
 # =============================================================================
@@ -171,9 +154,9 @@ def find_line_number_of_change(original_content, old_value):
 # GitHub PR Comment Functions
 # =============================================================================
 
-def create_pr_suggestion(repo_owner, repo_name, pr_number, calibration_file, xml_file, line_number, suggested_line, head_sha, github_token):
-    """Create a PR review with code suggestion or update existing one"""
-    print(f"Creating/updating PR review with suggestion for #{pr_number}...")
+def create_pr_suggestion(repo_owner, repo_name, pr_number, calibration_file, xml_file, line_number, suggested_line, head_sha, github_token, artifacts_url=''):
+    """Create a PR comment with proposed changes"""
+    print(f"Creating PR comment with calibration update for #{pr_number}...")
 
     headers = {
         'Accept': 'application/vnd.github+json',
@@ -182,90 +165,83 @@ def create_pr_suggestion(repo_owner, repo_name, pr_number, calibration_file, xml
 
     bot_comment_base = f"🤖 **Automated Calibration `{calibration_file}` Update**"
 
-    # Check for existing review comments from bot
-    existing_comment_id = find_existing_bot_comment(repo_owner, repo_name, pr_number, bot_comment_base, xml_file, line_number, github_token)
+    # Check for existing comments from bot
+    existing_comment_id = find_existing_bot_comment_general(repo_owner, repo_name, pr_number, bot_comment_base, github_token)
 
     # Generate timestamp for the comment
     timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M:%S UTC")
 
-    suggestion_body = f"""{bot_comment_base}{' (Updated)' if existing_comment_id else ''}
+    # Get current line content for context
+    content = get_file_content(repo_owner, repo_name, xml_file, head_sha, github_token)
+    lines = content.split('\n') if content else []
+    current_line = lines[line_number - 1].strip() if line_number <= len(lines) else "Line not found"
+
+    comment_body = f"""{bot_comment_base}{' (Updated)' if existing_comment_id else ''}
 
 A new calibration has been generated and is ready for use.
 
+**File:** `{xml_file}`
+**Line:** {line_number}
 **Last updated:** {timestamp}
 
-```suggestion
-{suggested_line}
-```"""
+**Current line:**
+```xml
+{current_line}
+```
+
+**Proposed change:**
+```xml
+{suggested_line.strip()}
+```
+
+Please update the calibration URL in `{xml_file}` at line {line_number}."""
+
+    # Add artifacts link if provided
+    if artifacts_url:
+        comment_body += f"\n\n---\n\n### 📊 Review Results\n\nPlease review the artifacts here: {artifacts_url}"
 
+    # Create or update comment via GitHub REST API (no gh CLI)
     if existing_comment_id:
-        # Update existing comment
         print(f"Updating existing comment {existing_comment_id}...")
-        update_url = f"https://api.github.com/repos/{repo_owner}/{repo_name}/pulls/comments/{existing_comment_id}"
-        update_data = {'body': suggestion_body}
+        update_url = f"https://api.github.com/repos/{repo_owner}/{repo_name}/issues/comments/{existing_comment_id}"
+        update_data = {'body': comment_body}
         response = requests.patch(update_url, headers=headers, json=update_data)
-        
         if response.status_code == 200:
             print("✅ Existing PR comment updated successfully")
             return response.json()
         else:
-            print(f"❌ Failed to update existing comment: {response.status_code}")
-            print(f"   Response: {response.text}")
+            print(f"❌ Failed to update existing comment: {response.status_code}\n{response.text}")
             return None
     else:
-        # Create new review comment
-        print("Creating new review comment...")
-        review_url = f"https://api.github.com/repos/{repo_owner}/{repo_name}/pulls/{pr_number}/reviews"
-        
-        review_data = {
-            'body': f'🤖 Automated review with updated calibration URLs `{calibration_file}` for PR #{pr_number}',
-            'event': 'COMMENT',
-            'commit_id': head_sha,
-            'comments': [
-                {
-                    'path': xml_file,
-                    'line': line_number,
-                    'body': suggestion_body
-                }
-            ]
-        }
-        
-        response = requests.post(review_url, headers=headers, json=review_data)
-        
-        if response.status_code == 200:
-            print("✅ New PR review with suggestion created successfully")
+        print("Creating new PR comment...")
+        comment_url = f"https://api.github.com/repos/{repo_owner}/{repo_name}/issues/{pr_number}/comments"
+        comment_data = {'body': comment_body}
+        response = requests.post(comment_url, headers=headers, json=comment_data)
+        if response.status_code == 201:
+            print("✅ New PR comment created successfully")
             return response.json()
         else:
-            print(f"❌ Failed to create PR review: {response.status_code}")
-            print(f"   Response: {response.text}")
+            print(f"❌ Failed to create PR comment: {response.status_code}\n{response.text}")
             return None
 
-def find_existing_bot_comment(repo_owner, repo_name, pr_number, bot_comment_base, xml_file, line_number, github_token):
-    """Find existing bot comment on the specific line"""
-    print(f"Checking for existing bot comments on line {line_number}...")
-    
+def find_existing_bot_comment_general(repo_owner, repo_name, pr_number, bot_comment_base, github_token):
+    """Find existing bot comment (general PR comment, not line-specific)"""
     headers = {
         'Accept': 'application/vnd.github+json',
         'Authorization': f'token {github_token}'
     }
 
-    # Get all review comments for the PR
-    comments_url = f"https://api.github.com/repos/{repo_owner}/{repo_name}/pulls/{pr_number}/comments"
+    # Get all general comments for the PR
+    comments_url = f"https://api.github.com/repos/{repo_owner}/{repo_name}/issues/{pr_number}/comments"
     response = requests.get(comments_url, headers=headers)
 
     if response.status_code != 200:
         print(f"❌ Failed to get PR comments: {response.status_code}")
         return None
 
-    comments = response.json()
-    
-    # Look for existing bot comment on the same line and file
-    for comment in comments:
-        # Check if it's from the bot (contains the bot identifier)
-        # and on the same file and line
-        if (comment.get('path') == xml_file and 
-            comment.get('line') == line_number and
-            bot_comment_base in comment.get('body', '')):
+    # Look for existing bot comment
+    for comment in response.json():
+        if bot_comment_base in comment.get('body', ''):
             print(f"✅ Found existing bot comment: {comment['id']}")
             return comment['id']
 

benchmarks/lowq2_reconstruction/Snakefile

@@ -13,6 +13,7 @@ rule filter_hepmc_for_training:
         script=workflow.source_path("filterHEPMC3.py"),        
     output:
         SIMOUTDIR+"Low-Q2_Training_Events.hepmc3.tree.root",
+    cache: True
     params:
         events="root://dtn-eic.jlab.org//volatile/eic/EPIC/EVGEN/SIDIS/pythia6-eic/1.0.0/18x275/q2_0to1/pythia_ep_noradcor_18x275_q2_0.000000001_1.0_run1.ab.hepmc3.tree.root",
     shell:
@@ -27,6 +28,7 @@ rule lowq2_training_sim:
         events=SIMOUTDIR+"Low-Q2_Training_Events.hepmc3.tree.root",      
     output:
         SIMOUTDIR+"Low-Q2_Training_SimEvents_{CAMPAIGN}.edm4hep.root",
+    cache: True
     shell:
         """
             exec npsim \

benchmarks/lowq2_reconstruction/config.yml

@@ -105,6 +105,11 @@ upload_onnx:lowq2_reconstruction:
     - sha256sum -c <(echo '38ac8548c67302299e50a1b81c159ed418e90d84a6606ddd377fd2c8b164d114  pelican_Linux_x86_64.tar.gz')
     - tar zxf pelican_Linux_x86_64.tar.gz
     - ./pelican-*/pelican object copy $LOWQ2_ONNX_FILE $ONNX_UPLOAD_URL
+    - xrdfs $XROOTD_ENDPOINT stat $XROOTD_CALIB_PREFIX/$ONNX_HASH/Low-Q2_Steering_Reconstruction.onnx
+    - |
+      # Build artifact folder URL for review
+      ARTIFACTS_URL="${CI_PROJECT_URL}/-/jobs/${CI_JOB_ID}/artifacts/browse/results/lowq2_reconstruction/"
+      echo "Artifacts URL: $ARTIFACTS_URL"
     - echo "Updating PR with lowq2 reconstruction results"
     - |
       python benchmarks/lowq2_reconstruction/makePRSuggestion.py \
@@ -113,6 +118,7 @@ upload_onnx:lowq2_reconstruction:
       --githubToken $GITHUB_REPO_POST_COMMENT \
       --calibrationFile calibrations/onnx/Low-Q2_Steering_Reconstruction.onnx \
       --xml compact/calibrations.xml \
-      --repository $GITHUB_REPOSITORY
+      --repository $GITHUB_REPOSITORY \
+      --artifactsURL "$ARTIFACTS_URL"
     - echo "Updating GitHub status for lowq2 reconstruction"
 

benchmarks/lowq2_reconstruction/makePRSuggestion.py

@@ -1,29 +1,31 @@
 #!/usr/bin/env python3
 """
-Script to create GitHub PR suggestions for ONNX model updates
+Script to create GitHub PR comments for ONNX model updates
 """
 import argparse
 import sys
 from PRfunctions import *
 
 # Parse arguments
-parser = argparse.ArgumentParser(description='Update the calibration link for a PR')
+parser = argparse.ArgumentParser(description='Create a PR comment with calibration update suggestions')
 parser.add_argument('--pr', type=str, required=True, help='Pull request number')
 parser.add_argument('--newURL', type=str, required=True, help='URL of the new updated calibration')
 parser.add_argument('--githubToken', type=str, required=True, help='GitHub token for authentication')
 parser.add_argument('--calibrationFile', type=str, default='calibrations/onnx/Low-Q2_Steering_Reconstruction.onnx', help='Path to the local calibration file')
 parser.add_argument('--xml', type=str, default='compact/calibrations.xml', help='Path to the XML configuration file')
 parser.add_argument('--repository', type=str, default='eic/epic', help='GitHub repository (owner/name)')
+parser.add_argument('--artifactsURL', type=str, default='', help='URL to job artifacts for review')
 
-args = parser.parse_args()
 
+args = parser.parse_args()
 
 pr_number            = args.pr
 new_url              = args.newURL
 github_token         = args.githubToken
 calibration_file     = args.calibrationFile
 xml_file             = args.xml
 repository           = args.repository
+artifacts_url        = args.artifactsURL
 
 # =============================================================================
 
@@ -60,13 +62,13 @@
     print(f"✅ Found URL to update in {xml_file} at line {line_number}")
     print(f"   Suggested change: {suggested_line.strip()}")
 
-    # Create the PR review with suggestion
-    response = create_pr_suggestion(repo_owner, repo_name, pr_number, calibration_file, xml_file, line_number, suggested_line, pr_info['head']['sha'], github_token)
+    # Create the PR comment with proposed changes
+    response = create_pr_suggestion(repo_owner, repo_name, pr_number, calibration_file, xml_file, line_number, suggested_line, pr_info['head']['sha'], github_token, artifacts_url)
 
     if response:
-        print("🎉 PR suggestion completed successfully!")
+        print("🎉 PR comment created successfully!")
     else:
-        print("❌ Failed to create PR suggestion")
+        print("❌ Failed to create PR comment")
         sys.exit(1)
 else:
     print(f"❌ Failed to find URL to update in {xml_file}")

benchmarks/lowq2_reconstruction/requirements.txt

@@ -1,7 +1,7 @@
 --index-url https://download.pytorch.org/whl/cpu
 numpy==2.3.1
 #gpu version of torch on eicweb doesn't speed up things for our small model and takes a long time to install
-torch==2.7.1+cpu 
+torch==2.8.0+cpu 
 uproot==5.6.3
 pyHepMC3==3.3.0
 onnx==1.17.0