Make pip installable

hmgmetrics/__init__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+"""
+hmgmetrics
+------------
+
+Human Motion Generation Metrics
+Unifyied framework for human motion generation evaluation metrics. _[1]
+
+[1]: A. Ismail-Fawaz, M. Devanne, S. Berretti, J. Weber, and G. Forestier,
+ “Establishing a Unified Evaluation Framework for Human Motion Generation:
+ A Comparative Analysis of Metrics,” May 13, 2024, arXiv: arXiv:2405.07680.
+ Accessed: May 16, 2024. [Online]. Available: http://arxiv.org/abs/2405.07680
+
+
+:copyright: (c) 2024 by Cognitive Systems Lab.
+:license: MIT
+"""
+# Imports
+
+# built-in
+
+# local
+from .__version__ import __version__  # noqa: F401
+
+# 3rd-party

hmgmetrics/__version__.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+"""
+metrics.__version__
+-------------------
+
+Version tracker.
+
+:copyright: (c) 2024 by Cognitive Systems Lab.
+:license: MIT
+"""
+# Imports
+
+# built-in
+
+# local
+
+# 3rd-party
+
+# CSL
+
+
+__VERSION__ = (1, 0, 0)
+
+__version__ = '.'.join(map(str, __VERSION__))

hmgmetrics/diversity/__init__.py

@@ -0,0 +1,5 @@
+from hmgmetrics.diversity._apd import APD
+from hmgmetrics.diversity._acpd import ACPD
+from hmgmetrics.diversity._coverage import COVERAGE
+from hmgmetrics.diversity._wpd import WPD
+from hmgmetrics.diversity._mms import MMS

metrics/diversity/_acpd.py → hmgmetrics/diversity/_acpd.py

@@ -2,7 +2,7 @@
 import numpy as np
 import tensorflow as tf
 
-from metrics.base import BaseMetricCalculator
+from hmgmetrics.base import BaseMetricCalculator
 
 
 class ACPD(BaseMetricCalculator):

metrics/diversity/_apd.py → hmgmetrics/diversity/_apd.py

@@ -2,7 +2,7 @@
 import numpy as np
 import tensorflow as tf
 
-from metrics.base import BaseMetricCalculator
+from hmgmetrics.base import BaseMetricCalculator
 
 
 class APD(BaseMetricCalculator):

metrics/diversity/_coverage.py → hmgmetrics/diversity/_coverage.py

@@ -16,7 +16,7 @@
 from sklearn.metrics import pairwise_distances
 from sklearn.model_selection import train_test_split
 
-from metrics.base import BaseMetricCalculator
+from hmgmetrics.base import BaseMetricCalculator
 
 
 class COVERAGE(BaseMetricCalculator):

metrics/diversity/_mms.py → hmgmetrics/diversity/_mms.py

@@ -2,7 +2,7 @@
 import numpy as np
 import tensorflow as tf
 
-from metrics.base import BaseMetricCalculator
+from hmgmetrics.base import BaseMetricCalculator
 
 from sklearn.neighbors import NearestNeighbors
 

metrics/diversity/_wpd.py → hmgmetrics/diversity/_wpd.py

@@ -3,7 +3,7 @@
 import tensorflow as tf
 
 from aeon.distances import dtw_alignment_path
-from metrics.base import BaseMetricCalculator
+from hmgmetrics.base import BaseMetricCalculator
 
 
 class WPD(BaseMetricCalculator):

metric_calculator.py → hmgmetrics/metric_calculator.py

@@ -1,8 +1,8 @@
 import pandas as pd
 from typing import *
 
-from metrics.quality import FID, DENSITY, AOG
-from metrics.diversity import APD, ACPD, COVERAGE, WPD, MMS
+from hmgmetrics.quality import FID, DENSITY, AOG
+from hmgmetrics.diversity import APD, ACPD, COVERAGE, WPD, MMS
 
 
 class METRIC_CALCULATOR:

hmgmetrics/quality/__init__.py

@@ -0,0 +1,3 @@
+from hmgmetrics.quality._fid import FID
+from hmgmetrics.quality._density import DENSITY
+from hmgmetrics.quality._aog import AOG

metrics/quality/_aog.py → hmgmetrics/quality/_aog.py

@@ -4,7 +4,7 @@
 
 from sklearn.metrics import accuracy_score
 
-from metrics.base import BaseMetricCalculator
+from hmgmetrics.base import BaseMetricCalculator
 
 
 class AOG(BaseMetricCalculator):

metrics/quality/_density.py → hmgmetrics/quality/_density.py

@@ -16,7 +16,7 @@
 from sklearn.metrics import pairwise_distances
 from sklearn.model_selection import train_test_split
 
-from metrics.base import BaseMetricCalculator
+from hmgmetrics.base import BaseMetricCalculator
 
 
 class DENSITY(BaseMetricCalculator):

metrics/quality/_fid.py → hmgmetrics/quality/_fid.py

@@ -3,7 +3,7 @@
 import tensorflow as tf
 from scipy.linalg import sqrtm
 
-from metrics.base import BaseMetricCalculator
+from hmgmetrics.base import BaseMetricCalculator
 from sklearn.model_selection import train_test_split
 
 

pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["setuptools >= 64.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hmgmetrics"
+description = "Unified framework for Human Motion Generation Evaluation."
+readme = "README.md"
+license = {file = "LICENSE"}
+keywords = ["human motion generation", "metrics"]
+dynamic = ['version']
+dependencies = [
+    "aeon~=0.8.1",
+    "numpy~=1.26.4",
+    "pandas~=2.0.3",
+    "tensorflow~=2.16.1",
+    "scikit-learn~=1.4.2",
+]
+requires-python = ">= 3.8"
+authors = [
+    {name = "Ali Ismail-Fawaz", email = "[email protected]"},
+    {name = "Maxime Devanne"},
+    {name = "Stefano Berreti"},
+    {name = "Jonathan Weber"},
+    {name = "Germain Forestier"}
+]
+maintainers = [
+    {name = "Lourenco Abrunhosa Rodrigues", email = "[email protected]"}
+]
+classifiers = [
+    "Development Status :: 5",
+    "Intended Audience :: Researchers",
+    "Topic :: Data Generation :: Evaluation Metrics",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+
+
+[project.optional-dependencies]
+plot = ["matplotlib~=3.8.4"]
+
+[tool.setuptools]
+packages = ["hmgmetrics"]
+
+[tool.setuptools.dynamic]
+version = {attr = "hmgmetrics.__version__"}