Updated

This version is capable of capturing real-time stock images, detecting patterns in them, and generating a video and an Excel file containing annotated or predicted images with labels and timestamps.

README.md

@@ -7,14 +7,14 @@ tags:
 - vision
 - object-detection
 - pytorch
-- finance 
+- finance
 - stock market
 - candlesticks
 - pattern recognition
 - option trading
 - chart reader
 library_name: ultralytics
-library_version: 8.0.43
+library_version: 8.3.94
 inference: false
 model-index:
 - name: foduucom/stockmarket-pattern-detection-yolov8
@@ -34,26 +34,24 @@ pipeline_tag: object-detection
   <img width="500" alt="foduucom/stockmarket-pattern-detection-yolov8" src="https://huggingface.co/foduucom/stockmarket-pattern-detection-yolov8/resolve/main/thumbnail.jpg">
 </div>
 
-# Model Card for YOLOv8s Stock Market Pattern Detection on Live Trading Video Data
+# Model Card for YOLOv8s Stock Market Pattern Detection from Live Screen Capture
 
 ## Model Summary
 
-The YOLOv8s Stock Market Pattern Detection model is an object detection model based on the YOLO (You Only Look Once) framework. It is designed to detect various chart patterns in real-time stock market trading video data. The model aids traders and investors by automating the analysis of chart patterns, providing timely insights for informed decision-making. The model has been fine-tuned on a diverse dataset and achieved high accuracy in detecting and classifying stock market patterns in live trading scenarios.
+The YOLOv8s Stock Market Pattern Detection model is an object detection model based on the YOLO (You Only Look Once) framework. It is designed to detect various chart patterns in real-time from screen-captured stock market trading data. The model aids traders and investors by automating the analysis of chart patterns, providing timely insights for informed decision-making. The model has been fine-tuned on a diverse dataset and achieves high accuracy in detecting and classifying stock market patterns in live trading scenarios.
 
 ## Model Details
 
 ### Model Description
-The YOLOv8s Stock Market Pattern Detection model offers a transformative solution for traders and investors by enabling real-time detection of crucial chart patterns within live trading video data. As stock markets evolve rapidly, this model's capabilities empower users with timely insights, allowing them to make informed decisions with speed and accuracy.
+The YOLOv8s Stock Market Pattern Detection model enables real-time detection of crucial chart patterns within stock market screen captures. As stock markets evolve rapidly, this model's capabilities empower users with timely insights, allowing them to make informed decisions with speed and accuracy.
 
-The model seamlessly integrates into live trading systems, providing instant pattern detection and classification. By leveraging advanced bounding box techniques and pattern-specific feature extraction, the model excels in identifying patterns such as 'Head and shoulders bottom,' 'Head and shoulders top,' 'M_Head,' 'StockLine,' 'Triangle,' and 'W_Bottom.' This enables traders to optimize their strategies, automate trading decisions, and respond to market trends in real-time.
+The model is designed to work with screen capture of stock market trading charts. It can detect patterns such as 'Head and shoulders bottom,' 'Head and shoulders top,' 'M_Head,' 'StockLine,' 'Triangle,' and 'W_Bottom.' Traders can optimize their strategies, automate trading decisions, and respond to market trends in real-time.
 
-To facilitate integration into live trading systems or to inquire about customization, please contact us at [email protected]. Your collaboration and feedback are instrumental in refining and enhancing the model's performance in dynamic trading environments.
+To integrate this model into live trading systems or for customization inquiries, please contact us at [email protected].
 
 - **Developed by:** FODUU AI
 - **Model type:** Object Detection
-- **Task:** Stock Market Pattern Detection on Live Trading Video Data
-
-The YOLOv8s Stock Market Pattern Detection model is designed to adapt to the fast-paced nature of live trading environments. Its ability to operate on real-time video data allows traders and investors to harness pattern-based insights without delay.
+- **Task:** Stock Market Pattern Detection from Screen Capture
 
 ### Supported Labels
 
