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_basic_examples
7 \li \subpage libshogun_classifier_examples
8 \li \subpage libshogun_clustering_examples
9 \li \subpage libshogun_converter_examples
10 \li \subpage libshogun_evaluation_examples
11 \li \subpage libshogun_features_examples
12 \li \subpage libshogun_hashed_examples
13 \li \subpage libshogun_io_examples
14 \li \subpage libshogun_kernel_examples
15 \li \subpage libshogun_labels_examples
16 \li \subpage libshogun_library_examples
17 \li \subpage libshogun_mathematics_examples
18 \li \subpage libshogun_metric_examples
19 \li \subpage libshogun_modelselection_examples
20 \li \subpage libshogun_neuralnets_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
33 \li \subpage libshogun_variational_examples
35 To run the examples you will need to manually compile them via
37 g++ name_of_example.cpp -lshogun
40 in case you installed libshogun to a nonstandard directory you will need to specify the appropriate library and include paths, e.g.
42 g++ -I/path/to/libshogun/includes name_of_example.cpp -L/path/to/libshogun/sofile -lshogun
45 Then the examples are standard binary executables and can be started via
49 respectively if the libraries are in nonstandard locations (such that they cannot be found by the dynamic linker)
51 LD_LIBRARY_PATH=path/to/libshogun ./name_of_example
54 \section libshogun_balanced_examples Balanced
57 \li <b>examples/documented/libshogun/balanced_conditional_probability_tree.cpp</b>
58 \verbinclude balanced_conditional_probability_tree.cpp
60 \section libshogun_basic_examples Basic
63 \li <b>examples/documented/libshogun/basic_minimal.cpp</b>
64 \verbinclude basic_minimal.cpp
66 \section libshogun_classifier_examples Classifier
69 \li <b>examples/documented/libshogun/classifier_bagging_liblinear.cpp</b>
70 \verbinclude classifier_bagging_liblinear.cpp
72 \li <b>examples/documented/libshogun/classifier_featureblocklogisticregression.cpp</b>
73 \verbinclude classifier_featureblocklogisticregression.cpp
75 \li <b>examples/documented/libshogun/classifier_gaussian_process_binary_classification.cpp</b>
76 \verbinclude classifier_gaussian_process_binary_classification.cpp
78 \li <b>examples/documented/libshogun/classifier_gaussiannaivebayes.cpp</b>
79 \verbinclude classifier_gaussiannaivebayes.cpp
81 \li <b>examples/documented/libshogun/classifier_knn.cpp</b>
82 \verbinclude classifier_knn.cpp
84 \li <b>examples/documented/libshogun/classifier_larank.cpp</b>
85 \verbinclude classifier_larank.cpp
87 \li <b>examples/documented/libshogun/classifier_latent_svm.cpp</b>
88 \verbinclude classifier_latent_svm.cpp
90 \li <b>examples/documented/libshogun/classifier_lda.cpp</b>
91 \verbinclude classifier_lda.cpp
93 \li <b>examples/documented/libshogun/classifier_libsvm.cpp</b>
94 \verbinclude classifier_libsvm.cpp
96 \li <b>examples/documented/libshogun/classifier_libsvm_probabilities.cpp</b>
97 \verbinclude classifier_libsvm_probabilities.cpp
99 \li <b>examples/documented/libshogun/classifier_minimal_svm.cpp</b>
100 \verbinclude classifier_minimal_svm.cpp
102 \li <b>examples/documented/libshogun/classifier_mkl_svmlight_modelselection_bug.cpp</b>
103 \verbinclude classifier_mkl_svmlight_modelselection_bug.cpp
105 \li <b>examples/documented/libshogun/classifier_mklmulticlass.cpp</b>
106 \verbinclude classifier_mklmulticlass.cpp
108 \li <b>examples/documented/libshogun/classifier_multiclass_ecoc.cpp</b>
109 \verbinclude classifier_multiclass_ecoc.cpp
111 \li <b>examples/documented/libshogun/classifier_multiclass_ecoc_discriminant.cpp</b>
112 \verbinclude classifier_multiclass_ecoc_discriminant.cpp
114 \li <b>examples/documented/libshogun/classifier_multiclass_ecoc_random.cpp</b>
115 \verbinclude classifier_multiclass_ecoc_random.cpp
117 \li <b>examples/documented/libshogun/classifier_multiclass_prob_heuristics.cpp</b>
118 \verbinclude classifier_multiclass_prob_heuristics.cpp
120 \li <b>examples/documented/libshogun/classifier_multiclass_relaxedtree.cpp</b>
121 \verbinclude classifier_multiclass_relaxedtree.cpp
123 \li <b>examples/documented/libshogun/classifier_multiclass_shareboost.cpp</b>
124 \verbinclude classifier_multiclass_shareboost.cpp
126 \li <b>examples/documented/libshogun/classifier_multiclasslibsvm.cpp</b>
127 \verbinclude classifier_multiclasslibsvm.cpp
129 \li <b>examples/documented/libshogun/classifier_multiclasslinearmachine.cpp</b>
130 \verbinclude classifier_multiclasslinearmachine.cpp
132 \li <b>examples/documented/libshogun/classifier_nearest_centroid.cpp</b>
133 \verbinclude classifier_nearest_centroid.cpp
135 \li <b>examples/documented/libshogun/classifier_newtontest.cpp</b>
136 \verbinclude classifier_newtontest.cpp
138 \li <b>examples/documented/libshogun/classifier_qda.cpp</b>
139 \verbinclude classifier_qda.cpp
141 \li <b>examples/documented/libshogun/classifier_svmlight_string_features_precomputed_kernel.cpp</b>
142 \verbinclude classifier_svmlight_string_features_precomputed_kernel.cpp
144 \section libshogun_clustering_examples Clustering
147 \li <b>examples/documented/libshogun/clustering_kmeans.cpp</b>
148 \verbinclude clustering_kmeans.cpp
150 \section libshogun_converter_examples Converter
153 \li <b>examples/documented/libshogun/converter_diffusionmaps.cpp</b>
154 \verbinclude converter_diffusionmaps.cpp
156 \li <b>examples/documented/libshogun/converter_factoranalysis.cpp</b>
157 \verbinclude converter_factoranalysis.cpp
159 \li <b>examples/documented/libshogun/converter_hessianlocallylinearembedding.cpp</b>
160 \verbinclude converter_hessianlocallylinearembedding.cpp
162 \li <b>examples/documented/libshogun/converter_isomap.cpp</b>
163 \verbinclude converter_isomap.cpp
165 \li <b>examples/documented/libshogun/converter_jade_bss.cpp</b>
166 \verbinclude converter_jade_bss.cpp
168 \li <b>examples/documented/libshogun/converter_kernellocallylinearembedding.cpp</b>
169 \verbinclude converter_kernellocallylinearembedding.cpp
171 \li <b>examples/documented/libshogun/converter_laplacianeigenmaps.cpp</b>
172 \verbinclude converter_laplacianeigenmaps.cpp
174 \li <b>examples/documented/libshogun/converter_linearlocaltangentspacealignment.cpp</b>
175 \verbinclude converter_linearlocaltangentspacealignment.cpp
177 \li <b>examples/documented/libshogun/converter_localitypreservingprojections.cpp</b>
178 \verbinclude converter_localitypreservingprojections.cpp
180 \li <b>examples/documented/libshogun/converter_locallylinearembedding.cpp</b>
181 \verbinclude converter_locallylinearembedding.cpp
183 \li <b>examples/documented/libshogun/converter_localtangentspacealignment.cpp</b>
184 \verbinclude converter_localtangentspacealignment.cpp
186 \li <b>examples/documented/libshogun/converter_multidimensionalscaling.cpp</b>
187 \verbinclude converter_multidimensionalscaling.cpp
189 \li <b>examples/documented/libshogun/converter_neighborhoodpreservingembedding.cpp</b>
190 \verbinclude converter_neighborhoodpreservingembedding.cpp
192 \li <b>examples/documented/libshogun/converter_stochasticproximityembedding.cpp</b>
193 \verbinclude converter_stochasticproximityembedding.cpp
195 \section libshogun_evaluation_examples Evaluation
198 \li <b>examples/documented/libshogun/evaluation_cross_validation_classification.cpp</b>
199 \verbinclude evaluation_cross_validation_classification.cpp
201 \li <b>examples/documented/libshogun/evaluation_cross_validation_knn.cpp</b>
202 \verbinclude evaluation_cross_validation_knn.cpp
204 \li <b>examples/documented/libshogun/evaluation_cross_validation_locked_comparison.cpp</b>
205 \verbinclude evaluation_cross_validation_locked_comparison.cpp
207 \li <b>examples/documented/libshogun/evaluation_cross_validation_mkl_weight_storage.cpp</b>
208 \verbinclude evaluation_cross_validation_mkl_weight_storage.cpp
210 \li <b>examples/documented/libshogun/evaluation_cross_validation_multiclass.cpp</b>
211 \verbinclude evaluation_cross_validation_multiclass.cpp
213 \li <b>examples/documented/libshogun/evaluation_cross_validation_multiclass_mkl.cpp</b>
214 \verbinclude evaluation_cross_validation_multiclass_mkl.cpp
216 \li <b>examples/documented/libshogun/evaluation_cross_validation_regression.cpp</b>
217 \verbinclude evaluation_cross_validation_regression.cpp
219 \section libshogun_features_examples Features
222 \li <b>examples/documented/libshogun/features_copy_subset_simple_features.cpp</b>
223 \verbinclude features_copy_subset_simple_features.cpp
225 \li <b>examples/documented/libshogun/features_copy_subset_sparse_features.cpp</b>
226 \verbinclude features_copy_subset_sparse_features.cpp
228 \li <b>examples/documented/libshogun/features_dense_real_modular.cpp</b>
229 \verbinclude features_dense_real_modular.cpp
231 \li <b>examples/documented/libshogun/features_subset_labels.cpp</b>
232 \verbinclude features_subset_labels.cpp
234 \li <b>examples/documented/libshogun/features_subset_simple_features.cpp</b>
235 \verbinclude features_subset_simple_features.cpp
237 \li <b>examples/documented/libshogun/features_subset_stack.cpp</b>
238 \verbinclude features_subset_stack.cpp
240 \section libshogun_hashed_examples Hashed
243 \li <b>examples/documented/libshogun/hashed_features_example.cpp</b>
244 \verbinclude hashed_features_example.cpp
246 \section libshogun_io_examples Io
249 \li <b>examples/documented/libshogun/io_libsvm_multilabel.cpp</b>
250 \verbinclude io_libsvm_multilabel.cpp
252 \li <b>examples/documented/libshogun/io_linereader.cpp</b>
253 \verbinclude io_linereader.cpp
255 \section libshogun_kernel_examples Kernel
258 \li <b>examples/documented/libshogun/kernel_custom.cpp</b>
259 \verbinclude kernel_custom.cpp
261 \li <b>examples/documented/libshogun/kernel_custom_index.cpp</b>
262 \verbinclude kernel_custom_index.cpp
264 \li <b>examples/documented/libshogun/kernel_custom_kernel.cpp</b>
265 \verbinclude kernel_custom_kernel.cpp
267 \li <b>examples/documented/libshogun/kernel_gaussian.cpp</b>
268 \verbinclude kernel_gaussian.cpp
270 \li <b>examples/documented/libshogun/kernel_machine_train_locked.cpp</b>
271 \verbinclude kernel_machine_train_locked.cpp
273 \li <b>examples/documented/libshogun/kernel_revlin.cpp</b>
274 \verbinclude kernel_revlin.cpp
276 \section libshogun_labels_examples Labels
279 \li <b>examples/documented/libshogun/labels_binary_fit_sigmoid.cpp</b>
280 \verbinclude labels_binary_fit_sigmoid.cpp
282 \section libshogun_library_examples Library
285 \li <b>examples/documented/libshogun/library_circularbuffer.cpp</b>
286 \verbinclude library_circularbuffer.cpp
288 \li <b>examples/documented/libshogun/library_dyn_int.cpp</b>
289 \verbinclude library_dyn_int.cpp
291 \li <b>examples/documented/libshogun/library_dynarray.cpp</b>
292 \verbinclude library_dynarray.cpp
294 \li <b>examples/documented/libshogun/library_gc_array.cpp</b>
295 \verbinclude library_gc_array.cpp
297 \li <b>examples/documented/libshogun/library_hash.cpp</b>
298 \verbinclude library_hash.cpp
300 \li <b>examples/documented/libshogun/library_hdf5.cpp</b>
301 \verbinclude library_hdf5.cpp
303 \li <b>examples/documented/libshogun/library_indirect_object.cpp</b>
304 \verbinclude library_indirect_object.cpp
306 \li <b>examples/documented/libshogun/library_map.cpp</b>
307 \verbinclude library_map.cpp
309 \li <b>examples/documented/libshogun/library_mldatahdf5.cpp</b>
310 \verbinclude library_mldatahdf5.cpp
312 \li <b>examples/documented/libshogun/library_serialization.cpp</b>
313 \verbinclude library_serialization.cpp
315 \li <b>examples/documented/libshogun/library_set.cpp</b>
316 \verbinclude library_set.cpp
318 \section libshogun_mathematics_examples Mathematics
321 \li <b>examples/documented/libshogun/mathematics_confidence_intervals.cpp</b>
322 \verbinclude mathematics_confidence_intervals.cpp
324 \li <b>examples/documented/libshogun/mathematics_lapack.cpp</b>
325 \verbinclude mathematics_lapack.cpp
327 \section libshogun_metric_examples Metric
330 \li <b>examples/documented/libshogun/metric_lmnnn.cpp</b>
331 \verbinclude metric_lmnnn.cpp
333 \section libshogun_modelselection_examples Modelselection
336 \li <b>examples/documented/libshogun/modelselection_apply_parameter_tree.cpp</b>
337 \verbinclude modelselection_apply_parameter_tree.cpp
339 \li <b>examples/documented/libshogun/modelselection_combined_kernel_sub_parameters.cpp</b>
340 \verbinclude modelselection_combined_kernel_sub_parameters.cpp
342 \li <b>examples/documented/libshogun/modelselection_grid_search_kernel.cpp</b>
343 \verbinclude modelselection_grid_search_kernel.cpp
345 \li <b>examples/documented/libshogun/modelselection_grid_search_krr.cpp</b>
346 \verbinclude modelselection_grid_search_krr.cpp
348 \li <b>examples/documented/libshogun/modelselection_grid_search_linear.cpp</b>
349 \verbinclude modelselection_grid_search_linear.cpp
351 \li <b>examples/documented/libshogun/modelselection_grid_search_mkl.cpp</b>
352 \verbinclude modelselection_grid_search_mkl.cpp
354 \li <b>examples/documented/libshogun/modelselection_grid_search_multiclass_svm.cpp</b>
355 \verbinclude modelselection_grid_search_multiclass_svm.cpp
357 \li <b>examples/documented/libshogun/modelselection_grid_search_string_kernel.cpp</b>
358 \verbinclude modelselection_grid_search_string_kernel.cpp
360 \li <b>examples/documented/libshogun/modelselection_model_selection_parameters_test.cpp</b>
361 \verbinclude modelselection_model_selection_parameters_test.cpp
363 \li <b>examples/documented/libshogun/modelselection_parameter_combination_test.cpp</b>
364 \verbinclude modelselection_parameter_combination_test.cpp
366 \li <b>examples/documented/libshogun/modelselection_parameter_tree.cpp</b>
367 \verbinclude modelselection_parameter_tree.cpp
369 \section libshogun_neuralnets_examples Neuralnets
372 \li <b>examples/documented/libshogun/neuralnets_basic.cpp</b>
373 \verbinclude neuralnets_basic.cpp
375 \li <b>examples/documented/libshogun/neuralnets_convolutional.cpp</b>
376 \verbinclude neuralnets_convolutional.cpp
378 \li <b>examples/documented/libshogun/neuralnets_deep_autoencoder.cpp</b>
379 \verbinclude neuralnets_deep_autoencoder.cpp
381 \li <b>examples/documented/libshogun/neuralnets_deep_belief_network.cpp</b>
382 \verbinclude neuralnets_deep_belief_network.cpp
384 \section libshogun_optimization_examples Optimization
387 \li <b>examples/documented/libshogun/optimization_lbfgs.cpp</b>
388 \verbinclude optimization_lbfgs.cpp
390 \section libshogun_parameter_examples Parameter
393 \li <b>examples/documented/libshogun/parameter_iterate_float64.cpp</b>
394 \verbinclude parameter_iterate_float64.cpp
396 \li <b>examples/documented/libshogun/parameter_iterate_sgobject.cpp</b>
397 \verbinclude parameter_iterate_sgobject.cpp
399 \li <b>examples/documented/libshogun/parameter_modsel_parameters.cpp</b>
400 \verbinclude parameter_modsel_parameters.cpp
402 \li <b>examples/documented/libshogun/parameter_set_from_parameters.cpp</b>
403 \verbinclude parameter_set_from_parameters.cpp
405 \section libshogun_preprocessor_examples Preprocessor
408 \li <b>examples/documented/libshogun/preprocessor_fisherlda.cpp</b>
409 \verbinclude preprocessor_fisherlda.cpp
411 \li <b>examples/documented/libshogun/preprocessor_randomfouriergauss.cpp</b>
412 \verbinclude preprocessor_randomfouriergauss.cpp
414 \section libshogun_random_examples Random
417 \li <b>examples/documented/libshogun/random_conditional_probability_tree.cpp</b>
418 \verbinclude random_conditional_probability_tree.cpp
420 \li <b>examples/documented/libshogun/random_fourier_features.cpp</b>
421 \verbinclude random_fourier_features.cpp
423 \section libshogun_regression_examples Regression
426 \li <b>examples/documented/libshogun/regression_gaussian_process_ard.cpp</b>
427 \verbinclude regression_gaussian_process_ard.cpp
429 \li <b>examples/documented/libshogun/regression_gaussian_process_fitc.cpp</b>
430 \verbinclude regression_gaussian_process_fitc.cpp
432 \li <b>examples/documented/libshogun/regression_gaussian_process_gaussian.cpp</b>
433 \verbinclude regression_gaussian_process_gaussian.cpp
435 \li <b>examples/documented/libshogun/regression_gaussian_process_laplace.cpp</b>
436 \verbinclude regression_gaussian_process_laplace.cpp
438 \li <b>examples/documented/libshogun/regression_gaussian_process_product.cpp</b>
439 \verbinclude regression_gaussian_process_product.cpp
441 \li <b>examples/documented/libshogun/regression_gaussian_process_simple_exact.cpp</b>
442 \verbinclude regression_gaussian_process_simple_exact.cpp
444 \li <b>examples/documented/libshogun/regression_gaussian_process_sum.cpp</b>
445 \verbinclude regression_gaussian_process_sum.cpp
447 \li <b>examples/documented/libshogun/regression_libsvr.cpp</b>
448 \verbinclude regression_libsvr.cpp
450 \section libshogun_serialization_examples Serialization
453 \li <b>examples/documented/libshogun/serialization_basic_tests.cpp</b>
454 \verbinclude serialization_basic_tests.cpp
456 \li <b>examples/documented/libshogun/serialization_file_formats.cpp</b>
457 \verbinclude serialization_file_formats.cpp
459 \li <b>examples/documented/libshogun/serialization_multiclass_labels.cpp</b>
460 \verbinclude serialization_multiclass_labels.cpp
462 \section libshogun_so_examples So
465 \li <b>examples/documented/libshogun/so_factorgraph.cpp</b>
466 \verbinclude so_factorgraph.cpp
468 \li <b>examples/documented/libshogun/so_fg_model.cpp</b>
469 \verbinclude so_fg_model.cpp
471 \li <b>examples/documented/libshogun/so_fg_multilabel.cpp</b>
472 \verbinclude so_fg_multilabel.cpp
474 \li <b>examples/documented/libshogun/so_hmsvm_mosek_simple.cpp</b>
475 \verbinclude so_hmsvm_mosek_simple.cpp
477 \li <b>examples/documented/libshogun/so_multiclass.cpp</b>
478 \verbinclude so_multiclass.cpp
480 \li <b>examples/documented/libshogun/so_multiclass_BMRM.cpp</b>
481 \verbinclude so_multiclass_BMRM.cpp
483 \li <b>examples/documented/libshogun/so_multilabel.cpp</b>
484 \verbinclude so_multilabel.cpp
486 \section libshogun_splitting_examples Splitting
489 \li <b>examples/documented/libshogun/splitting_LOO_crossvalidation.cpp</b>
490 \verbinclude splitting_LOO_crossvalidation.cpp
492 \li <b>examples/documented/libshogun/splitting_standard_crossvalidation.cpp</b>
493 \verbinclude splitting_standard_crossvalidation.cpp
495 \li <b>examples/documented/libshogun/splitting_stratified_crossvalidation.cpp</b>
496 \verbinclude splitting_stratified_crossvalidation.cpp
498 \section libshogun_statistics_examples Statistics
501 \li <b>examples/documented/libshogun/statistics_hsic.cpp</b>
502 \verbinclude statistics_hsic.cpp
504 \li <b>examples/documented/libshogun/statistics_linear_time_mmd.cpp</b>
505 \verbinclude statistics_linear_time_mmd.cpp
507 \li <b>examples/documented/libshogun/statistics_mmd_kernel_selection.cpp</b>
508 \verbinclude statistics_mmd_kernel_selection.cpp
510 \li <b>examples/documented/libshogun/statistics_quadratic_time_mmd.cpp</b>
511 \verbinclude statistics_quadratic_time_mmd.cpp
513 \section libshogun_streaming_examples Streaming
516 \li <b>examples/documented/libshogun/streaming_from_dense.cpp</b>
517 \verbinclude streaming_from_dense.cpp
519 \li <b>examples/documented/libshogun/streaming_onlineliblinear_dense.cpp</b>
520 \verbinclude streaming_onlineliblinear_dense.cpp
522 \li <b>examples/documented/libshogun/streaming_onlineliblinear_sparse.cpp</b>
523 \verbinclude streaming_onlineliblinear_sparse.cpp
525 \li <b>examples/documented/libshogun/streaming_onlinesvmsgd.cpp</b>
526 \verbinclude streaming_onlinesvmsgd.cpp
528 \li <b>examples/documented/libshogun/streaming_stringfeatures.cpp</b>
529 \verbinclude streaming_stringfeatures.cpp
531 \li <b>examples/documented/libshogun/streaming_vowpalwabbit.cpp</b>
532 \verbinclude streaming_vowpalwabbit.cpp
534 \li <b>examples/documented/libshogun/streaming_vwfeatures.cpp</b>
535 \verbinclude streaming_vwfeatures.cpp
537 \section libshogun_structure_examples Structure
540 \li <b>examples/documented/libshogun/structure_discrete_hmsvm_bmrm.cpp</b>
541 \verbinclude structure_discrete_hmsvm_bmrm.cpp
543 \li <b>examples/documented/libshogun/structure_hmsvm_mosek.cpp</b>
544 \verbinclude structure_hmsvm_mosek.cpp
546 \li <b>examples/documented/libshogun/structure_plif_hmsvm_bmrm.cpp</b>
547 \verbinclude structure_plif_hmsvm_bmrm.cpp
549 \section libshogun_transfer_examples Transfer
552 \li <b>examples/documented/libshogun/transfer_multitaskleastsquaresregression.cpp</b>
553 \verbinclude transfer_multitaskleastsquaresregression.cpp
555 \li <b>examples/documented/libshogun/transfer_multitasklogisticregression.cpp</b>
556 \verbinclude transfer_multitasklogisticregression.cpp
558 \section libshogun_variational_examples Variational
561 \li <b>examples/documented/libshogun/variational_approx_example.cpp</b>
562 \verbinclude variational_approx_example.cpp