Add GitHub Action for automatic Python file header validation

.github/workflows/README.md

@@ -0,0 +1,43 @@
+# GitHub Actions Workflows
+
+This directory contains GitHub Actions workflows for automated checks and builds.
+
+## Available Workflows
+
+### Build (`build.yaml`)
+Builds and tests the package on multiple platforms (Ubuntu and Windows) with Python 3.10 and PyTorch 2.4.0.
+
+**Triggers:** Push and Pull Requests to `main` branch
+
+### Codespell (`codespell.yml`)
+Checks for spelling errors in the codebase using codespell.
+
+**Triggers:** Push and Pull Requests to `main` branch
+
+### Check File Headers (`check-headers.yml`)
+Ensures all Python files have the proper FMPose3D header with Apache 2.0 license information.
+
+**Triggers:** Push and Pull Requests to `main` branch
+
+**How it works:**
+- Runs `scripts/update_headers.py --check` to verify headers
+- Fails if any Python files are missing proper headers
+- To fix locally, run: `python scripts/update_headers.py` and commit the changes
+
+## Running Header Checks Locally
+
+Before submitting a pull request, you can check and fix headers locally:
+
+```bash
+# Check if all files have proper headers
+python scripts/update_headers.py --check
+
+# Add/update headers to files that need them
+python scripts/update_headers.py
+```
+
+The script will:
+- Add the standard FMPose3D header to Python files that don't have one
+- Replace old header formats with the current standard
+- Preserve shebangs (#!) and `from __future__` imports at the top of files
+- Skip `__init__.py` files that are very short

.github/workflows/check-headers.yml

@@ -0,0 +1,36 @@
+---
+name: Check File Headers
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  check-headers:
+    name: Check Python file headers
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Check headers
+        run: |
+          python scripts/update_headers.py --check
+        continue-on-error: false
+
+      - name: Provide fix instructions
+        if: failure()
+        run: |
+          echo "::error::Some files are missing proper headers."
+          echo "To fix this, run: python scripts/update_headers.py"
+          echo "Then commit the changes."

animals/demo/vis_animals.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 # SuperAnimal Demo: https://github.com/DeepLabCut/DeepLabCut/blob/main/examples/COLAB/COLAB_YOURDATA_SuperAnimal.ipynb
 import sys
 import os

animals/models/model_animals.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import math
 from functools import partial
 

animals/scripts/main_animal3d.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import os
 import torch
 import random

demo/vis_in_the_wild.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import sys
 import cv2
 import os 

fmpose/aggregation_methods.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import torch
 from fmpose.common.utils import project_to_2d
 

fmpose/animals/__init__.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 """
 Animal-specific components for FMPose.
 """

fmpose/animals/common/__init__.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 """
 Shared utilities for animal datasets and models.
 """

fmpose/animals/common/animal3d_dataset.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import json
 
 import numpy as np

fmpose/animals/common/animal_visualization.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import os
 
 import cv2

fmpose/animals/common/arber_dataset.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import copy
 import gc
 import glob

fmpose/animals/common/arguments.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import argparse
 import math
 

fmpose/animals/common/camera.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import sys
 
 import numpy as np

fmpose/animals/common/graph_utils.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 from __future__ import absolute_import
 
 import numpy as np

fmpose/animals/common/lifter3d.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import glob
 
 import cv2

fmpose/animals/common/mocap_dataset.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 class MocapDataset:
     def __init__(self, fps, skeleton):
         self._skeleton = skeleton

fmpose/animals/common/skeleton.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import numpy as np
 
 

fmpose/animals/common/utils.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import glob
 import hashlib
 import json

fmpose/animals/models/__init__.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 """
 FMPose models.
 """

fmpose/animals/models/graph_frames.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import numpy as np
 
 class Graph():

fmpose/animals/models/model_animal3d.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import math
 from functools import partial
 

fmpose/common/__init__.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 """
 Common utilities for FMPose.
 """

fmpose/common/arguments.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import argparse
 import math
 

fmpose/common/camera.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import sys
 
 import numpy as np

fmpose/common/generator.py

@@ -1,3 +1,12 @@
+"""
+FMPose3D: monocular 3D Pose Estimation via Flow Matching
+
+Official implementation of the paper:
+"FMPose3D: monocular 3D Pose Estimation via Flow Matching"
+by Ti Wang, Xiaohang Yu, and Mackenzie Weygandt Mathis
+Licensed under Apache 2.0
+"""
+
 import numpy as np