1 /*! \page libshogun_examples Examples for C++ libshogun Interface
3 This page lists ready to run shogun examples for the C++ libshogun interface.
5 \li \subpage libshogun_balanced_examples
6 \li \subpage libshogun_base_examples
7 \li \subpage libshogun_basic_examples
8 \li \subpage libshogun_classifier_examples
9 \li \subpage libshogun_clustering_examples
10 \li \subpage libshogun_converter_examples
11 \li \subpage libshogun_evaluation_examples
12 \li \subpage libshogun_features_examples
13 \li \subpage libshogun_hashed_examples
14 \li \subpage libshogun_io_examples
15 \li \subpage libshogun_kernel_examples
16 \li \subpage libshogun_labels_examples
17 \li \subpage libshogun_library_examples
18 \li \subpage libshogun_mathematics_examples
19 \li \subpage libshogun_metric_examples
20 \li \subpage libshogun_modelselection_examples
21 \li \subpage libshogun_optimization_examples
22 \li \subpage libshogun_parameter_examples
23 \li \subpage libshogun_preprocessor_examples
24 \li \subpage libshogun_random_examples
25 \li \subpage libshogun_regression_examples
26 \li \subpage libshogun_serialization_examples
27 \li \subpage libshogun_so_examples
28 \li \subpage libshogun_splitting_examples
29 \li \subpage libshogun_statistics_examples
30 \li \subpage libshogun_streaming_examples
31 \li \subpage libshogun_structure_examples
32 \li \subpage libshogun_transfer_examples
34 To run the examples you will need to manually compile them via
36 g++ name_of_example.cpp -lshogun
39 in case you installed libshogun to a nonstandard directory you will need to specify the appropriate library and include paths, e.g.
41 g++ -I/path/to/libshogun/includes name_of_example.cpp -L/path/to/libshogun/sofile -lshogun
44 Then the examples are standard binary executables and can be started via
48 respectively if the libraries are in nonstandard locations (such that they cannot be found by the dynamic linker)
50 LD_LIBRARY_PATH=path/to/libshogun ./name_of_example
53 \section libshogun_balanced_examples Balanced
56 \li <b>../examples/documented/libshogun/balanced_conditional_probability_tree.cpp</b>
57 \verbinclude balanced_conditional_probability_tree.cpp
59 \section libshogun_base_examples Base
62 \li <b>../examples/documented/libshogun/base_load_all_file_parameters.cpp</b>
63 \verbinclude base_load_all_file_parameters.cpp
65 \li <b>../examples/documented/libshogun/base_load_file_parameters.cpp</b>
66 \verbinclude base_load_file_parameters.cpp
68 \li <b>../examples/documented/libshogun/base_map_parameters.cpp</b>
69 \verbinclude base_map_parameters.cpp
71 \li <b>../examples/documented/libshogun/base_migration_dropping_and_new.cpp</b>
72 \verbinclude base_migration_dropping_and_new.cpp
74 \li <b>../examples/documented/libshogun/base_migration_multiple_dependencies.cpp</b>
75 \verbinclude base_migration_multiple_dependencies.cpp
77 \li <b>../examples/documented/libshogun/base_migration_new_buggy.cpp</b>
78 \verbinclude base_migration_new_buggy.cpp
80 \li <b>../examples/documented/libshogun/base_migration_type_conversion.cpp</b>
81 \verbinclude base_migration_type_conversion.cpp
83 \li <b>../examples/documented/libshogun/base_parameter_map.cpp</b>
84 \verbinclude base_parameter_map.cpp
86 \section libshogun_basic_examples Basic
89 \li <b>../examples/documented/libshogun/basic_minimal.cpp</b>
90 \verbinclude basic_minimal.cpp
92 \section libshogun_classifier_examples Classifier
95 \li <b>../examples/documented/libshogun/classifier_bagging_liblinear.cpp</b>
96 \verbinclude classifier_bagging_liblinear.cpp
98 \li <b>../examples/documented/libshogun/classifier_featureblocklogisticregression.cpp</b>
99 \verbinclude classifier_featureblocklogisticregression.cpp
101 \li <b>../examples/documented/libshogun/classifier_gaussian_process_binary_classification.cpp</b>
102 \verbinclude classifier_gaussian_process_binary_classification.cpp
104 \li <b>../examples/documented/libshogun/classifier_gaussiannaivebayes.cpp</b>
105 \verbinclude classifier_gaussiannaivebayes.cpp
107 \li <b>../examples/documented/libshogun/classifier_knn.cpp</b>
108 \verbinclude classifier_knn.cpp
110 \li <b>../examples/documented/libshogun/classifier_larank.cpp</b>
111 \verbinclude classifier_larank.cpp
113 \li <b>../examples/documented/libshogun/classifier_latent_svm.cpp</b>
114 \verbinclude classifier_latent_svm.cpp
116 \li <b>../examples/documented/libshogun/classifier_lda.cpp</b>
117 \verbinclude classifier_lda.cpp
119 \li <b>../examples/documented/libshogun/classifier_libsvm.cpp</b>
120 \verbinclude classifier_libsvm.cpp
122 \li <b>../examples/documented/libshogun/classifier_libsvm_probabilities.cpp</b>
123 \verbinclude classifier_libsvm_probabilities.cpp
125 \li <b>../examples/documented/libshogun/classifier_minimal_svm.cpp</b>
126 \verbinclude classifier_minimal_svm.cpp
128 \li <b>../examples/documented/libshogun/classifier_mklmulticlass.cpp</b>
129 \verbinclude classifier_mklmulticlass.cpp
131 \li <b>../examples/documented/libshogun/classifier_multiclass_ecoc.cpp</b>
132 \verbinclude classifier_multiclass_ecoc.cpp
134 \li <b>../examples/documented/libshogun/classifier_multiclass_ecoc_discriminant.cpp</b>
135 \verbinclude classifier_multiclass_ecoc_discriminant.cpp
137 \li <b>../examples/documented/libshogun/classifier_multiclass_ecoc_random.cpp</b>
138 \verbinclude classifier_multiclass_ecoc_random.cpp
140 \li <b>../examples/documented/libshogun/classifier_multiclass_prob_heuristics.cpp</b>
141 \verbinclude classifier_multiclass_prob_heuristics.cpp
143 \li <b>../examples/documented/libshogun/classifier_multiclass_relaxedtree.cpp</b>
144 \verbinclude classifier_multiclass_relaxedtree.cpp
146 \li <b>../examples/documented/libshogun/classifier_multiclass_shareboost.cpp</b>
147 \verbinclude classifier_multiclass_shareboost.cpp
149 \li <b>../examples/documented/libshogun/classifier_multiclasslibsvm.cpp</b>
150 \verbinclude classifier_multiclasslibsvm.cpp
152 \li <b>../examples/documented/libshogun/classifier_multiclasslinearmachine.cpp</b>
153 \verbinclude classifier_multiclasslinearmachine.cpp
155 \li <b>../examples/documented/libshogun/classifier_nearest_centroid.cpp</b>
156 \verbinclude classifier_nearest_centroid.cpp
158 \li <b>../examples/documented/libshogun/classifier_newtontest.cpp</b>
159 \verbinclude classifier_newtontest.cpp
161 \li <b>../examples/documented/libshogun/classifier_qda.cpp</b>
162 \verbinclude classifier_qda.cpp
164 \section libshogun_clustering_examples Clustering
167 \li <b>../examples/documented/libshogun/clustering_kmeans.cpp</b>
168 \verbinclude clustering_kmeans.cpp
170 \section libshogun_converter_examples Converter
173 \li <b>../examples/documented/libshogun/converter_diffusionmaps.cpp</b>
174 \verbinclude converter_diffusionmaps.cpp
176 \li <b>../examples/documented/libshogun/converter_factoranalysis.cpp</b>
177 \verbinclude converter_factoranalysis.cpp
179 \li <b>../examples/documented/libshogun/converter_hessianlocallylinearembedding.cpp</b>
180 \verbinclude converter_hessianlocallylinearembedding.cpp
182 \li <b>../examples/documented/libshogun/converter_isomap.cpp</b>
183 \verbinclude converter_isomap.cpp
185 \li <b>../examples/documented/libshogun/converter_jade_bss.cpp</b>
186 \verbinclude converter_jade_bss.cpp
188 \li <b>../examples/documented/libshogun/converter_kernellocallylinearembedding.cpp</b>
189 \verbinclude converter_kernellocallylinearembedding.cpp
191 \li <b>../examples/documented/libshogun/converter_laplacianeigenmaps.cpp</b>
192 \verbinclude converter_laplacianeigenmaps.cpp
194 \li <b>../examples/documented/libshogun/converter_linearlocaltangentspacealignment.cpp</b>
195 \verbinclude converter_linearlocaltangentspacealignment.cpp
197 \li <b>../examples/documented/libshogun/converter_localitypreservingprojections.cpp</b>
198 \verbinclude converter_localitypreservingprojections.cpp
200 \li <b>../examples/documented/libshogun/converter_locallylinearembedding.cpp</b>
201 \verbinclude converter_locallylinearembedding.cpp
203 \li <b>../examples/documented/libshogun/converter_localtangentspacealignment.cpp</b>
204 \verbinclude converter_localtangentspacealignment.cpp
206 \li <b>../examples/documented/libshogun/converter_multidimensionalscaling.cpp</b>
207 \verbinclude converter_multidimensionalscaling.cpp
209 \li <b>../examples/documented/libshogun/converter_neighborhoodpreservingembedding.cpp</b>
210 \verbinclude converter_neighborhoodpreservingembedding.cpp
212 \li <b>../examples/documented/libshogun/converter_stochasticproximityembedding.cpp</b>
213 \verbinclude converter_stochasticproximityembedding.cpp
215 \section libshogun_evaluation_examples Evaluation
218 \li <b>../examples/documented/libshogun/evaluation_cross_validation_classification.cpp</b>
219 \verbinclude evaluation_cross_validation_classification.cpp
221 \li <b>../examples/documented/libshogun/evaluation_cross_validation_knn.cpp</b>
222 \verbinclude evaluation_cross_validation_knn.cpp
224 \li <b>../examples/documented/libshogun/evaluation_cross_validation_locked_comparison.cpp</b>
225 \verbinclude evaluation_cross_validation_locked_comparison.cpp
227 \li <b>../examples/documented/libshogun/evaluation_cross_validation_mkl_weight_storage.cpp</b>
228 \verbinclude evaluation_cross_validation_mkl_weight_storage.cpp
230 \li <b>../examples/documented/libshogun/evaluation_cross_validation_multiclass.cpp</b>
231 \verbinclude evaluation_cross_validation_multiclass.cpp
233 \li <b>../examples/documented/libshogun/evaluation_cross_validation_multiclass_mkl.cpp</b>
234 \verbinclude evaluation_cross_validation_multiclass_mkl.cpp
236 \li <b>../examples/documented/libshogun/evaluation_cross_validation_regression.cpp</b>
237 \verbinclude evaluation_cross_validation_regression.cpp
239 \section libshogun_features_examples Features
242 \li <b>../examples/documented/libshogun/features_copy_subset_simple_features.cpp</b>
243 \verbinclude features_copy_subset_simple_features.cpp
245 \li <b>../examples/documented/libshogun/features_copy_subset_sparse_features.cpp</b>
246 \verbinclude features_copy_subset_sparse_features.cpp
248 \li <b>../examples/documented/libshogun/features_dense_real_modular.cpp</b>
249 \verbinclude features_dense_real_modular.cpp
251 \li <b>../examples/documented/libshogun/features_subset_labels.cpp</b>
252 \verbinclude features_subset_labels.cpp
254 \li <b>../examples/documented/libshogun/features_subset_simple_features.cpp</b>
255 \verbinclude features_subset_simple_features.cpp
257 \li <b>../examples/documented/libshogun/features_subset_stack.cpp</b>
258 \verbinclude features_subset_stack.cpp
260 \section libshogun_hashed_examples Hashed
263 \li <b>../examples/documented/libshogun/hashed_features_example.cpp</b>
264 \verbinclude hashed_features_example.cpp
266 \section libshogun_io_examples Io
269 \li <b>../examples/documented/libshogun/io_linereader.cpp</b>
270 \verbinclude io_linereader.cpp
272 \section libshogun_kernel_examples Kernel
275 \li <b>../examples/documented/libshogun/kernel_custom.cpp</b>
276 \verbinclude kernel_custom.cpp
278 \li <b>../examples/documented/libshogun/kernel_custom_kernel.cpp</b>
279 \verbinclude kernel_custom_kernel.cpp
281 \li <b>../examples/documented/libshogun/kernel_gaussian.cpp</b>
282 \verbinclude kernel_gaussian.cpp
284 \li <b>../examples/documented/libshogun/kernel_machine_train_locked.cpp</b>
285 \verbinclude kernel_machine_train_locked.cpp
287 \li <b>../examples/documented/libshogun/kernel_revlin.cpp</b>
288 \verbinclude kernel_revlin.cpp
290 \section libshogun_labels_examples Labels
293 \li <b>../examples/documented/libshogun/labels_binary_fit_sigmoid.cpp</b>
294 \verbinclude labels_binary_fit_sigmoid.cpp
296 \section libshogun_library_examples Library
299 \li <b>../examples/documented/libshogun/library_circularbuffer.cpp</b>
300 \verbinclude library_circularbuffer.cpp
302 \li <b>../examples/documented/libshogun/library_dyn_int.cpp</b>
303 \verbinclude library_dyn_int.cpp
305 \li <b>../examples/documented/libshogun/library_dynarray.cpp</b>
306 \verbinclude library_dynarray.cpp
308 \li <b>../examples/documented/libshogun/library_gc_array.cpp</b>
309 \verbinclude library_gc_array.cpp
311 \li <b>../examples/documented/libshogun/library_hash.cpp</b>
312 \verbinclude library_hash.cpp
314 \li <b>../examples/documented/libshogun/library_hdf5.cpp</b>
315 \verbinclude library_hdf5.cpp
317 \li <b>../examples/documented/libshogun/library_indirect_object.cpp</b>
318 \verbinclude library_indirect_object.cpp
320 \li <b>../examples/documented/libshogun/library_map.cpp</b>
321 \verbinclude library_map.cpp
323 \li <b>../examples/documented/libshogun/library_mldatahdf5.cpp</b>
324 \verbinclude library_mldatahdf5.cpp
326 \li <b>../examples/documented/libshogun/library_serialization.cpp</b>
327 \verbinclude library_serialization.cpp
329 \li <b>../examples/documented/libshogun/library_set.cpp</b>
330 \verbinclude library_set.cpp
332 \section libshogun_mathematics_examples Mathematics
335 \li <b>../examples/documented/libshogun/mathematics_confidence_intervals.cpp</b>
336 \verbinclude mathematics_confidence_intervals.cpp
338 \li <b>../examples/documented/libshogun/mathematics_lapack.cpp</b>
339 \verbinclude mathematics_lapack.cpp
341 \section libshogun_metric_examples Metric
344 \li <b>../examples/documented/libshogun/metric_lmnnn.cpp</b>
345 \verbinclude metric_lmnnn.cpp
347 \section libshogun_modelselection_examples Modelselection
350 \li <b>../examples/documented/libshogun/modelselection_apply_parameter_tree.cpp</b>
351 \verbinclude modelselection_apply_parameter_tree.cpp
353 \li <b>../examples/documented/libshogun/modelselection_combined_kernel_sub_parameters.cpp</b>
354 \verbinclude modelselection_combined_kernel_sub_parameters.cpp
356 \li <b>../examples/documented/libshogun/modelselection_grid_search_kernel.cpp</b>
357 \verbinclude modelselection_grid_search_kernel.cpp
359 \li <b>../examples/documented/libshogun/modelselection_grid_search_krr.cpp</b>
360 \verbinclude modelselection_grid_search_krr.cpp
362 \li <b>../examples/documented/libshogun/modelselection_grid_search_linear.cpp</b>
363 \verbinclude modelselection_grid_search_linear.cpp
365 \li <b>../examples/documented/libshogun/modelselection_grid_search_mkl.cpp</b>
366 \verbinclude modelselection_grid_search_mkl.cpp
368 \li <b>../examples/documented/libshogun/modelselection_grid_search_multiclass_svm.cpp</b>
369 \verbinclude modelselection_grid_search_multiclass_svm.cpp
371 \li <b>../examples/documented/libshogun/modelselection_grid_search_string_kernel.cpp</b>
372 \verbinclude modelselection_grid_search_string_kernel.cpp
374 \li <b>../examples/documented/libshogun/modelselection_model_selection_parameters_test.cpp</b>
375 \verbinclude modelselection_model_selection_parameters_test.cpp
377 \li <b>../examples/documented/libshogun/modelselection_parameter_combination_test.cpp</b>
378 \verbinclude modelselection_parameter_combination_test.cpp
380 \li <b>../examples/documented/libshogun/modelselection_parameter_tree.cpp</b>
381 \verbinclude modelselection_parameter_tree.cpp
383 \section libshogun_optimization_examples Optimization
386 \li <b>../examples/documented/libshogun/optimization_lbfgs.cpp</b>
387 \verbinclude optimization_lbfgs.cpp
389 \section libshogun_parameter_examples Parameter
392 \li <b>../examples/documented/libshogun/parameter_iterate_float64.cpp</b>
393 \verbinclude parameter_iterate_float64.cpp
395 \li <b>../examples/documented/libshogun/parameter_iterate_sgobject.cpp</b>
396 \verbinclude parameter_iterate_sgobject.cpp
398 \li <b>../examples/documented/libshogun/parameter_modsel_parameters.cpp</b>
399 \verbinclude parameter_modsel_parameters.cpp
401 \li <b>../examples/documented/libshogun/parameter_set_from_parameters.cpp</b>
402 \verbinclude parameter_set_from_parameters.cpp
404 \section libshogun_preprocessor_examples Preprocessor
407 \li <b>../examples/documented/libshogun/preprocessor_randomfouriergauss.cpp</b>
408 \verbinclude preprocessor_randomfouriergauss.cpp
410 \section libshogun_random_examples Random
413 \li <b>../examples/documented/libshogun/random_conditional_probability_tree.cpp</b>
414 \verbinclude random_conditional_probability_tree.cpp
416 \li <b>../examples/documented/libshogun/random_fourier_features.cpp</b>
417 \verbinclude random_fourier_features.cpp
419 \section libshogun_regression_examples Regression
422 \li <b>../examples/documented/libshogun/regression_gaussian_process_ard.cpp</b>
423 \verbinclude regression_gaussian_process_ard.cpp
425 \li <b>../examples/documented/libshogun/regression_gaussian_process_fitc.cpp</b>
426 \verbinclude regression_gaussian_process_fitc.cpp
428 \li <b>../examples/documented/libshogun/regression_gaussian_process_gaussian.cpp</b>
429 \verbinclude regression_gaussian_process_gaussian.cpp
431 \li <b>../examples/documented/libshogun/regression_gaussian_process_laplace.cpp</b>
432 \verbinclude regression_gaussian_process_laplace.cpp
434 \li <b>../examples/documented/libshogun/regression_gaussian_process_product.cpp</b>
435 \verbinclude regression_gaussian_process_product.cpp
437 \li <b>../examples/documented/libshogun/regression_gaussian_process_simple_exact.cpp</b>
438 \verbinclude regression_gaussian_process_simple_exact.cpp
440 \li <b>../examples/documented/libshogun/regression_gaussian_process_sum.cpp</b>
441 \verbinclude regression_gaussian_process_sum.cpp
443 \li <b>../examples/documented/libshogun/regression_libsvr.cpp</b>
444 \verbinclude regression_libsvr.cpp
446 \section libshogun_serialization_examples Serialization
449 \li <b>../examples/documented/libshogun/serialization_basic_tests.cpp</b>
450 \verbinclude serialization_basic_tests.cpp
452 \li <b>../examples/documented/libshogun/serialization_file_formats.cpp</b>
453 \verbinclude serialization_file_formats.cpp
455 \li <b>../examples/documented/libshogun/serialization_multiclass_labels.cpp</b>
456 \verbinclude serialization_multiclass_labels.cpp
458 \section libshogun_so_examples So
461 \li <b>../examples/documented/libshogun/so_factorgraph.cpp</b>
462 \verbinclude so_factorgraph.cpp
464 \li <b>../examples/documented/libshogun/so_fg_model.cpp</b>
465 \verbinclude so_fg_model.cpp
467 \li <b>../examples/documented/libshogun/so_hmsvm_mosek_simple.cpp</b>
468 \verbinclude so_hmsvm_mosek_simple.cpp
470 \li <b>../examples/documented/libshogun/so_multiclass.cpp</b>
471 \verbinclude so_multiclass.cpp
473 \li <b>../examples/documented/libshogun/so_multiclass_BMRM.cpp</b>
474 \verbinclude so_multiclass_BMRM.cpp
476 \section libshogun_splitting_examples Splitting
479 \li <b>../examples/documented/libshogun/splitting_LOO_crossvalidation.cpp</b>
480 \verbinclude splitting_LOO_crossvalidation.cpp
482 \li <b>../examples/documented/libshogun/splitting_standard_crossvalidation.cpp</b>
483 \verbinclude splitting_standard_crossvalidation.cpp
485 \li <b>../examples/documented/libshogun/splitting_stratified_crossvalidation.cpp</b>
486 \verbinclude splitting_stratified_crossvalidation.cpp
488 \section libshogun_statistics_examples Statistics
491 \li <b>../examples/documented/libshogun/statistics_hsic.cpp</b>
492 \verbinclude statistics_hsic.cpp
494 \li <b>../examples/documented/libshogun/statistics_linear_time_mmd.cpp</b>
495 \verbinclude statistics_linear_time_mmd.cpp
497 \li <b>../examples/documented/libshogun/statistics_mmd_kernel_selection.cpp</b>
498 \verbinclude statistics_mmd_kernel_selection.cpp
500 \li <b>../examples/documented/libshogun/statistics_quadratic_time_mmd.cpp</b>
501 \verbinclude statistics_quadratic_time_mmd.cpp
503 \section libshogun_streaming_examples Streaming
506 \li <b>../examples/documented/libshogun/streaming_from_dense.cpp</b>
507 \verbinclude streaming_from_dense.cpp
509 \li <b>../examples/documented/libshogun/streaming_onlineliblinear_dense.cpp</b>
510 \verbinclude streaming_onlineliblinear_dense.cpp
512 \li <b>../examples/documented/libshogun/streaming_onlineliblinear_sparse.cpp</b>
513 \verbinclude streaming_onlineliblinear_sparse.cpp
515 \li <b>../examples/documented/libshogun/streaming_onlinesvmsgd.cpp</b>
516 \verbinclude streaming_onlinesvmsgd.cpp
518 \li <b>../examples/documented/libshogun/streaming_stringfeatures.cpp</b>
519 \verbinclude streaming_stringfeatures.cpp
521 \li <b>../examples/documented/libshogun/streaming_vowpalwabbit.cpp</b>
522 \verbinclude streaming_vowpalwabbit.cpp
524 \li <b>../examples/documented/libshogun/streaming_vwfeatures.cpp</b>
525 \verbinclude streaming_vwfeatures.cpp
527 \section libshogun_structure_examples Structure
530 \li <b>../examples/documented/libshogun/structure_discrete_hmsvm_bmrm.cpp</b>
531 \verbinclude structure_discrete_hmsvm_bmrm.cpp
533 \li <b>../examples/documented/libshogun/structure_hmsvm_mosek.cpp</b>
534 \verbinclude structure_hmsvm_mosek.cpp
536 \li <b>../examples/documented/libshogun/structure_plif_hmsvm_bmrm.cpp</b>
537 \verbinclude structure_plif_hmsvm_bmrm.cpp
539 \section libshogun_transfer_examples Transfer
542 \li <b>../examples/documented/libshogun/transfer_multitaskleastsquaresregression.cpp</b>
543 \verbinclude transfer_multitaskleastsquaresregression.cpp
545 \li <b>../examples/documented/libshogun/transfer_multitasklogisticregression.cpp</b>
546 \verbinclude transfer_multitasklogisticregression.cpp