aboutsummaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..b824e83
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,27 @@
+====
+PyFeast
+====
+Python Interface to the FEAST Feature Selection Toolbox
+
+About
+====
+This set of scripts provides an interface to the FEAST feature selection
+toolbox, originally written in C with a Mex interface to Matlab. Python
+2.7 is required, along with Numpy. The feast.py module provides an inter-
+face to all the functionality of the FEAST implementation that was provided
+with the original Matlab interface.
+
+Demonstration
+====
+See demo_feast_wrapper.py for an example with uniform data and an image
+data set. The image data set was collected from the digits example in
+the Scikits-Learn toolbox.
+
+To Do
+====
+1) Add a setup.py script that can manage the build and installation of the
+ Python interface to FEAST.
+2) Add in the rest of the functionality to feast.py. Add subsequent
+ functionality into the demo.
+3) Integrate the module into KBase!
+4) Clean up the paths