fixed install of detectron to make pupilsense function out of box

Author: Dammy Desktop

.github/workflows/publish.yml

@@ -1,4 +1,5 @@
 name: Publish to PyPI
+
 on:
   push:
     tags:
@@ -10,21 +11,36 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
+
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
         python-version: "3.10"
-    
-    - name: Install dependencies
+        cache: "pip"
+
+    - name: Install System Dependencies
+      # Ubuntu runners need these for OpenCV and imageio[ffmpeg] to work
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y ffmpeg libgl1-mesa-glx
+
+    - name: Install PyTorch (CPU version)
+      # We use the CPU version for testing to make the runner faster/lighter
+      run: |
+        pip install torch==2.2.0 torchvision==0.17.0 --index-url https://download.pytorch.org/whl/cpu
+
+    - name: Install Detectron2
+      # Linux can build this from Git easily once Torch is present
+      run: |
+        pip install --no-build-isolation 'git+https://github.com/facebookresearch/detectron2.git'
+
+    - name: Install Pupil_LIMlab
       run: |
-        pip install "numpy<2" pytest matplotlib pandas scipy
         pip install -e .
-        
+
     - name: Run Pytest
       run: pytest
 
-    
-
   build-n-publish:
     name: Build and publish to PyPI
     needs: test
@@ -33,23 +49,23 @@ jobs:
       name: pypi
       url: https://pypi.org/p/Pupil_LIMlab
     permissions:
-      id-token: write
+      id-token: write  # Required for Trusted Publishing
       contents: read
 
     steps:
     - uses: actions/checkout@v4
+    
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
         python-version: "3.10"
-        cache: "pip"
 
     - name: Install build tool
       run: pip install build
 
     - name: Build binary
       run: |
-        rm -rf dist/   # Force delete any existing dist folder
+        rm -rf dist/
         python -m build
 
     - name: Publish to PyPI

PupilSense/__pycache__/inference_pupil_sense.cpython-310.pyc

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Pupil_LIMlab
-Version: 1.0.5.4
+Version: 1.0.5.6
 Summary: A pupil analysis and inference toolkit
 Author-email: Dammy <a.aonih@ucl.ac.uk>
 Requires-Python: >=3.10
@@ -25,7 +25,6 @@ Requires-Dist: pycocotools
 Requires-Dist: python-dotenv
 Requires-Dist: imageio[ffmpeg]
 Requires-Dist: scikit-learn
-Requires-Dist: pyav
 Dynamic: license-file
 
 # PupilToolKit
