Skip to content

Commit 1d33fb6

Browse files
claudia-liauwsatra
authored andcommitted
clarified what permute parameter does
1 parent 7399c42 commit 1d33fb6

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ will want to generate `x_indices` programmatically.
114114
- *n_splits*: Number of shuffle split iterations to use
115115
- *test_size*: Fraction of data to use for test set in each iteration
116116
- *clf_info*: List of scikit-learn classifiers to use.
117-
- *permute*: List of booleans to indicate whether to generate a null model or not
117+
- *permute*: List of booleans to indicate whether to generate a null model with permuted labels aka permutation test (set to true) or not (set to false)
118118
- *gen_feature_importance*: Boolean indicating whether unique feature importance method should be generated for each model if available (e.g., `coef_` for linear models, `feature_importances_` for tree-based models) *NOT FULLY TESTED: set to false*
119119
- *gen_permutation_importance*: Boolean indicating whether permutation_importance values are generated (model agnostic, available for all models) *NOT FULLY TESTED: set to false*
120120
- *gen_shap*: Boolean indicating whether shap values are generated (model agnostic, available for all models)

0 commit comments

Comments
 (0)