fstoolbox 0.0.2
An information theoretic feature selection toolbox.
License: MIT
Requires Python: >=3.9, <4
Keywords: feast,feature,selection,fstoolbox

FEAST
=====

A FEAture Selection Toolbox for C/C++, Java, Python, &amp; MATLAB/Octave, v2.1.0.

FEAST provides implementations of common mutual information based filter
feature selection algorithms, and an implementation of RELIEF for Matlab. All
functions expect discrete inputs (except RELIEF, which does not depend on the
MIToolbox), and they return the selected feature indices. These implementations
were developed to help our research into the similarities between these
algorithms, and our results are presented in the following paper:

```
 Conditional Likelihood Maximisation: A Unifying Framework for Information Theoretic Feature Selection
 G. Brown, A. Pocock, M.-J. Zhao, M. Lujan
 Journal of Machine Learning Research, 13:27-66 (2012)
```

The weighted feature selection algorithms are described in Chapter 7 of:

```
 Feature Selection via Joint Likelihood
 A. Pocock
 PhD Thesis, University of Manchester, 2012
```

If you use these implementations for academic research please cite the relevant paper
above.  All FEAST code is licensed under the BSD 3-Clause License.

Contains implementations of:
   mim, mrmr, mifs, cmim, jmi, disr, cife, icap, condred, cmi, relief, fcbf, betagamma

And weighted implementations of:
   mim, cmim, jmi, disr, cmi

References for these algorithms are provided in the accompanying feast.bib file
(in BibTeX format).

FEAST works on discrete inputs, and all continuous values **must** be
discretised before use with FEAST.  In our experiments we've found that using
10 equal width bins is suitable for many problems, though this is data set size
dependent. FEAST produces unreliable results when used with continuous inputs,
runs slowly and uses much more memory than usual. The discrete inputs should
have small cardinality, FEAST will treat values {1,10,100} the same way it
treats {1,2,3} and the latter will be both faster and use less memory.

MATLAB Example (using "data" as our feature matrix, and "labels" as the class label vector):

```
>> size(data)
ans = 
     (569,30)                                     %% denoting 569 examples, and 30 features
```
```
>> selectedIndices = feast('jmi',5,data,labels) %% selecting the top 5 features using the jmi algorithm
selectedIndices =

    28
    21
     8
    27
    23
```
```
>> selectedIndices = feast('mrmr',10,data,labels) %% selecting the top 10 features using the mrmr algorithm
selectedIndices =

    28
    24
    22
     8
    27
    21
    29
     4
     7
    25
```
```
>> selectedIndices = feast('mifs',5,data,labels,0.7) %% selecting the top 5 features using the mifs algorithm with beta = 0.7
selectedIndices =

    28
    24
    22
    20
    29
```

The library is written in ANSI C for compatibility with the MATLAB mex
compiler, except for MIM, FCBF and RELIEF, which are written in MATLAB/OCTAVE
script. There is a different implementation of MIM available for use in the C
library. It depends on MIToolbox which is incorporated as a git submodule.

MIToolbox is developed on [GitHub](http://www.github.com/Craigacp/MIToolbox/).

The C library expects all matrices in column-major format (i.e. Fortran style).
This is for two reasons, a) MATLAB generates Fortran-style arrays, and b)
feature selection iterates over columns rather than rows, unlike most other ML
processes. 

Compilation instructions:
Run `git submodule init` then,
 - MATLAB/OCTAVE 
    - run `CompileFEAST.m` in the `matlab` folder.
 - Linux C shared library 
    - run `make x86` or `make x64` for a 32-bit or 64-bit library.
 - Windows C dll (expects pre built libMIToolbox.dll)
	- install MinGW from https://sourceforge.net/projects/mingw-w64/
	- add MinGW binaries folders to PATH, e.g. mingw/bin, mingw/msys/bin 
	- run `make x64_win`.
 - Java (requires Java 8)
    - run `make x64`, `sudo make install` to build and install the C library.
    - then `make java` to build the JNI wrapper.
    - then run `mvn package` in the `java` directory to build the jar file.
    - Note: the Java code should work on all platforms and future versions of Java, but the included Makefile only works on Ubuntu & Java 8.
 - Python
    - run `python setup.py` in the `python` folder.

Update History
 - xx/xx/xxxx - v2.1.0 - Added a python API and refactored the package structure.
 - 07/01/2017 - v2.0.0 - Added weighted feature selection, major refactoring of the code to improve speed and portability. FEAST functions now return the internal scores assigned by each criteria as well. Added a Java API via JNI. FEAST v2 is approximately 30% faster when called from Matlab.
 - 12/03/2016 - v1.1.4 - Fixed an issue where Matlab would segfault if all features had zero MI with the label.
 - 12/10/2014 - v1.1.2 - Updated documentation to note that FEAST expects column-major matrices.
 - 11/06/2014 - v1.1.1 - Fixed an issue where MIM wasn't compiled into libFSToolbox.
 - 22/02/2014 - v1.1.0 - Bug fixes in memory allocation, added a C implementation of MIM, moved the selected feature increment into the mex code.
 - 12/02/2013 - v1.0.1 - Bug fix for 32-bit Windows MATLAB's lcc.
 - 08/11/2011 - v1.0.0 - Public Release to complement the JMLR publication.