@@ -68,6 +67,41 @@ python -m venv .venv
 pip install -e .
 ```
 
+## Installation
+
+Recommended: create and activate a virtual environment (conda or venv) before installing packages.
+
+- **PyTorch & TorchVision (CUDA 12.1)** — install the CUDA 12.1 builds of PyTorch 2.2 and TorchVision 0.17.0:
+
+```bash
+pip install torch==2.2.0+cu121 torchvision==0.17.0+cu121 -f https://download.pytorch.org/whl/torch_stable.html
+```
+
+If you do not have CUDA 12.1 or need a CPU-only build, install the matching CPU/compatible wheel instead (omit `+cu121` or follow the official PyTorch install selector at https://pytorch.org).
+
+- **Detectron2** — platform-specific instructions:
+
+- Windows (pre-built wheels):
+
+```bash
+pip install detectron2 --extra-index-url https://myhloli.github.io/wheels/
+```
+
+- Linux (install from upstream):
+
+```bash
+pip install git+https://github.com/facebookresearch/detectron2.git
+```
+
+- **PupilLIMlab package** — install the project package from PyPI (or your registry):
+
+```bash
+pip install PupilLIMlabSWC
+```
+
+After these steps you should be able to run the example scripts and the PupilSense inference tools.
+
+
 ## Quick start
 
 Run the example script:

Pupil_LIMlab.egg-info/PKG-INFO

@@ -9,6 +9,182 @@ PupilProcessing/utils.py
 PupilSense/__init__.py
 PupilSense/extract_pupil_pupil_sense.py
 PupilSense/inference_pupil_sense.py
+PupilSense/detectron2/__init__.py
+PupilSense/detectron2/checkpoint/__init__.py
+PupilSense/detectron2/checkpoint/c2_model_loading.py
+PupilSense/detectron2/checkpoint/catalog.py
+PupilSense/detectron2/checkpoint/detection_checkpoint.py
+PupilSense/detectron2/config/__init__.py
+PupilSense/detectron2/config/compat.py
+PupilSense/detectron2/config/config.py
+PupilSense/detectron2/config/defaults.py
+PupilSense/detectron2/config/instantiate.py
+PupilSense/detectron2/config/lazy.py
+PupilSense/detectron2/data/__init__.py
+PupilSense/detectron2/data/benchmark.py
+PupilSense/detectron2/data/build.py
+PupilSense/detectron2/data/catalog.py
+PupilSense/detectron2/data/common.py
+PupilSense/detectron2/data/dataset_mapper.py
+PupilSense/detectron2/data/detection_utils.py
+PupilSense/detectron2/data/datasets/__init__.py
+PupilSense/detectron2/data/datasets/builtin.py
+PupilSense/detectron2/data/datasets/builtin_meta.py
+PupilSense/detectron2/data/datasets/cityscapes.py
+PupilSense/detectron2/data/datasets/cityscapes_panoptic.py
+PupilSense/detectron2/data/datasets/coco.py
+PupilSense/detectron2/data/datasets/coco_panoptic.py
+PupilSense/detectron2/data/datasets/lvis.py
+PupilSense/detectron2/data/datasets/lvis_v0_5_categories.py
+PupilSense/detectron2/data/datasets/lvis_v1_categories.py
+PupilSense/detectron2/data/datasets/lvis_v1_category_image_count.py
+PupilSense/detectron2/data/datasets/pascal_voc.py
+PupilSense/detectron2/data/datasets/register_coco.py
+PupilSense/detectron2/data/samplers/__init__.py
+PupilSense/detectron2/data/samplers/distributed_sampler.py
+PupilSense/detectron2/data/samplers/grouped_batch_sampler.py
+PupilSense/detectron2/data/transforms/__init__.py
+PupilSense/detectron2/data/transforms/augmentation.py
+PupilSense/detectron2/data/transforms/augmentation_impl.py
+PupilSense/detectron2/data/transforms/transform.py
+PupilSense/detectron2/engine/__init__.py
+PupilSense/detectron2/engine/defaults.py
+PupilSense/detectron2/engine/hooks.py
+PupilSense/detectron2/engine/launch.py
+PupilSense/detectron2/engine/train_loop.py
+PupilSense/detectron2/evaluation/__init__.py
+PupilSense/detectron2/evaluation/cityscapes_evaluation.py
+PupilSense/detectron2/evaluation/coco_evaluation.py
+PupilSense/detectron2/evaluation/evaluator.py
+PupilSense/detectron2/evaluation/fast_eval_api.py
+PupilSense/detectron2/evaluation/lvis_evaluation.py
+PupilSense/detectron2/evaluation/panoptic_evaluation.py
+PupilSense/detectron2/evaluation/pascal_voc_evaluation.py
+PupilSense/detectron2/evaluation/rotated_coco_evaluation.py
+PupilSense/detectron2/evaluation/sem_seg_evaluation.py
+PupilSense/detectron2/evaluation/testing.py
+PupilSense/detectron2/export/__init__.py
+PupilSense/detectron2/export/api.py
+PupilSense/detectron2/export/c10.py
+PupilSense/detectron2/export/caffe2_export.py
+PupilSense/detectron2/export/caffe2_inference.py
+PupilSense/detectron2/export/caffe2_modeling.py
+PupilSense/detectron2/export/caffe2_patch.py
+PupilSense/detectron2/export/flatten.py
+PupilSense/detectron2/export/shared.py
+PupilSense/detectron2/export/torchscript.py
+PupilSense/detectron2/export/torchscript_patch.py
+PupilSense/detectron2/layers/__init__.py
+PupilSense/detectron2/layers/aspp.py
+PupilSense/detectron2/layers/batch_norm.py
+PupilSense/detectron2/layers/blocks.py
+PupilSense/detectron2/layers/deform_conv.py
+PupilSense/detectron2/layers/losses.py
+PupilSense/detectron2/layers/mask_ops.py
+PupilSense/detectron2/layers/nms.py
+PupilSense/detectron2/layers/roi_align.py
+PupilSense/detectron2/layers/roi_align_rotated.py
+PupilSense/detectron2/layers/rotated_boxes.py
+PupilSense/detectron2/layers/shape_spec.py
+PupilSense/detectron2/layers/wrappers.py
+PupilSense/detectron2/model_zoo/__init__.py
+PupilSense/detectron2/model_zoo/model_zoo.py
+PupilSense/detectron2/modeling/__init__.py
+PupilSense/detectron2/modeling/anchor_generator.py
+PupilSense/detectron2/modeling/box_regression.py
+PupilSense/detectron2/modeling/matcher.py
+PupilSense/detectron2/modeling/mmdet_wrapper.py
+PupilSense/detectron2/modeling/poolers.py
+PupilSense/detectron2/modeling/postprocessing.py
+PupilSense/detectron2/modeling/sampling.py
+PupilSense/detectron2/modeling/test_time_augmentation.py
+PupilSense/detectron2/modeling/backbone/__init__.py
+PupilSense/detectron2/modeling/backbone/backbone.py
+PupilSense/detectron2/modeling/backbone/build.py
+PupilSense/detectron2/modeling/backbone/fpn.py
+PupilSense/detectron2/modeling/backbone/mvit.py
+PupilSense/detectron2/modeling/backbone/regnet.py
+PupilSense/detectron2/modeling/backbone/resnet.py
+PupilSense/detectron2/modeling/backbone/swin.py
+PupilSense/detectron2/modeling/backbone/utils.py
+PupilSense/detectron2/modeling/backbone/vit.py
+PupilSense/detectron2/modeling/meta_arch/__init__.py
+PupilSense/detectron2/modeling/meta_arch/build.py
+PupilSense/detectron2/modeling/meta_arch/dense_detector.py
+PupilSense/detectron2/modeling/meta_arch/fcos.py
+PupilSense/detectron2/modeling/meta_arch/panoptic_fpn.py
+PupilSense/detectron2/modeling/meta_arch/rcnn.py
+PupilSense/detectron2/modeling/meta_arch/retinanet.py
+PupilSense/detectron2/modeling/meta_arch/semantic_seg.py
+PupilSense/detectron2/modeling/proposal_generator/__init__.py
+PupilSense/detectron2/modeling/proposal_generator/build.py
+PupilSense/detectron2/modeling/proposal_generator/proposal_utils.py
+PupilSense/detectron2/modeling/proposal_generator/rpn.py
+PupilSense/detectron2/modeling/proposal_generator/rrpn.py
+PupilSense/detectron2/modeling/roi_heads/__init__.py
+PupilSense/detectron2/modeling/roi_heads/box_head.py
+PupilSense/detectron2/modeling/roi_heads/cascade_rcnn.py
+PupilSense/detectron2/modeling/roi_heads/fast_rcnn.py
+PupilSense/detectron2/modeling/roi_heads/keypoint_head.py
+PupilSense/detectron2/modeling/roi_heads/mask_head.py
+PupilSense/detectron2/modeling/roi_heads/roi_heads.py
+PupilSense/detectron2/modeling/roi_heads/rotated_fast_rcnn.py
+PupilSense/detectron2/projects/__init__.py
+PupilSense/detectron2/projects/deeplab/__init__.py
+PupilSense/detectron2/projects/deeplab/build_solver.py
+PupilSense/detectron2/projects/deeplab/config.py
+PupilSense/detectron2/projects/deeplab/loss.py
+PupilSense/detectron2/projects/deeplab/lr_scheduler.py
+PupilSense/detectron2/projects/deeplab/resnet.py
+PupilSense/detectron2/projects/deeplab/semantic_seg.py
+PupilSense/detectron2/projects/panoptic_deeplab/__init__.py
+PupilSense/detectron2/projects/panoptic_deeplab/config.py
+PupilSense/detectron2/projects/panoptic_deeplab/dataset_mapper.py
+PupilSense/detectron2/projects/panoptic_deeplab/panoptic_seg.py
+PupilSense/detectron2/projects/panoptic_deeplab/post_processing.py
+PupilSense/detectron2/projects/panoptic_deeplab/target_generator.py
+PupilSense/detectron2/projects/point_rend/__init__.py
+PupilSense/detectron2/projects/point_rend/color_augmentation.py
+PupilSense/detectron2/projects/point_rend/config.py
+PupilSense/detectron2/projects/point_rend/mask_head.py
+PupilSense/detectron2/projects/point_rend/point_features.py
+PupilSense/detectron2/projects/point_rend/point_head.py
+PupilSense/detectron2/projects/point_rend/roi_heads.py
+PupilSense/detectron2/projects/point_rend/semantic_seg.py
+PupilSense/detectron2/solver/__init__.py
+PupilSense/detectron2/solver/build.py
+PupilSense/detectron2/solver/lr_scheduler.py
+PupilSense/detectron2/structures/__init__.py
+PupilSense/detectron2/structures/boxes.py
+PupilSense/detectron2/structures/image_list.py
+PupilSense/detectron2/structures/instances.py
+PupilSense/detectron2/structures/keypoints.py
+PupilSense/detectron2/structures/masks.py
+PupilSense/detectron2/structures/rotated_boxes.py
+PupilSense/detectron2/tracking/__init__.py
+PupilSense/detectron2/tracking/base_tracker.py
+PupilSense/detectron2/tracking/bbox_iou_tracker.py
+PupilSense/detectron2/tracking/hungarian_tracker.py
+PupilSense/detectron2/tracking/iou_weighted_hungarian_bbox_iou_tracker.py
+PupilSense/detectron2/tracking/utils.py
+PupilSense/detectron2/tracking/vanilla_hungarian_bbox_iou_tracker.py
+PupilSense/detectron2/utils/__init__.py
+PupilSense/detectron2/utils/analysis.py
+PupilSense/detectron2/utils/collect_env.py
+PupilSense/detectron2/utils/colormap.py
+PupilSense/detectron2/utils/comm.py
+PupilSense/detectron2/utils/develop.py
+PupilSense/detectron2/utils/env.py
+PupilSense/detectron2/utils/events.py
+PupilSense/detectron2/utils/file_io.py
+PupilSense/detectron2/utils/logger.py
+PupilSense/detectron2/utils/memory.py
+PupilSense/detectron2/utils/registry.py
+PupilSense/detectron2/utils/serialize.py
+PupilSense/detectron2/utils/testing.py
+PupilSense/detectron2/utils/tracing.py
+PupilSense/detectron2/utils/video_visualizer.py
+PupilSense/detectron2/utils/visualizer.py
 Pupil_LIMlab.egg-info/PKG-INFO
 Pupil_LIMlab.egg-info/SOURCES.txt
 Pupil_LIMlab.egg-info/dependency_links.txt

Pupil_LIMlab.egg-info/SOURCES.txt

@@ -17,4 +17,3 @@ pycocotools
 python-dotenv
 imageio[ffmpeg]
 scikit-learn
-pyav

Pupil_LIMlab.egg-info/requires.txt

@@ -38,6 +38,41 @@ python -m venv .venv
 pip install -e .
 ```
 