@@ -64,126 +62,111 @@ The YOLOv8s Stock Market Pattern Detection model is designed to adapt to the fas
 ## Uses
 
 ### Direct Use
-
-The YOLOv8s Stock Market Pattern Detection model can be directly integrated into live trading systems to provide real-time detection and classification of chart patterns. Traders can utilize the model's insights for timely decision-making.
+The model can be used for real-time pattern detection on screen-captured stock market charts. It can log detected patterns, annotate detected images, save results in an Excel file, and generate a video of detected patterns over time.
 
 ### Downstream Use
-
 The model's real-time capabilities can be leveraged to automate trading strategies, generate alerts for specific patterns, and enhance overall trading performance.
 
-### Training data 
-The Stockmarket model was trained on custom dataset consisting of 9000/800 annotated images for training/validation respectively. 
-
+### Training Data
+The Stock Market model was trained on a custom dataset consisting of 9000 training images and 800 validation images.
 
 ### Out-of-Scope Use
-
-The model is not designed for unrelated object detection tasks or scenarios outside the scope of stock market pattern detection in live trading video data.
+The model is not designed for unrelated object detection tasks or scenarios outside the scope of stock market pattern detection from screen-captured data.
 
 ## Bias, Risks, and Limitations
 
-The YOLOv8s Stock Market Pattern Detection model may exhibit some limitations and biases:
-
-- Performance may be affected by variations in video quality, lighting conditions, and pattern complexity within live trading data.
-- Rapid market fluctuations and noise in video data may impact the model's accuracy and responsiveness.
-- Market-specific patterns or anomalies not well-represented in the training data may pose challenges for detection.
+- Performance may be affected by variations in chart styles, screen resolution, and market conditions.
+- Rapid market fluctuations and noise in trading data may impact accuracy.
+- Market-specific patterns not well-represented in the training data may pose challenges for detection.
 
 ### Recommendations
-
-Users should be aware of the model's limitations and potential biases. Thorough testing and validation within live trading simulations are advised before deploying the model in real trading environments.
+Users should be aware of the model's limitations and potential biases. Testing and validation with historical data and live market conditions are advised before deploying the model for real trading decisions.
 
 ## How to Get Started with the Model
 
-To begin using the YOLOv8s Stock Market Pattern Detection model on live trading video data, follow these steps:
+To begin using the YOLOv8s Stock Market Pattern Detection model, install the necessary libraries:
 ```bash
-pip install ultralyticsplus==0.0.28 ultralytics==8.0.43
+pip install opencv-python==4.11.0.86 numpy==2.1.3 mss==10.0.0 ultralytics==8.3.94 openpyxl==3.1.5
 ```
 
