moose-fs 0.1.0__py3-none-any.whl

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CI4CB-lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,190 @@
+# MOOSE-FS
+
+[![tests](https://github.com/CI4CB-lab/moosefs/actions/workflows/tests.yml/badge.svg)](https://github.com/CI4CB-lab/moosefs/actions/workflows/tests.yml)
+[Documentation](https://CI4CB-lab.github.io/moosefs/)
+
+## Overview
+
+MOOSE-FS is a feature selection library that leverages an ensemble-based approach to optimize both predictive performance and stability. By combining multiple feature selection methods, merging strategies, and evaluation metrics, it provides a highly flexible and tunable pipeline for both classification and regression tasks. The package automates feature selection across multiple iterations and uses Pareto optimization to identify the best feature subsets.
+
+Users can define their feature selection process by:
+- Selecting feature selection methods from predefined options or implementing custom ones.
+- Choosing merging strategies to aggregate feature rankings.
+- Specifying performance metrics to evaluate selected features.
+- Configuring the number of features to select and the number of repetitions.
+- Working with either **classification** or **regression** problems.
+
+The library allows defining feature selectors, merging strategies, and metrics either as **class instances** or as **string identifiers**, which act as placeholders for built-in methods. The framework is modular and can be easily extended by adding new selection algorithms or merging strategies.
+
+---
+
+## Requirements
+
+- **Python** 3.9 or higher
+- **Dependencies**: Automatically installed from `pyproject.toml`.
+
+---
+
+## Installation
+
+### From Source
+
+To install the package from source, run:
+
+```bash
+pip install git+https://github.com/CI4CB-lab/moosefs.git
+```
+
+Alternatively, clone the repository and install locally:
+
+```bash
+git clone https://github.com/CI4CB-lab/moosefs.git
+cd moosefs
+pip install .
+```
+
+---
+
+## Using the Library
+
+### 1. Feature Selection Pipeline
+
+The core of MOOSE-FS is the `FeatureSelectionPipeline`, which provides a fully configurable workflow for feature selection. Users can specify:
+- Feature selection methods
+- Merging strategy
+- Evaluation metrics
+- Task type (classification or regression)
+- Number of features to select
+- Number of repetitions
+
+#### Example Usage
+
+```python
+# `data` can be a single DataFrame (last column = target)
+# or you can pass `X` and `y` separately.
+# Assume `data` is a pandas DataFrame whose last column "label" holds the targets.
+from moosefs import FeatureSelectionPipeline
+
+fs_methods = ["f_statistic_selector", "random_forest_selector", "svm_selector"]
+merging_strategy = "union_of_intersections_merger"
+
+pipeline = FeatureSelectionPipeline(
+    X=data.drop(columns=["label"]),
+    y=data["label"],
+    fs_methods=fs_methods,
+    merging_strategy=merging_strategy,
+    num_repeats=5,
+    task="classification",
+    num_features_to_select=10,
+)
+results = pipeline.run()
+```
+
+This will run feature selection, merge results using the chosen strategy, and return the best-selected features.
+
+### 2. Extensibility
+
+MOOSE-FS is designed to be easily extended. Users can implement custom:
+- **Feature selection methods**: Define a new feature selector class and integrate it into the pipeline.
+- **Merging strategies**: Implement a custom strategy to aggregate selected features.
+- **Metrics**: Add new evaluation metrics tailored to specific tasks.
+
+New methods can be used directly in the pipeline by passing the class or a corresponding identifier.
+
+---
+
+## Using the CLI
+
+Once installed, the pipeline can also be run from the command line using:
+
+```bash
+efs-pipeline
+```
+
+This command executes `scripts/main.py` using parameters from `scripts/config.yaml`. Users can specify a different config file:
+
+```bash
+efs-pipeline path/to/your_config.yaml
+```
+
+### Example `config.yaml`
+
+```yaml
+experiment:
+  name: "example_experiment"
+  results_path: "results/"
+  data_path: "data/input_data.csv"
+
+preprocessing:
+  normalize: true
+  handle_missing: true
+
+pipeline:
+  fs_methods: ["f_statistic_selector", "random_forest_selector"]
+  merging_strategy: "union_of_intersections_merger"
+  num_repeats: 5
+  task: "classification"
+  num_features_to_select: 10
+```
+
+### Results
+
+The results are saved in a structured directory under `results/example_experiment/`, including:
+- A **text file** summarizing the pipeline run.
+- A **CSV file** containing the final results.
+
+---
+
+## Code Structure
+
+- **`core/`**: Core modules for data processing, metrics, and stability computation.
+- **`feature_selection_pipeline.py`**: Defines the main feature selection workflow.
+- **`feature_selectors/`**: Implements feature selection methods (e.g., F-statistic, mutual information, RandomForest, SVM).
+- **`merging_strategies/`**: Implements merging strategies such as Borda count and union of intersections.
+
+---
+
+## Contributing
+
+Contributions are welcome! If you have ideas for improving MOOSE-FS, feel free to open an issue or submit a pull request.
+
+### Development (uv)
+
+This project uses uv for local environments and dependency management. The library builds via the existing PEP 517 backend (hatchling); uv only manages the environment, installs, and command execution.
+
+- Install/select Python 3.9+ and ensure `uv` is installed.
+- Create a local virtual environment in `.venv`:
+
+```bash
+uv venv --python 3.9
+```
+
+- Install dev dependencies (editable):
+
+```bash
+uv pip install -e ".[dev]"
+```
+
+- Install pre-commit hooks:
+
+```bash
+uv run pre-commit install
+```
+
+- Run formatting and linting:
+
+```bash
+uv run ruff format .
+uv run ruff check --fix .
+```
+
+- Run tests:
+
+```bash
+uv run pytest -q
+```
+---
+
+## License
+
+This project is licensed under the MIT License.

moose_fs-0.1.0.dist-info/METADATA

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: moose-fs
+Version: 0.1.0
+Summary: MOOSE-FS: Multi-Objective Optimized Ensemble Feature Selection
+Project-URL: Repository, https://github.com/CI4CB-lab/moosefs
+Project-URL: Documentation, https://CI4CB-lab.github.io/moosefs/
+Author-email: Arthur Babey <arthur.babey@heig-vd.ch>
+License: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: joblib
+Requires-Dist: mrmr-selection
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pyyaml
+Requires-Dist: ranky
+Requires-Dist: scikit-learn>=1.5.0
+Requires-Dist: scipy>=1.11
+Requires-Dist: xgboost
+Provides-Extra: dev
+Requires-Dist: build>=1; extra == 'dev'
+Requires-Dist: coverage[toml]; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff>=0.14.2; extra == 'dev'
+Requires-Dist: sphinx-autodoc-typehints; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme; extra == 'dev'
+Requires-Dist: sphinx>=7; extra == 'dev'
+Requires-Dist: twine>=5; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme; extra == 'docs'
+Requires-Dist: sphinx>=7; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: coverage[toml]; extra == 'test'
+Requires-Dist: pytest>=7; extra == 'test'
+Description-Content-Type: text/markdown
+
+# MOOSE-FS
+
+[![tests](https://github.com/CI4CB-lab/moosefs/actions/workflows/tests.yml/badge.svg)](https://github.com/CI4CB-lab/moosefs/actions/workflows/tests.yml)
+[Documentation](https://CI4CB-lab.github.io/moosefs/)
+
+## Overview
+
+MOOSE-FS is a feature selection library that leverages an ensemble-based approach to optimize both predictive performance and stability. By combining multiple feature selection methods, merging strategies, and evaluation metrics, it provides a highly flexible and tunable pipeline for both classification and regression tasks. The package automates feature selection across multiple iterations and uses Pareto optimization to identify the best feature subsets.
+
+Users can define their feature selection process by:
+- Selecting feature selection methods from predefined options or implementing custom ones.
+- Choosing merging strategies to aggregate feature rankings.
+- Specifying performance metrics to evaluate selected features.
+- Configuring the number of features to select and the number of repetitions.
+- Working with either **classification** or **regression** problems.
+
+The library allows defining feature selectors, merging strategies, and metrics either as **class instances** or as **string identifiers**, which act as placeholders for built-in methods. The framework is modular and can be easily extended by adding new selection algorithms or merging strategies.
+
+---
+
+## Requirements
+
+- **Python** 3.9 or higher
+- **Dependencies**: Automatically installed from `pyproject.toml`.
+
+---
+
+## Installation
+
+### From Source
+
+To install the package from source, run:
+
+```bash
+pip install git+https://github.com/CI4CB-lab/moosefs.git
+```
+
+Alternatively, clone the repository and install locally:
+
+```bash
+git clone https://github.com/CI4CB-lab/moosefs.git
+cd moosefs
+pip install .
+```
+
+---
+
+## Using the Library
+
+### 1. Feature Selection Pipeline
+
+The core of MOOSE-FS is the `FeatureSelectionPipeline`, which provides a fully configurable workflow for feature selection. Users can specify:
+- Feature selection methods
+- Merging strategy
+- Evaluation metrics
+- Task type (classification or regression)
+- Number of features to select
+- Number of repetitions
+
+#### Example Usage
+
+```python
+# `data` can be a single DataFrame (last column = target)
+# or you can pass `X` and `y` separately.
+# Assume `data` is a pandas DataFrame whose last column "label" holds the targets.
+from moosefs import FeatureSelectionPipeline
+
+fs_methods = ["f_statistic_selector", "random_forest_selector", "svm_selector"]
+merging_strategy = "union_of_intersections_merger"
+
+pipeline = FeatureSelectionPipeline(
+    X=data.drop(columns=["label"]),
+    y=data["label"],
+    fs_methods=fs_methods,
+    merging_strategy=merging_strategy,
+    num_repeats=5,
+    task="classification",
+    num_features_to_select=10,
+)
+results = pipeline.run()
+```
+
+This will run feature selection, merge results using the chosen strategy, and return the best-selected features.
+
+### 2. Extensibility
+
+MOOSE-FS is designed to be easily extended. Users can implement custom:
+- **Feature selection methods**: Define a new feature selector class and integrate it into the pipeline.
+- **Merging strategies**: Implement a custom strategy to aggregate selected features.
+- **Metrics**: Add new evaluation metrics tailored to specific tasks.
+
+New methods can be used directly in the pipeline by passing the class or a corresponding identifier.
+
+---
+
+## Using the CLI
+
+Once installed, the pipeline can also be run from the command line using:
+
+```bash
+efs-pipeline
+```
+
+This command executes `scripts/main.py` using parameters from `scripts/config.yaml`. Users can specify a different config file:
+
+```bash
+efs-pipeline path/to/your_config.yaml
+```
+
+### Example `config.yaml`
+
+```yaml
+experiment:
+  name: "example_experiment"
+  results_path: "results/"
+  data_path: "data/input_data.csv"
+
+preprocessing:
+  normalize: true
+  handle_missing: true
+
+pipeline:
+  fs_methods: ["f_statistic_selector", "random_forest_selector"]
+  merging_strategy: "union_of_intersections_merger"
+  num_repeats: 5
+  task: "classification"
+  num_features_to_select: 10
+```
+
+### Results
+
+The results are saved in a structured directory under `results/example_experiment/`, including:
+- A **text file** summarizing the pipeline run.
+- A **CSV file** containing the final results.
+
+---
+
+## Code Structure
+
+- **`core/`**: Core modules for data processing, metrics, and stability computation.
+- **`feature_selection_pipeline.py`**: Defines the main feature selection workflow.
+- **`feature_selectors/`**: Implements feature selection methods (e.g., F-statistic, mutual information, RandomForest, SVM).
+- **`merging_strategies/`**: Implements merging strategies such as Borda count and union of intersections.
+
+---
+
+## Contributing
+
+Contributions are welcome! If you have ideas for improving MOOSE-FS, feel free to open an issue or submit a pull request.
+
+### Development (uv)
+
+This project uses uv for local environments and dependency management. The library builds via the existing PEP 517 backend (hatchling); uv only manages the environment, installs, and command execution.
+
+- Install/select Python 3.9+ and ensure `uv` is installed.
+- Create a local virtual environment in `.venv`:
+
+```bash
+uv venv --python 3.9
+```
+
+- Install dev dependencies (editable):
+
+```bash
+uv pip install -e ".[dev]"
+```
+
+- Install pre-commit hooks:
+
+```bash
+uv run pre-commit install
+```
+
+- Run formatting and linting:
+
+```bash
+uv run ruff format .
+uv run ruff check --fix .
+```
+
+- Run tests:
+
+```bash
+uv run pytest -q
+```
+---
+
+## License
+
+This project is licensed under the MIT License.

moose_fs-0.1.0.dist-info/RECORD

@@ -0,0 +1,40 @@
+LICENSE,sha256=VKg1fUCOEkjQdpLbeqv_m0RIl5yTS985eLm_tTTy4kE,1066
+README.md,sha256=naWfqhKj3ZVku6Y9_VFhThlUD0dhOeJyETa0qmM2HKs,5623
+moosefs/__init__.py,sha256=33TiDbzwnNQWYCwDCLh_hUEKFIo5RBEa97wPj0AP29A,170
+moosefs/feature_selection_pipeline.py,sha256=Dgfqgpzi6pVuO5vT7_P8HU4vwZ1ACo3uepwkeSt0Rpk,21764
+moosefs/utils.py,sha256=kYOlCpE3YP7aapbFKoP97fqEZR-fhofncgABb6WigMQ,5104
+moosefs/core/__init__.py,sha256=pBqAqNHotvrxF7x8IWEYtiLCyUZT-5pkiBHC_HwUir8,231
+moosefs/core/data_processor.py,sha256=67O-TQiO4_n7elL8FpOLShGqW8D95whCFNollGC9hPY,12190
+moosefs/core/feature.py,sha256=h39NeGPH1_EzKGuI1eKLC-8dl8rWAtFG2D--2PhjDmk,1327
+moosefs/core/novovicova.py,sha256=eEElrdEwglEjwrp_aXU3wpYuFXBYx4eyPnYOtdQOJ00,2672
+moosefs/core/pareto.py,sha256=SxJTjkpFBRDpE3C-FYEpldagPcWlmQn_wQeaxjyZo9Q,3266
+moosefs/feature_selectors/__init__.py,sha256=r95pm5apXuCvOUpA9SqSsFmJIEmgnu8hGC35BinjRNk,819
+moosefs/feature_selectors/base_selector.py,sha256=67BQOYwEOs1dxLTmT-UAmhjNYk4s8cPvlmPM3UAtwqo,1272
+moosefs/feature_selectors/default_variance.py,sha256=7We2fYWEeh8xU_IZlAmLrAIVn3WRP8v7ryST8WCfZMo,630
+moosefs/feature_selectors/elastic_net_selector.py,sha256=0uaVaBR5467nmCSfWKlRpoGrNhz0n6_rnkj9dkHSUQM,2950
+moosefs/feature_selectors/f_statistic_selector.py,sha256=1C1fBogfAm10MpULmWluFwLMBCwwn1UhfPmTWNI_woU,1314
+moosefs/feature_selectors/lasso_selector.py,sha256=S6RwBOVeR2h-QO8l6yiL1D9PxH27eIJp7vhhDHLNv30,1361
+moosefs/feature_selectors/mrmr_selector.py,sha256=JiHKlPBdDNGThObRguIs4bjXOEzUvjLr-Mnvqbl-d30,1965
+moosefs/feature_selectors/mutual_info_selector.py,sha256=HQgyR3lXpTJOHZplrTkbSpQYqD9lD8d4G_J6_jZyGmU,1417
+moosefs/feature_selectors/random_forest_selector.py,sha256=6reBf-ea_RrTwnUhbFescovA8pLI72ap9_x90u1otr4,1490
+moosefs/feature_selectors/svm_selector.py,sha256=lxa0eoNw4mwZW2QyQb9s3ikrxRFt8-okT2e98lKjssM,1564
+moosefs/feature_selectors/variance_selectors.py,sha256=04eP2Tul7zVz_c4JwyD9nZj6_sdAdHNm9EJ40ypnO1g,520
+moosefs/feature_selectors/xgboost_selector.py,sha256=TBPWRCGxM45GCoFjpUZKMSpETQxXk0S3GCPadiZYhyg,1384
+moosefs/merging_strategies/__init__.py,sha256=zdAfU9iRMOMrJI6vgumeTkIn3J1q66fp9wUExON-Lao,489
+moosefs/merging_strategies/arithmetic_mean_merger.py,sha256=T8_6iwEpNqkdXNqZikGWAXg3STr43b2dgTnYnXgVBFI,1446
+moosefs/merging_strategies/base_merger.py,sha256=sLyWOzqG0-DqlF-dbxKHeVPUBESit5yQh_bd-5ibGUw,2325
+moosefs/merging_strategies/borda_merger.py,sha256=NnIlFxsDeRdqlV0YYVv1rg3Qk9ul1HCc3rG5sPXEDzQ,1499
+moosefs/merging_strategies/consensus_merger.py,sha256=FY1FLhi_JdCronAysCMBsdb9_0R5GfXJNTvuLVH1kIM,2856
+moosefs/merging_strategies/l2_norm_merger.py,sha256=7C8N6zSMNTOPuNKY6uSGW2uquglmi-Q7eK1BNvxThXs,1251
+moosefs/merging_strategies/union_of_intersections_merger.py,sha256=s-qWs7SfqRSLE89eWs-JeDCzWsIHjjnb59Uf7Rl1D44,3283
+moosefs/metrics/__init__.py,sha256=BmlDEXzNpFJg2_ZVBP5bIWxuHjTpJUeHahK19EbXooc,372
+moosefs/metrics/performance_metrics.py,sha256=VUFG1EeaBvoSeBct5k61m7YGHALpSbJX2gW2Fe5WHNQ,7779
+moosefs/metrics/stability_metrics.py,sha256=-5aLdVpZnPiMHVZL0Aaj8PldAE-cxHC77NldzNn0wAs,1573
+scripts/config.yml,sha256=A5m7g8mR57H4H2kzS5vKHSkBxnsBlmeqeP6nPNWroxw,2470
+scripts/main.py,sha256=US_evclaHctwMd-k6gSwAjghOs2-CjFCf_0rN-CXj2s,5837
+scripts/utils.py,sha256=iMvM-i60YFvJBYM0lqkmbfc0MQzqg7KEJaahmQi29Jw,7286
+moose_fs-0.1.0.dist-info/METADATA,sha256=RqdNZTY1xGlwE1aNelHp3wv0deBYnU-VwopMQrUqcec,7165
+moose_fs-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+moose_fs-0.1.0.dist-info/entry_points.txt,sha256=0Dh_Mf8wUplofadvKhi2W6is55ES-fOiv9oHgvo2O9I,51
+moose_fs-0.1.0.dist-info/licenses/LICENSE,sha256=VKg1fUCOEkjQdpLbeqv_m0RIl5yTS985eLm_tTTy4kE,1066
+moose_fs-0.1.0.dist-info/RECORD,,

moose_fs-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

moose_fs-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+efs-pipeline = scripts.main:main

moose_fs-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CI4CB-lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

moosefs/__init__.py

@@ -0,0 +1,6 @@
+# simplifying basic import
+from .feature_selection_pipeline import FeatureSelectionPipeline
+
+__version__ = "0.1.0"
+
+__all__ = ["FeatureSelectionPipeline", "__version__"]

moosefs/core/__init__.py

@@ -0,0 +1,6 @@
+from .data_processor import DataProcessor
+from .feature import Feature
+from .novovicova import StabilityNovovicova
+from .pareto import ParetoAnalysis
+
+__all__ = ["DataProcessor", "Feature", "StabilityNovovicova", "ParetoAnalysis"]