From 88a6c0d6243207a968e82dd607652715ac655816 Mon Sep 17 00:00:00 2001 From: Calvin Date: Thu, 4 Apr 2013 17:15:19 -0400 Subject: convert CMIM to epydoc style docs --- feast.py | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) (limited to 'feast.py') diff --git a/feast.py b/feast.py index 54c9daf..28fe6ab 100644 --- a/feast.py +++ b/feast.py @@ -106,7 +106,7 @@ def CIFE(data, labels, n_select): @type n_select: integer @return selected_features: returns a list containing the features in the order they were selected. - @return type: ndarray + @rtype: ndarray ''' return BetaGamma(data, labels, n_select, beta=1.0, gamma=1.0) @@ -116,25 +116,23 @@ def CIFE(data, labels, n_select): def CMIM(data, labels, n_select): ''' - CMIM(data, labels, n_select) - This function implements the conditional mutual information maximization feature selection algorithm. Note that this implementation does not allow for the weighting of the redundancy terms that BetaGamma will allow you to do. - Input - :data - data in a Numpy array such that len(data) = + @param data: A Numpy array such that len(data) = n_observations, and len(data.transpose()) = n_features - (REQUIRED) - :labels - labels represented in a numpy list with + @type data: ndarray + @param labels: labels represented in a numpy array with n_observations as the number of elements. That is len(labels) = len(data) = n_observations. - (REQUIRED) - :n_select - number of features to select. (REQUIRED) - Output - :selected_features - returns a list containing the features - in the order they were selected. + @type labels: ndarray + @param n_select: number of features to select. + @type n_select: integer + @return selected_features: A list containing the features + in the order that they were selected. + @rtype: ndarray ''' data, labels = check_data(data, labels) -- cgit v1.2.3