FeatureSpace.hpp 16.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
/** @file feature_creation/feature_space/FeatureSpace.hpp
 *  @brief Create a feature space from an initial set of features and algebraic operators
 *
 *  Use an initial set of features and combine them to generate more complicated algebraical features. SIS is also performed here
 *
 *  @author Thomas A. R. Purcell (tpurcell)
 *  @bug No known bugs.
 */

Thomas Purcell's avatar
Thomas Purcell committed
10
11
12
#ifndef FEATURE_SPACE
#define FEATURE_SPACE

Thomas Purcell's avatar
Thomas Purcell committed
13
#include <mpi_interface/MPI_Interface.hpp>
Thomas Purcell's avatar
Thomas Purcell committed
14
#include <feature_creation/node/FeatureNode.hpp>
Thomas Purcell's avatar
Thomas Purcell committed
15
#include <feature_creation/node/ModelNode.hpp>
Thomas Purcell's avatar
Thomas Purcell committed
16
#include <feature_creation/node/operator_nodes/allowed_ops.hpp>
17
#include <feature_creation/node/utils.hpp>
Thomas Purcell's avatar
Thomas Purcell committed
18
#include <feature_creation/node/value_storage/nodes_value_containers.hpp>
Thomas Purcell's avatar
Thomas Purcell committed
19
#include <utils/project.hpp>
Thomas Purcell's avatar
Thomas Purcell committed
20

Thomas Purcell's avatar
Thomas Purcell committed
21
#include <boost/serialization/shared_ptr.hpp>
22
#include <boost/filesystem.hpp>
Thomas Purcell's avatar
Thomas Purcell committed
23

Thomas Purcell's avatar
Thomas Purcell committed
24
#include <iostream>
Thomas Purcell's avatar
Thomas Purcell committed
25
#include <iomanip>
Thomas Purcell's avatar
Thomas Purcell committed
26

27
28
29
30
#ifdef PY_BINDINGS
    namespace np = boost::python::numpy;
    namespace py = boost::python;
#endif
31

32
// DocString: cls_feat_space
33
34
35
36
37
/**
 * @brief Feature Space for SISSO calculations
 * @details Stores and performs all feature calculations for SIS
 *
 */
Thomas Purcell's avatar
Thomas Purcell committed
38
39
class FeatureSpace
{
40
    std::vector<node_ptr> _phi_selected; //!< selected features
41
42
43
44
45
46
47
48
49
50
    std::vector<node_ptr> _phi; //!< all features
    std::vector<node_ptr> _phi_0; //!< initial feature space

    std::vector<std::string> _allowed_ops; //!< list of all allowed operators strings
    std::vector<un_op_node_gen> _un_operators; //!< list of all unary operators
    std::vector<bin_op_node_gen> _com_bin_operators; //!< list of all commutable binary operators
    std::vector<bin_op_node_gen> _bin_operators; //!< list of all binary operators

