Skip to content

Commit

Permalink
updated reference documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Soeren Sonnenburg committed Dec 12, 2011
1 parent 7a0a00f commit 8c1f1f2
Show file tree
Hide file tree
Showing 13 changed files with 534 additions and 107 deletions.
2 changes: 1 addition & 1 deletion doc/Doxyfile_cn
View file
Expand Up @@ -31,7 +31,7 @@ PROJECT_NAME = SHOGUN
# This could be handy for archiving the generated documentation or
# if some version control system is used.

PROJECT_NUMBER = v1.0.0
PROJECT_NUMBER = v1.1.0

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
Expand Down
48 changes: 44 additions & 4 deletions doc/pages/ExamplesLibshogun.mainpage
View file
Expand Up @@ -6,13 +6,14 @@ This page lists ready to run shogun examples for the C++ libshogun interface.
\li \subpage libshogun_basic_examples
\li \subpage libshogun_classifier_examples
\li \subpage libshogun_clustering_examples
\li \subpage libshogun_converter_examples
\li \subpage libshogun_features_examples
\li \subpage libshogun_kernel_examples
\li \subpage libshogun_library_examples
\li \subpage libshogun_mathematics_examples
\li \subpage libshogun_modelselection_examples
\li \subpage libshogun_parameter_examples
\li \subpage libshogun_preproc_examples
\li \subpage libshogun_preprocessor_examples
\li \subpage libshogun_serialization_examples
\li \subpage libshogun_splitting_examples
\li \subpage libshogun_streaming_examples
Expand Down Expand Up @@ -66,6 +67,45 @@ LD_LIBRARY_PATH=path/to/libshogun ./name_of_example
\li <b>../examples/documented/libshogun/clustering_kmeans.cpp</b>
\verbinclude clustering_kmeans.cpp

\section libshogun_converter_examples Converter


\li <b>../examples/documented/libshogun/converter_diffusionmaps.cpp</b>
\verbinclude converter_diffusionmaps.cpp

\li <b>../examples/documented/libshogun/converter_hessianlocallylinearembedding.cpp</b>
\verbinclude converter_hessianlocallylinearembedding.cpp

\li <b>../examples/documented/libshogun/converter_isomap.cpp</b>
\verbinclude converter_isomap.cpp

\li <b>../examples/documented/libshogun/converter_kernellocallylinearembedding.cpp</b>
\verbinclude converter_kernellocallylinearembedding.cpp

\li <b>../examples/documented/libshogun/converter_kernellocaltangentspacealignment.cpp</b>
\verbinclude converter_kernellocaltangentspacealignment.cpp

\li <b>../examples/documented/libshogun/converter_laplacianeigenmaps.cpp</b>
\verbinclude converter_laplacianeigenmaps.cpp

\li <b>../examples/documented/libshogun/converter_linearlocaltangentspacealignment.cpp</b>
\verbinclude converter_linearlocaltangentspacealignment.cpp

\li <b>../examples/documented/libshogun/converter_localitypreservingprojections.cpp</b>
\verbinclude converter_localitypreservingprojections.cpp

\li <b>../examples/documented/libshogun/converter_locallylinearembedding.cpp</b>
\verbinclude converter_locallylinearembedding.cpp

\li <b>../examples/documented/libshogun/converter_localtangentspacealignment.cpp</b>
\verbinclude converter_localtangentspacealignment.cpp

\li <b>../examples/documented/libshogun/converter_multidimensionalscaling.cpp</b>
\verbinclude converter_multidimensionalscaling.cpp

\li <b>../examples/documented/libshogun/converter_neighborhoodpreservingembedding.cpp</b>
\verbinclude converter_neighborhoodpreservingembedding.cpp

\section libshogun_features_examples Features


Expand Down Expand Up @@ -168,11 +208,11 @@ LD_LIBRARY_PATH=path/to/libshogun ./name_of_example
\li <b>../examples/documented/libshogun/parameter_set_from_parameters.cpp</b>
\verbinclude parameter_set_from_parameters.cpp

