Datasets core

.github/workflows/python-linting.yml

@@ -11,12 +11,10 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.10'
-      - name: Install Mypy
-        run: pip install mypy
       - name: Install dependencies
         run: |
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-          pip install ".[test]"
+          pip install ".[type, test]"
       - name: Run Mypy
         uses: liskin/gh-problem-matcher-wrap@v2 # wrap mypy output as annotations
         with:   

cpmpy/tools/__init__.py

@@ -10,6 +10,7 @@
 
     explain
     dimacs
+    datasets
     maximal_propagate
     tune_solver
     xcsp3

cpmpy/tools/datasets/__init__.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+# -*- coding:utf-8 -*-
+##
+## __init__.py
+##
+"""
+PyTorch-style dataset interface for Constraint Optimisation (CO) benchmarks.
+
+CPMpy provides a PyTorch-style dataset interface for loading and iterating over
+benchmark instance collections. Each dataset handles downloading, file discovery,
+metadata collection, and decompression automatically.
+
+===============
+List of classes
+===============
+
+.. autosummary::
+    :nosignatures:
+
+    Dataset
+    FileDataset
+
+================
+List of datasets
+================
+
+.. autosummary::
+    :nosignatures:
+
+    XCSP3Dataset
+"""
+
+from .core import (
+    Dataset,
+    FileDataset,
+)
+from .xcsp3 import XCSP3Dataset
+
+
+__all__ = [
+    # Base
+    "Dataset",
+    "FileDataset",
+    # Datasets
+    "XCSP3Dataset",
+]
+