    std::vector<double> _scores; //!< projection scores for each feature

51
52
53
    std::vector<int> _task_sizes; //!< The number of elements in each task (training data)
    std::vector<int> _start_gen; //!< list of the indexes where each generation starts in _phi
    std::string _feature_space_file; //!< File to store information about the selected features
Thomas Purcell's avatar
Thomas Purcell committed
54
    std::string _feature_space_summary_file; //!< File to store information about the selected features
55

56
57
    std::function<void(double*, double*, std::vector<node_ptr>&, std::vector<int>&, int)> _project; //!< Function used to calculate the scores for SIS
    std::shared_ptr<MPI_Interface> _mpi_comm; //!< MPI communicator
58

Thomas Purcell's avatar
Thomas Purcell committed
59
    double _cross_cor_max; //!< Maximum cross-correlation used for selecting features
60
61
62
    double _l_bound; //!< lower bound for absolute value of the features
    double _u_bound; //!< upper bound for absolute value of the features

63
64
    int _max_phi; //!< Maximum rung for the feature creation
    int _n_sis_select; //!< Number of features to select for each dimensions
65
    int _n_samp; //!< Number of samples (training data)
66
    int _n_feat; //!< Total number of features
Thomas Purcell's avatar
Thomas Purcell committed
67
    int _n_rung_store; //!< Total rungs stored
68
    int _n_rung_generate; //!< Total number of rungs to generate on the fly
Thomas Purcell's avatar
Thomas Purcell committed
69
public:
Thomas Purcell's avatar
Thomas Purcell committed
70

71
72
    /**
     * @brief Constructor for the feature space
73
     * @details constructs the feature space from an initial set of features and a list of allowed operators
74
75
     *
     * @param mpi_comm MPI communicator for the calculations
76
     * @param phi_0 The initial set of features to combine
77
     * @param allowed_ops list of allowed operators
78
     * @param prop The property to be learned (training data)
79
80
     * @param max_phi highest rung value for the calculation
     * @param n_sis_select number of features to select during each SIS step
81
82
     * @param max_store_rung number of rungs to calculate and store the value of the features for all samples
     * @param n_rung_generate number of rungs to generate on the fly during SIS (this must be 1 or 0 right now, possible to be higher with recursive algorithm)
Thomas Purcell's avatar
Thomas Purcell committed
83
     * @param cross_corr_max Maximum cross-correlation used for selecting features
84
     * @param min_abs_feat_val minimum absolute feature value
85
86
     * @param max_abs_feat_val maximum absolute feature value
     */
Thomas Purcell's avatar
Thomas Purcell committed
87
    FeatureSpace(
Thomas Purcell's avatar
Thomas Purcell committed
88
        std::shared_ptr<MPI_Interface> mpi_comm,
Thomas Purcell's avatar
Thomas Purcell committed
89
90
        std::vector<node_ptr> phi_0,
        std::vector<std::string> allowed_ops,
91
        std::vector<double> prop,
Thomas Purcell's avatar
Thomas Purcell committed
92
        std::vector<int> task_sizes,
Thomas Purcell's avatar
Thomas Purcell committed
93
94
        int max_phi=1,
        int n_sis_select=1,
95
96
        int max_store_rung=-1,
        int n_rung_generate=0,
Thomas Purcell's avatar
Thomas Purcell committed
97
        double cross_corr_max=1.0,
98
99
100
101
        double min_abs_feat_val=1e-50,
        double max_abs_feat_val=1e50
    );

102
103
104
105
106
    /**
     * @brief Initialize the feature set given a property vector
     *
     * @param prop The property trying to be learned
     */
107
108
    void initialize_fs(std::vector<double> prop);

109
110
111
112
    /**
     * @brief Generate the full feature set from the allowed operators and initial feature set
     * @details populates phi with all features from an initial set and the allowed operators
     */
113
    void generate_feature_space(std::vector<double>& prop);
Thomas Purcell's avatar
Thomas Purcell committed
114

115
    /**
116
     * @brief The selected feature space
117
     */
118
    inline std::vector<node_ptr> phi_selected(){return _phi_selected;};
119
120

    /**
121
     * @brief The full feature space
122
     */
Thomas Purcell's avatar
Thomas Purcell committed
123
    inline std::vector<node_ptr> phi(){return _phi;};
124
125

    /**
126
     * @brief The initial feature space
127
     */
Thomas Purcell's avatar
Thomas Purcell committed
128
    inline std::vector<node_ptr> phi0(){return _phi_0;};
129
130