+## Installation
+
+Recommended: create and activate a virtual environment (conda or venv) before installing packages.
+
+- **PyTorch & TorchVision (CUDA 12.1)** — install the CUDA 12.1 builds of PyTorch 2.2 and TorchVision 0.17.0:
+
+```bash
+pip install torch==2.2.0+cu121 torchvision==0.17.0+cu121 -f https://download.pytorch.org/whl/torch_stable.html
+```
+
+If you do not have CUDA 12.1 or need a CPU-only build, install the matching CPU/compatible wheel instead (omit `+cu121` or follow the official PyTorch install selector at https://pytorch.org).
+
+- **Detectron2** — platform-specific instructions:
+
+- Windows (pre-built wheels):
+
+```bash
+pip install detectron2 --extra-index-url https://myhloli.github.io/wheels/
+```
+
+- Linux (install from upstream):
+
+```bash
+pip install git+https://github.com/facebookresearch/detectron2.git
+```
+
+- **PupilLIMlab package** — install the project package from PyPI (or your registry):
+
+```bash
+pip install PupilLIMlabSWC
+```
+
+After these steps you should be able to run the example scripts and the PupilSense inference tools.
+
+
 ## Quick start
 
 Run the example script:

README.md

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "Pupil_LIMlab" # Must be unique on PyPI
-version = "1.0.5.6"
+version = "1.0.5.7"
 description = "A pupil analysis and inference toolkit"
 readme = "README.md"
 authors = [{name = "Dammy", email = "a.aonih@ucl.ac.uk"}]