confound-prediction 0.0.1a0
Confound-isolating cross-validation approach to control for a confounding effect in a predictive model.

# Confound Prediction

## Confound_prediction is a Python module to control confound effect in the prediction or classification model.

Any successful prediction model may be driven by a confounding effect that is correlated with the effect of interest. It is important to control that detected associations are not driven by unwanted effects. It is common issue in in neuroscience, epidemiology, economy, agriculture, etc. 

This module provides 3 methods to tackle confounding effects in predictive models:

&nbsp; 1. Confound-isolating cross-validation

&nbsp; 2. Out-of-sample deconfounding

&nbsp; 3. Deconfounding test and train jointly (which should not be used, and is provided only for illustration)

### Confound-isolating cross-validation

“Confound-isolating cross-validation” is a non-parametric approach to control for a confounding effect in a predictive model. It is based on crafting a test set on which the effect of interest is independent from the confounding effect. 


### What expect from Confound_prediction?

Developed framework is based on anti mutual information sampling, a novel sampling approach to create a test set in which the effect of interest is independent from the confounding effect. The grafical illustration of classic and confound-isolating cross-validation:

### How does it work?

**You provide us**

Variables:
&nbsp;
* *X* - data with shape (n_samples, n_features)
* *y* - target vector with shape (n_samples)
* *z* - confound vector with shape (n_samples)

Optional parameters
* *min_sample_size* - minimum sample size to be reached, default is 10% of the data
* *n_remove* - number of the samples to be removed on each iteration of sampling, default is 4
* *prng* - control the pseudo random number generator, default is None
* *cv_folds* - number of folders in the cross validation, default is 10

**We return you**

Variables:
* *x_test, x_train, y_test, y_train, ids_test, ids_train* - train and test of *X*, *y* and *sampled indexes*


## Installing

### Dependences
confound_prediction package requires:
* Python (>= 3.5)
* Scipy (>=1.1.0)
* Scikit-learn (>=0.21.2)
* Numpy (>=1.14.2)
* Pytest(>=5.1.1)

### Optional dependency:
* Matplotlib (>=2.2.2) for example visualization
* Seaborn (>=0.8) for example visualization

### User installation
```python
pip install -U --user confound-prediction
```

## Examples

### Example: create train set and test set without confounding effect

```python
python example/Example_get_testset.py
```

### Example: compare prediction on data sampled with different deconfounding methods on the data with direct link between target and confound

```python
python example/Example-prediction-different-deconfounding-direct-confound.py
```

### Example: compare prediction on the data with different confound effect

```python
python example/Example_prediction_isolatingcv_deconfounding_dif_confound.py
```

### Example: evolution of mutual information and correlation on each itteration of 'confound-isolation cross-validation' method

```python
python example/Example_compare_mutual_info_correlation.py
```

## References

[1] TBD

[2] D. Chyzhyk, G. Varoquaux, B. Thirion and M. Milham, "Controlling a confound in predictive models with a test set minimizing its effect," 2018 International Workshop on Pattern Recognition in Neuroimaging (PRNI), Singapore, 2018, pp. 1-4.
doi: 10.1109/PRNI.2018.8423961 [PDF](https://hal.archives-ouvertes.fr/hal-01831701/document)