    /**
131
     * @brief The vector of projection scores for SIS
132
     */
133
134
    inline std::vector<double> scores(){return _scores;}

135
    /**
136
     * @brief The MPI Communicator
137
     */
Thomas Purcell's avatar
Thomas Purcell committed
138
    inline std::shared_ptr<MPI_Interface> mpi_comm(){return _mpi_comm;}
139

140
    /**
141
     * @brief The vector storing the number of samples in each task
142
     */
Thomas Purcell's avatar
Thomas Purcell committed
143
    inline std::vector<int> task_sizes(){return _task_sizes;}
144

145
    // DocString: feat_space_feature_space_file
146
    /**
147
     * @brief The feature space filename
148
     */
149
    inline std::string feature_space_file(){return _feature_space_file;}
150

151
    // DocString: feat_space_l_bound
152
    /**
153
     * @brief The minimum absolute value of the feature
154
     */
155
    inline double l_bound(){return _l_bound;}
156

157
    // DocString: feat_space_u_bound
158
    /**
159
     * @brief The maximum absolute value of the feature
160
     */
161
    inline double u_bound(){return _u_bound;}
162

163
    // DocString: feat_space_max_phi
164
    /**
165
     * @brief The maximum rung of the feature space
166
     */
167
    inline int max_phi(){return _max_phi;}
168

169
    // DocString: feat_space_n_sis_select
170
    /**
171
     * @brief The number of features selected in each SIS step
172
     */
173
    inline int n_sis_select(){return _n_sis_select;}
174

175
    // DocString: feat_space_n_samp
176
    /**
177
     * @brief The number of samples per feature
178
     */
179
    inline int n_samp(){return _n_samp;}
180

181
    // DocString: feat_space_n_feat
182
    /**
183
     * @brief The number of features in the feature space
184
     */
185
    inline int n_feat(){return _n_feat;}
186

187
    // DocString: feat_space_n_rung_store
188
    /**
189
     * @brief The number of rungs whose feature training data is stored in memory
190
     */
191
    inline int n_rung_store(){return _n_rung_store;}
192

193
    // DocString: feat_space_n_rung_generate
194
    /**
195
     * @brief The number of rungs to be generated on the fly during SIS
196
     */
197
    inline int n_rung_generate(){return _n_rung_generate;}
198

199
200
201
202
203
204
205
206
207
208
    /**
     * @brief Generate a new set of features from a single feature
     * @details Take in the feature and perform all valid algebraic operations on it.
     *
     * @param feat The feature to spawn new features from
     * @param feat_set The feature set to pull features from for combinations
     * @param feat_ind starting index for the next feature generated
     * @param l_bound lower bound for the absolute value of the feature
     * @param u_bound upper bound for the abosulte value of the feature
     */
209
210
    void generate_new_feats(std::vector<node_ptr>::iterator& feat, std::vector<node_ptr>& feat_set, int& feat_ind, double l_bound=1e-50, double u_bound=1e50);

211
212
213
214
215
216
217
218
219
220
    /**
     * @brief Calculate the SIS Scores for feature generated on the fly
     * @details Create the next rung of features and calculate their projection scores. Only keep those that can be selected by SIS.
     *
     * @param prop Pointer to the start of the vector storing the data to project the features onto
     * @param size The size of the data to project over
     * @param phi_selected The features that would be selected from the previous rungs
     * @param scores_selected The projection scores of the features that would be selected from the previous rungs
     * @param scores_comp vector to store temporary score comparisons
     */
221
    void project_generated(double* prop, int size, std::vector<node_ptr>& phi_selected, std::vector<double>& scores_selected, std::vector<double>& scores_comp);
222

Thomas Purcell's avatar
Thomas Purcell committed
223
224
225
226
227
228
229
230
231
232
    /**
     * @brief Checks the feature to see if it is still valid against previously selected features
     *
     * @param val_ptr pointer to value array of the current feature
     * @param end_sel index of the feature to stop checking
     *
     * @return True if the feature is still valid
     */
    bool valid_feature_against_selected(double* val_ptr, int end_sel, int start_sel = 0);

233
234
    /**
     * @brief Perform SIS on a feature set with a specified property
235
     * @details Perform sure-independence screening with either the correct property or the error
236
     *
237
     * @param prop The property to perform SIS over
238
     */
Thomas Purcell's avatar
Thomas Purcell committed
239
    void sis(std::vector<double>& prop);
240

241
    // DocString: feat_space_feat_in_phi
242
243
244
    /**
     * @brief Is a feature in this process' _phi?
     *
245
246
     * @param ind The index of the feature
     * @return True if feature is in this rank's _phi
247
248
249
     */
    inline bool feat_in_phi(int ind){return (ind >= _phi[0]->feat_ind()) && (ind <= _phi.back()->feat_ind());}

250
251
252
253
254
255
256
257
    // DocString: feat_space_remove_feature
    /**
     * @brief Remove a feature from phi
     *
     * @param ind index of feature to remove
     */
    void remove_feature(int ind);

258
259
260
    // Python Interface Functions
    #ifdef PY_BINDINGS
        /**
261
262
         * @brief Constructor for the feature space that takes in python objects
         * @details constructs the feature space from an initial set of features and a list of allowed operators (cpp definition in <python/feature_creation/FeatureSpace.cpp>)
263
         *
264
         * @param phi_0 The initial set of features to combine
265
         * @param allowed_ops list of allowed operators
266
         * @param prop The property to be learned (training data)
267
268
         * @param max_phi highest rung value for the calculation
         * @param n_sis_select number of features to select during each SIS step
269
270
         * @param max_store_rung number of rungs to calculate and store the value of the features for all samples
         * @param n_rung_generate number of rungs to generate on the fly during SIS (this must be 1 or 0 right now, possible to be higher with recursive algorithm)
Thomas Purcell's avatar
Thomas Purcell committed
271
         * @param cross_corr_max Maximum cross-correlation used for selecting features
272
         * @param min_abs_feat_val minimum absolute feature value
273
274
275
276
277
278
279
280
281
282
283
         * @param max_abs_feat_val maximum absolute feature value
         */
        FeatureSpace(
            py::list phi_0,
            py::list allowed_ops,
            py::list prop,
            py::list task_sizes,
            int max_phi=1,
            int n_sis_select=1,
            int max_store_rung=-1,
            int n_rung_generate=0,
Thomas Purcell's avatar
Thomas Purcell committed
284
            double cross_corr_max=1.0,
285
286
287
288
289
            double min_abs_feat_val=1e-50,
            double max_abs_feat_val=1e50
        );