\section libshogun_preproc_examples Preproc
\section libshogun_preprocessor_examples Preprocessor


\li <b>../examples/documented/libshogun/preproc_randomfouriergauss.cpp</b>
\verbinclude preproc_randomfouriergauss.cpp
\li <b>../examples/documented/libshogun/preprocessor_randomfouriergauss.cpp</b>
\verbinclude preprocessor_randomfouriergauss.cpp

\section libshogun_serialization_examples Serialization

Expand Down
230 changes: 228 additions & 2 deletions doc/pages/ExamplesModularCSharp.mainpage
View file
Expand Up @@ -3,11 +3,15 @@
This page lists ready to run shogun examples for the C# Modular interface.

\li \subpage csharp_modular_classifier_examples
\li \subpage csharp_modular_clustering_examples
\li \subpage csharp_modular_converter_examples
\li \subpage csharp_modular_distance_examples
\li \subpage csharp_modular_distribution_examples
\li \subpage csharp_modular_evaluation_examples
\li \subpage csharp_modular_features_examples
\li \subpage csharp_modular_kernel_examples
\li \subpage csharp_modular_minimal_examples
\li \subpage csharp_modular_mkl_examples
\li \subpage csharp_modular_preprocessor_examples
\li \subpage csharp_modular_regression_examples

Expand All @@ -23,9 +27,66 @@ LD_LIBRARY_PATH=path/to/libshogun:path/to/shogun/interfaces/csharp_modular mono
\li <b>../examples/documented/csharp_modular/classifier_averaged_perceptron_modular.cs</b>
\verbinclude classifier_averaged_perceptron_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_gaussiannaivebayes_modular.cs</b>
\verbinclude classifier_gaussiannaivebayes_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_gmnpsvm_modular.cs</b>
\verbinclude classifier_gmnpsvm_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_gpbtsvm_modular.cs</b>
\verbinclude classifier_gpbtsvm_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_knn_modular.cs</b>
\verbinclude classifier_knn_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_larank_modular.cs</b>
\verbinclude classifier_larank_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_lda_modular.cs</b>
\verbinclude classifier_lda_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_liblinear_modular.cs</b>
\verbinclude classifier_liblinear_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_libsvm_minimal_modular.cs</b>
\verbinclude classifier_libsvm_minimal_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_libsvmmulticlass_modular.cs</b>
\verbinclude classifier_libsvmmulticlass_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_libsvmoneclass_modular.cs</b>
\verbinclude classifier_libsvmoneclass_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_libsvn_modular.cs</b>
\verbinclude classifier_libsvn_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_mpdsvm_modular.cs</b>
\verbinclude classifier_mpdsvm_modular.cs

\li <b>../examples/documented/csharp_modular/classifier_perceptron_modular.cs</b>
\verbinclude classifier_perceptron_modular.cs

\section csharp_modular_clustering_examples Clustering


\li <b>../examples/documented/csharp_modular/clustering_hierarchical_modular.cs</b>
\verbinclude clustering_hierarchical_modular.cs

\li <b>../examples/documented/csharp_modular/clustering_kmeans_modular.cs</b>
\verbinclude clustering_kmeans_modular.cs

\section csharp_modular_converter_examples Converter


\li <b>../examples/documented/csharp_modular/converter_isomap_modular.cs</b>
\verbinclude converter_isomap_modular.cs

\li <b>../examples/documented/csharp_modular/converter_locallylinearembedding_modular.cs</b>
\verbinclude converter_locallylinearembedding_modular.cs

\li <b>../examples/documented/csharp_modular/converter_multidimensionalscaling_modular.cs</b>
\verbinclude converter_multidimensionalscaling_modular.cs

\section csharp_modular_distance_examples Distance


Expand All @@ -44,12 +105,21 @@ LD_LIBRARY_PATH=path/to/libshogun:path/to/shogun/interfaces/csharp_modular mono
\li <b>../examples/documented/csharp_modular/distance_cosine_modular.cs</b>
\verbinclude distance_cosine_modular.cs

\li <b>../examples/documented/csharp_modular/distance_euclidian_modular.cs</b>
\verbinclude distance_euclidian_modular.cs

