Merge pull request #62 from MTG/improve_packaging

Several packaging improvements:
- crate omar_rq package
- set more flexible deps
- fix tests by clearing cache after testing each model
- extend tests to multiple Python versions
- Add PyPI classifiers and other metadata

Author: palonso

.github/workflows/python-tests.yml

@@ -9,16 +9,20 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
+    - uses: actions/checkout@v5
+    - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
+        python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install .[dev]
+        pip cache purge
     - name: Run tests
       run: pytest

pyproject.toml

@@ -1,31 +1,69 @@
 [project]
-version = "0.1"
+version = "0.2.0"
 name = "omar-rq"
+description = "Wrapper library to use the OMAR-RQ models for audio music representation"
+readme = "README.md"
+license = { text = "AGPL-3.0 license" }
+authors = [
+  { name = "Pablo Alonso", email = "pablo.alonso@upf.edu" },
+  { name = "Pedro Ramoneda", email = "pedro.ramoneda@upf.edu" },
+  { name = "R. Oguz Araz", email = "recepoguz.araz@upf.edu" },
+]
+keywords = [
+  "deep learning",
+  "audio",
+  "transformers",
+  "mir",
+  "music",
+  "representation learning",
+  "self-supervised learning",
+]
+
+classifiers = [
+"Intended Audience :: Developers",
+"Intended Audience :: Science/Research",
+
+"License License :: OSI Approved :: AGPL-3.0 license",
+
+"Topic :: Scientific/Engineering :: Artificial Intelligence",
+"Topic :: Software Development :: Libraries",
+"Topic :: Multimedia :: Sound/Audio :: Analysis",
+
+"Programming Language :: Python :: 3",
+"Programming Language :: Python :: 3.10",
+"Programming Language :: Python :: 3.11",
+"Programming Language :: Python :: 3.12",
+"Programming Language :: Python :: 3.13",
+]
+
+
 
 requires-python = ">= 3.10"
 
 dependencies = [
-    "lightning==2.3",
-    "torch==2.6",
-    "torchaudio==2.6",
-    "gin-config~=0.5",
-    "einops",
-    "transformers"
+  "lightning>=2.3,<3.0",
+  "torch>=2.6,<3.0",
+  "torchaudio>=2.6,<3.0",
+  "gin-config>=0.5,<1.0",
+  "einops>=0.8,<1.0",
+  "transformers>=4.50,<5.0",
 ]
 
 [project.optional-dependencies]
-dev = [
-    "ruff",
-    "pytest",
-]
+dev = ["ruff~=0.14", "pytest"]
+
 train = [
-    "bayesian_optimization~=1.5.1",
-    "matplotlib",
-    "scikit_learn~=1.5.2",
-    "scipy~=1.14.1",
-    "wandb",
+  "bayesian_optimization~=1.5.1",
+  "matplotlib",
+  "scikit_learn~=1.5.2",
+  "scipy~=1.14.1",
+  "wandb",
 ]
 
+[project.urls]
+Issues = "https://https://github.com/MTG/omar-rq/issues/"
+Homepage = "https://github.com/username/omar-rq/"
+
 [build-system]
-requires = ["setuptools>=61.0", "wheel"]
+requires = ["setuptools>=65.5.0", "wheel"]
 build-backend = "setuptools.build_meta"

src/modules_clap/clap.py

@@ -0,0 +1,3 @@
+from .get_model import get_model
+
+__all__ = ["get_model"]

src/omar_rq/__init__.py

@@ -7,7 +7,7 @@
 
 import gin.torch
 
-from nets.transformer import Transformer
+from .nets.transformer import Transformer
 
 
 class GinConfigSaverCallback(Callback):

src/callbacks.py src/omar_rq/callbacks.pysrc/callbacks.py renamed to src/omar_rq/callbacks.py

@@ -9,10 +9,10 @@
 import pytorch_lightning as L
 from tqdm import tqdm
 
-from data import DATASETS
-from modules import MODULES
-from nets import NETS
-from utils import build_module, build_dev_datamodule
+from .data import DATASETS
+from .modules import MODULES
+from .nets import NETS
+from .utils import build_module, build_dev_datamodule
 
 
 for net_name, net in NETS.items():