Merge pull request #1 from teobucci/refactor-class

Refactor the library to work with classes

.github/workflows/tests.yaml

@@ -0,0 +1,29 @@
+name: Python Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ".[dev]"
+    - name: Run pytest
+      run: |
+        pytest

README.md

@@ -6,6 +6,8 @@
 
 This repository implements a causal feature selection algorithm based on transfer entropy. The algorithm is described in: Bonetti, P., Metelli, A. M., & Restelli, M. (2023, October 17). Causal Feature Selection via Transfer Entropy. (https://arxiv.org/abs/2310.11059).
 
+Requires Python 3.9 or later.
+
 ## Installation
 
 The package can be installed using pip:

src/tefs/__init__.py

@@ -1,5 +1,3 @@
-from .core import fs
-from .plotting import plot_te_results
-from .utils import select_features, select_n_features
+from .core import TEFS
 
 __version__ = "0.1.0"