Missing documentation of functions.

[lionelkusch]

I found a number of functions without documentation, and some others have too short documentation.

The docstring of stat_coef_diff in hidimstat/stat_coef_diff.py required to be rewritten because the parameters are not matched. Moreover, in this file, the line 8 and 9 are commented. I think that we can remove them.

Function without docstring or lacking of description of parameters:

• hidimstat/clustered_inference.py:_degrouping, _ward_clustering, _subsampling
• hidimstat/data_simulation.py: _x_distillation_lasso, _lasso_distillation_residual, _rf_distillation
• hidimstat/desparsified_lasso.py: _compute_all_residuals, _compute_residuals
• hidimstat/ensemble_clustered_inference.py: _ensembling
• hidimstat/gaussian_knockoff.py: _estimate_distribution
• hidimstat/knockoff_aggregation.py: _empirical_pval, _empirical_eval,
• hidimstat/permutation_test.py: _permutation_test_stat, _shuffle,
• hidimstat/RandomForestModified.py: RandomForestClassifierModified, RandomForestRegressorModified
• hidimstat/stat_tools.py: _replace_infinity
• hidimstat/utils.py: quantile_aggregation, fdr_threshold, _bhq_threshold, _ebh_threshold, _bhy_threshold, _adaptive_quantile_aggregation, _lambda_max, _check_vim_predict_method, sample_predictions, initialize_weights, Dataset_Loader, DNN (have comment lines and methods without documentation), evaluate, compute_imp_std,

Documentation of the method functions:

• hidimstat/adaptive_permutation_threshold.py: _manual_inversion
• hidimstat/loco.py:_joblib_fit_one_group, _joblib_predict_one_group
• hidimstat/permutation_importance.py:_joblib_fit_one_group, _joblib_predict_one_group

Missing arguments in the docstring:

• hidimstat/data_simulation.py: dcrt_zero/joblib_verbose (wrong spelling in the doctstring)
• hidimstat/knockoff_aggregation.py: knockoff_aggregation/joblib_verbose (wrong spelling in the doctstring)
• hidimstat/gaussian_knockoff.py: gaussian_knockoff_generation
• hidimstat/knockoffs.py: verbose, memory, n_jobs
• hidimstat/scenario.py: multivariate_simulation (there are additional output, I suppose, they should be removed.)

For the test, it missing doctring in:

• hidimstat/test/conftest.py
• hidimstat/test/test_cpi.py
• hidimstat/test/test_data_simulation.py
• hidimstat/test/test_generate_knockoff.py
• hidimstat/test/test_knockoff_aggregation.py
• hidimstat/test/test_loco.py
• hidimstat/test/test_model_x_knockoff.py
• hidimstat/test/test_permutation_importance.py
• hidimstat/test/test_stat_tools.py

[bthirion]

To me this is very high priorities. Chunk that into smaller PRs.