\li <b>../examples/documented/csharp_modular/distance_geodesic_modular.cs</b>
\verbinclude distance_geodesic_modular.cs

\li <b>../examples/documented/csharp_modular/distance_hammingword_modular.cs</b>
\verbinclude distance_hammingword_modular.cs

\li <b>../examples/documented/csharp_modular/distance_jensen_modular.cs</b>
\verbinclude distance_jensen_modular.cs

\li <b>../examples/documented/csharp_modular/distance_manhattenword_modular.cs</b>
\verbinclude distance_manhattenword_modular.cs

\li <b>../examples/documented/csharp_modular/distance_minkowski_modular.cs</b>
\verbinclude distance_minkowski_modular.cs

Expand All @@ -59,6 +129,18 @@ LD_LIBRARY_PATH=path/to/libshogun:path/to/shogun/interfaces/csharp_modular mono
\li <b>../examples/documented/csharp_modular/distance_tanimoto_modular.cs</b>
\verbinclude distance_tanimoto_modular.cs

\section csharp_modular_distribution_examples Distribution


\li <b>../examples/documented/csharp_modular/distribution_histogram_modular.cs</b>
\verbinclude distribution_histogram_modular.cs

\li <b>../examples/documented/csharp_modular/distribution_hmm_modular.cs</b>
\verbinclude distribution_hmm_modular.cs

\li <b>../examples/documented/csharp_modular/distribution_linearhmm_modular.cs</b>
\verbinclude distribution_linearhmm_modular.cs

\section csharp_modular_evaluation_examples Evaluation


Expand All @@ -71,18 +153,126 @@ LD_LIBRARY_PATH=path/to/libshogun:path/to/shogun/interfaces/csharp_modular mono
\li <b>../examples/documented/csharp_modular/features_simple_real_modular.cs</b>
\verbinclude features_simple_real_modular.cs

\li <b>../examples/documented/csharp_modular/features_snp_modular.cs</b>
\verbinclude features_snp_modular.cs

\li <b>../examples/documented/csharp_modular/features_string_char_modular.cs</b>
\verbinclude features_string_char_modular.cs

\li <b>../examples/documented/csharp_modular/features_string_hashed_wd_modular.cs</b>
\verbinclude features_string_hashed_wd_modular.cs

\li <b>../examples/documented/csharp_modular/features_string_sliding_window_modular.cs</b>
\verbinclude features_string_sliding_window_modular.cs

\section csharp_modular_kernel_examples Kernel


\li <b>../examples/documented/csharp_modular/kernel_anova_modular.cs</b>
\verbinclude kernel_anova_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_auc_modular.cs</b>
\verbinclude kernel_auc_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_cauchy_modular.cs</b>
\verbinclude kernel_cauchy_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_chi2_modular.cs</b>
\verbinclude kernel_chi2_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_circular_modular.cs</b>
\verbinclude kernel_circular_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_combined_modular.cs</b>
\verbinclude kernel_combined_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_comm_ulong_string_modular.cs</b>
\verbinclude kernel_comm_ulong_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_const_modular.cs</b>
\verbinclude kernel_const_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_diag_modular.cs</b>
\verbinclude kernel_diag_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_distance_modular.cs</b>
\verbinclude kernel_distance_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_fixed_degree_string_modular.cs</b>
\verbinclude kernel_fixed_degree_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_gaussian_modular.cs</b>
\verbinclude kernel_gaussian_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_inversemultiquadric_modular.cs</b>
\verbinclude kernel_inversemultiquadric_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_io_modular.cs</b>
\verbinclude kernel_io_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_linear_modular.cs</b>
\verbinclude kernel_linear_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_linear_word_modular.cs</b>
\verbinclude kernel_linear_word_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_local_alignment_string_modular.cs</b>
\verbinclude kernel_local_alignment_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_locality_improved_string_modular.cs</b>
\verbinclude kernel_locality_improved_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_log_modular.cs</b>
\verbinclude kernel_log_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_match_word_string_modular.cs</b>
\verbinclude kernel_match_word_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_multiquadric_modular.cs</b>
\verbinclude kernel_multiquadric_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_oligo_string_modular.cs</b>
\verbinclude kernel_oligo_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_poly_match_string_modular.cs</b>
\verbinclude kernel_poly_match_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_poly_match_word_string_modular.cs</b>
\verbinclude kernel_poly_match_word_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_poly_modular.cs</b>
\verbinclude kernel_poly_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_power_modular.cs</b>
\verbinclude kernel_power_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_rationalquadratic_modular.cs</b>
\verbinclude kernel_rationalquadratic_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_salzberg_word_string_modular.cs</b>
\verbinclude kernel_salzberg_word_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_sigmoid_modular.cs</b>
\verbinclude kernel_sigmoid_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_spherical_modular.cs</b>
\verbinclude kernel_spherical_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_spline_modular.cs</b>
\verbinclude kernel_spline_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_tstudent_modular.cs</b>
\verbinclude kernel_tstudent_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_wave_modular.cs</b>
\verbinclude kernel_wave_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_wavelet_modular.cs</b>
\verbinclude kernel_wavelet_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_weighted_comm_word_string_modular.cs</b>
\verbinclude kernel_weighted_comm_word_string_modular.cs

