Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CPI, LOCO and PermutationImportance to api.rst #22

Merged
merged 2 commits into from
Oct 16, 2024
Merged

Add CPI, LOCO and PermutationImportance to api.rst #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70a8843
Add CPI, LOCO and PermutationImportance to api.rst
jpaillard Oct 16, 2024
b59dca0
remove `TransformerMixin` inheritance
jpaillard Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion doc_conf/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Functions

ada_svr
aggregate_quantiles
BlockBasedImportance
clustered_inference
data_simulation
desparsified_lasso
Expand All @@ -31,3 +30,13 @@ Functions
reid
standardized_svr
zscore_from_pval

Classes
=======

.. autosummary::
:toctree: generated/

LOCO
CPI
PermutationImportance
4 changes: 2 additions & 2 deletions hidimstat/cpi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import numpy as np
from joblib import Parallel, delayed
from sklearn.base import BaseEstimator, TransformerMixin, check_is_fitted, clone
from sklearn.base import BaseEstimator, check_is_fitted, clone
from sklearn.metrics import root_mean_squared_error


class CPI(BaseEstimator, TransformerMixin):
class CPI(BaseEstimator):
"""
Conditional Permutation Importance (CPI) algorithm.
:footcite:t:`Chamma_NeurIPS2023` and for group-level see
Expand Down
4 changes: 2 additions & 2 deletions hidimstat/loco.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import numpy as np
from joblib import Parallel, delayed
from sklearn.base import BaseEstimator, TransformerMixin, check_is_fitted, clone
from sklearn.base import BaseEstimator, check_is_fitted, clone
from sklearn.metrics import root_mean_squared_error


class LOCO(BaseEstimator, TransformerMixin):
class LOCO(BaseEstimator):
"""
Leave-One-Covariate-Out (LOCO) algorithm as described in
:footcite:t:`Chamma_NeurIPS2023`.
Expand Down
4 changes: 2 additions & 2 deletions hidimstat/permutation_importance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import numpy as np
from joblib import Parallel, delayed
from sklearn.base import BaseEstimator, TransformerMixin, check_is_fitted
from sklearn.base import BaseEstimator, check_is_fitted
from sklearn.metrics import root_mean_squared_error


class PermutationImportance(BaseEstimator, TransformerMixin):
class PermutationImportance(BaseEstimator):
"""


Expand Down