        /**
290
291
         * @brief Constructor for the feature space that takes in python and numpy objects
         * @details constructs the feature space from an initial set of features and a list of allowed operators (cpp definition in <python/feature_creation/FeatureSpace.cpp>)
292
         *
293
         * @param phi_0 The initial set of features to combine
294
         * @param allowed_ops list of allowed operators
295
         * @param prop The property to be learned (training data)
296
297
         * @param max_phi highest rung value for the calculation
         * @param n_sis_select number of features to select during each SIS step
298
299
         * @param max_store_rung number of rungs to calculate and store the value of the features for all samples
         * @param n_rung_generate number of rungs to generate on the fly during SIS (this must be 1 or 0 right now, possible to be higher with recursive algorithm)
Thomas Purcell's avatar
Thomas Purcell committed
300
         * @param cross_corr_max Maximum cross-correlation used for selecting features
301
         * @param min_abs_feat_val minimum absolute feature value
302
303
304
305
306
307
308
309
310
311
312
         * @param max_abs_feat_val maximum absolute feature value
         */
        FeatureSpace(
            py::list phi_0,
            py::list allowed_ops,
            np::ndarray prop,
            py::list task_sizes,
            int max_phi=1,
            int n_sis_select=1,
            int max_store_rung=-1,
            int n_rung_generate=0,
Thomas Purcell's avatar
Thomas Purcell committed
313
            double cross_corr_max=1.0,
314
315
316
317
            double min_abs_feat_val=1e-50,
            double max_abs_feat_val=1e50
        );

318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
        /**
         * @brief Constructor for the feature space that takes in python and numpy objects
         * @details constructs the feature space from an initial set of features and a file containing postfix expressions for the features (cpp definition in <python/feature_creation/FeatureSpace.cpp>)
         *
         * @param feature_file The file with the postfix expressions for the feature space
         * @param phi_0 The initial set of features to combine
         * @param n_sis_select number of features to select during each SIS step
         * @param max_store_rung number of rungs to calculate and store the value of the features for all samples
         * @param cross_corr_max Maximum cross-correlation used for selecting features
         */
        FeatureSpace(
            std::string feature_file,
            py::list phi_0,
            py::list task_sizes,
            int n_sis_select=1,
            double cross_corr_max=1.0
        );

336
        // DocString: feat_space_sis_arr
337
338
339
        /**
         * @brief Wrapper function for SIS using a numpy array
         *
340
         * @param prop(np.ndarray) The property to perform SIS over as a numpy array
341
         */
342
343
344
345
346
        inline void sis(np::ndarray prop)
        {
            std::vector<double> prop_vec = python_conv_utils::from_ndarray<double>(prop);
            sis(prop_vec);
        }
347
348