\li <b>../examples/documented/csharp_modular/kernel_weighted_degree_string_modular.cs</b>
\verbinclude kernel_weighted_degree_string_modular.cs

Expand All @@ -92,15 +282,51 @@ LD_LIBRARY_PATH=path/to/libshogun:path/to/shogun/interfaces/csharp_modular mono
\li <b>../examples/documented/csharp_modular/minimal_test.cs</b>
\verbinclude minimal_test.cs

\section csharp_modular_mkl_examples Mkl


\li <b>../examples/documented/csharp_modular/mkl_binclass_modular.cs</b>
\verbinclude mkl_binclass_modular.cs

\li <b>../examples/documented/csharp_modular/mkl_multiclass_modular.cs</b>
\verbinclude mkl_multiclass_modular.cs

\section csharp_modular_preprocessor_examples Preprocessor


\li <b>../examples/documented/csharp_modular/preprocessor_isomap_modular.cs</b>
\verbinclude preprocessor_isomap_modular.cs
\li <b>../examples/documented/csharp_modular/preprocessor_kernelpca_modular.cs</b>
\verbinclude preprocessor_kernelpca_modular.cs

\li <b>../examples/documented/csharp_modular/preprocessor_logplusone_modular.cs</b>
\verbinclude preprocessor_logplusone_modular.cs

\li <b>../examples/documented/csharp_modular/preprocessor_normone_modular.cs</b>
\verbinclude preprocessor_normone_modular.cs

\li <b>../examples/documented/csharp_modular/preprocessor_pca_modular.cs</b>
\verbinclude preprocessor_pca_modular.cs

\li <b>../examples/documented/csharp_modular/preprocessor_prubevarsubmean_modular.cs</b>
\verbinclude preprocessor_prubevarsubmean_modular.cs

\li <b>../examples/documented/csharp_modular/preprocessor_randomfouriergausspreproc_modular.cs</b>
\verbinclude preprocessor_randomfouriergausspreproc_modular.cs

\li <b>../examples/documented/csharp_modular/preprocessor_sortulongstring_modular.cs</b>
\verbinclude preprocessor_sortulongstring_modular.cs

\li <b>../examples/documented/csharp_modular/preprocessor_sortwordstring_modular.cs</b>
\verbinclude preprocessor_sortwordstring_modular.cs

\section csharp_modular_regression_examples Regression


\li <b>../examples/documented/csharp_modular/regression_krr_modular.cs</b>
\verbinclude regression_krr_modular.cs

\li <b>../examples/documented/csharp_modular/regression_libsvr_modular.cs</b>
\verbinclude regression_libsvr_modular.cs

\li <b>../examples/documented/csharp_modular/regression_svrlight_modular.cs</b>
\verbinclude regression_svrlight_modular.cs
*/

0 comments on commit 8c1f1f2

Please sign in to comment.