-- Load model and perform real-time prediction:
-
+### Screen Capture and Pattern Detection Implementation
 ```python
-from ultralyticsplus import YOLO, render_result
+import os
+import mss
 import cv2
-
-# load model
+import numpy as np
+import time
+import glob
+from ultralytics import YOLO
+from openpyxl import Workbook
+
+# Define paths
+home_dir = os.path.expanduser("~")
+save_path = os.path.join(home_dir, "yolo_detection")
+screenshots_path = os.path.join(save_path, "screenshots")
+detect_path = os.path.join(save_path, "runs", "detect")
+os.makedirs(screenshots_path, exist_ok=True)
+os.makedirs(detect_path, exist_ok=True)
+
+# Define pattern classes
+classes = ['Head and shoulders bottom', 'Head and shoulders top', 'M_Head', 'StockLine', 'Triangle', 'W_Bottom']
+
+# Load YOLOv8 model
 model = YOLO('foduucom/stockmarket-pattern-detection-yolov8')
 
-# set model parameters
-model.overrides['conf'] = 0.25  # NMS confidence threshold
-model.overrides['iou'] = 0.45  # NMS IoU threshold
-model.overrides['agnostic_nms'] = False  # NMS class-agnostic
-model.overrides['max_det'] = 1000  # maximum number of detections per image
-
-# initialize video capture
-# Open the video file
-video_path = "path/to/your/video/file.mp4"
-cap = cv2.VideoCapture(video_path)
-
-# Loop through the video frames
-while cap.isOpened():
-    # Read a frame from the video
-    success, frame = cap.read()
-
-    if success:
-        # Run YOLOv8 inference on the frame
-        results = model(frame)
-
-        # Visualize the results on the frame
-        annotated_frame = results[0].plot()
-
-        # Display the annotated frame
-        cv2.imshow("YOLOv8 Inference", annotated_frame)
-
-        # Break the loop if 'q' is pressed
-        if cv2.waitKey(1) & 0xFF == ord("q"):
-            break
-    else:
-        # Break the loop if the end of the video is reached
-        break
-
-# Release the video capture object and close the display window
-cap.release()
-cv2.destroyAllWindows()
+# Define screen capture region
+monitor = {"top": 0, "left": 683, "width": 683, "height": 768}
+
+# Create Excel file
+excel_file = os.path.join(save_path, "classification_results.xlsx")
+wb = Workbook()
+ws = wb.active
+ws.append(["Timestamp", "Predicted Image Path", "Label"])
+
+# Initialize video writer
+video_path = os.path.join(save_path, "annotated_video.mp4")
+fourcc = cv2.VideoWriter_fourcc(*"mp4v")
+fps = 0.5
+video_writer = None
+
+# Start capturing
+with mss.mss() as sct:
+    start_time = time.time()
+    frame_count = 0
+    
+    while time.time() - start_time < 60:
+        sct_img = sct.grab(monitor)
+        img = np.array(sct_img)
+        img = cv2.cvtColor(img, cv2.COLOR_BGRA2BGR)
+        timestamp = time.strftime("%Y-%m-%d %H:%M:%S")
+        image_name = f"predicted_images_{timestamp}_{frame_count}.png"
+        image_path = os.path.join(screenshots_path, image_name)
+        cv2.imwrite(image_path, img)
+        
+        results = model(image_path, save=True)
+        predict_path = results[0].save_dir if results else None
+        annotated_images = sorted(glob.glob(os.path.join(predict_path, "*.jpg")), key=os.path.getmtime, reverse=True) if predict_path else []
+        final_image_path = annotated_images[0] if annotated_images else image_path
+        
+        predicted_label = classes[int(results[0].boxes.cls.tolist()[0])] if results and results[0].boxes else "No pattern detected"
+        ws.append([timestamp, final_image_path, predicted_label])
+        wb.save(excel_file)
+        
+        frame_count += 1
+        time.sleep(5)
+    
+print(f"Results saved to {excel_file}")
 ```
 
-## Training Details
-
-### Training Data
-
-The model is trained on a diverse dataset containing stock market chart images with various chart patterns, capturing different market conditions and scenarios.
-
-### Training Procedure
-
-The training process involves extensive computation and is conducted over multiple epochs. The model's weights are adjusted to minimize detection loss and optimize performance for stock market pattern detection.
-
-#### Metrics
-
-- [email protected] (box): 
-  - All patterns: 0.932
-  - Individual patterns: Varies based on pattern type
-
-### Model Architecture and Objective
-
-The YOLOv8s architecture incorporates modifications tailored to stock market pattern detection. It features a specialized backbone network, self-attention mechanisms, and pattern-specific feature extraction modules.
-
-### Compute Infrastructure
-
-#### Hardware
-
-NVIDIA GeForce RTX 3060 card
-
-#### Software
-
-The model was trained and fine-tuned using a Jupyter Notebook environment.
-
-## Model Card Contact
-
+## Model Contact
 For inquiries and contributions, please contact us at [email protected].
 
 ```bibtex
 @ModelCard{
-  author    = {Nehul Agrawal and
-               Pranjal Singh Thakur},
-  title     = {YOLOv8s Stock Market Pattern Detection on Live Trading Video Data},
+  author    = {Nehul Agrawal,
+               Pranjal Singh Thakur, Arjun Singh},
+  title     = {YOLOv8s Stock Market Pattern Detection from Live Screen Capture},
   year      = {2023}
 }
-```
+```
+