        // DocString: feat_space_sis_list
349
350
351
        /**
         * @brief Wrapper function for SIS using a python list
         *
352
         * @param prop(list) The property to perform SIS over as a python list
353
         */
354
355
356
357
358
359
        inline void sis(py::list prop)
        {
            std::vector<double> prop_vec = python_conv_utils::from_list<double>(prop);
            sis(prop_vec);
        }

360
        // DocString: feat_space_phi_selected_py
361
        /**
362
         * @brief The selected feature space (cpp definition in <python/feature_creation/FeatureSpace.cpp>)
363
364
         * @return _phi_selected as a python list
         */
365
        py::list phi_selected_py();
366

367
        // DocString: feat_space_phi0_py
368
        /**
369
         * @brief The initial feature space (cpp definition in <python/feature_creation/FeatureSpace.cpp>)
370
371
         * @return _phi0 as a python list
         */
372
        py::list phi0_py();
373

374
375
376
377
378
379
380
        // DocString: feat_space_phi_py
        /**
         * @brief The feature space (cpp definition in <python/feature_creation/FeatureSpace.cpp>)
         * @return _phi as a python list
         */
        py::list phi_py();

381
        // DocString: feat_space_scores_py
382
        /**
383
         * @brief The vector of projection scores for SIS
384
385
         * @return _scores as a numpy array
         */
386
        inline np::ndarray scores_py(){return python_conv_utils::to_ndarray<double>(_scores);};
387

388
        // DocString: feat_space_task_sizes_py
389
        /**
390
         * @brief The vector storing the number of samples in each task
391
392
         * @return _task_sizes as a python list
         */
393
        inline py::list task_sizes_py(){return python_conv_utils::to_list<int>(_task_sizes);};
394

395
        // DocString: feat_space_allowed_ops_py
396
        /**
397
         * @brief The list of allowed operator nodes
398
399
         * @return _allowed_ops as a python list
         */
400
        inline py::list allowed_ops_py(){return python_conv_utils::to_list<std::string>(_allowed_ops);}
401

402
        // DocString: feat_space_start_gen_py
403
        /**
404
         * @brief The index in _phi where each generation starts
405
406
         * @return _start_gen as a python list
         */
407
        inline py::list start_gen_py(){return python_conv_utils::to_list<int>(_start_gen);}
408

409
410
411
412
413
414
415
416
        // DocString: feat_space_get_feature
        /**
         * @brief Return a feature at a specified index
         *
         * @param ind index of the feature to get
         * @return A ModelNode of the feature at index ind
         */
        inline ModelNode get_feature(int ind){return ModelNode(_phi[ind]->d_mat_ind(), _phi[ind]->rung(), _phi[ind]->expr(), _phi[ind]->postfix_expr(), _phi[ind]->value(), _phi[ind]->test_value(), _phi[ind]->unit());}
417
    #endif
Thomas Purcell's avatar
Thomas Purcell committed
418
419
420
};

#endif