From b7b46bb4f579f63a27725dbc41ffba287ef7c428 Mon Sep 17 00:00:00 2001 From: Ryan Curtin Date: Sat, 9 Mar 2019 23:52:09 -0500 Subject: [PATCH] Refactor core.hpp and CONTRIBUTORS.md. These work a little bit better for the new website (I think). --- CONTRIBUTING.md | 7 +- src/mlpack/core.hpp | 214 ++------------------------------------------ 2 files changed, 12 insertions(+), 209 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bcfa999f6a..d8b7b3df44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,9 @@ # Contributing to mlpack -Anyone is welcome to contribute to mlpack and join the community. If you would -like to make improvements to the library or have found a bug that you know how -to fix, please submit a pull request! +mlpack is a community-led project; that means that anyone is welcome to +contribute to mlpack and join the community! If you would like to make +improvements to the library, add new features that are useful to you and others, +or have found a bug that you know how to fix, please submit a pull request! If you would like to learn more about how to get started contributing, see [Getting Involved](http://www.mlpack.org/involved.html), and if you are diff --git a/src/mlpack/core.hpp b/src/mlpack/core.hpp index 59d39b1db5..f3aea09d5d 100644 --- a/src/mlpack/core.hpp +++ b/src/mlpack/core.hpp @@ -21,13 +21,7 @@ * bindings to other languages. It is meant to be a machine learning analog to * LAPACK, and aims to implement a wide array of machine learning methods and * function as a "swiss army knife" for machine learning researchers. The - * mlpack development website can be found at http://mlpack.org. - * - * mlpack uses the Armadillo C++ matrix library (http://arma.sourceforge.net) - * for general matrix, vector, and linear algebra support. mlpack also uses the - * program_options, math_c99, and unit_test_framework components of the Boost - * library, and optionally uses libbfd and libdl to give backtraces when - * compiled with debugging symbols on some platforms. + * mlpack website can be found at http://mlpack.org. * * @section howto How To Use This Documentation * @@ -39,58 +33,14 @@ * browsing the list of namespaces provides some insight as to the breadth of * the methods contained in the library. * - * To generate this documentation in your own local copy of mlpack, you can - * simply use Doxygen, from the root directory of the project: + * To generate this documentation in your own local copy of mlpack, you can use + * the 'doc' CMake target, which is available if CMake has found Doxygen, from + * the build directory: * * @code - * $ doxygen + * $ make doc * @endcode * - * @section executables Executables - * - * mlpack provides several executables so that mlpack methods can be used - * without any need for knowledge of C++. These executables are all - * self-documented, and that documentation can be accessed by running the - * executables with the '-h' or '--help' flag. - * - * A full list of executables is given below: - * - * - mlpack_adaboost - * - mlpack_approx_kfn - * - mlpack_cf - * - mlpack_decision_stump - * - mlpack_decision_tree - * - mlpack_det - * - mlpack_emst - * - mlpack_fastmks - * - mlpack_gmm_train - * - mlpack_gmm_generate - * - mlpack_gmm_probability - * - mlpack_hmm_train - * - mlpack_hmm_loglik - * - mlpack_hmm_viterbi - * - mlpack_hmm_generate - * - mlpack_hoeffding_tree - * - mlpack_kernel_pca - * - mlpack_kfn - * - mlpack_kmeans - * - mlpack_knn - * - mlpack_krann - * - mlpack_lars - * - mlpack_linear_regression - * - mlpack_local_coordinate_coding - * - mlpack_logistic_regression - * - mlpack_lsh - * - mlpack_mean_shift - * - mlpack_nbc - * - mlpack_nca - * - mlpack_pca - * - mlpack_perceptron - * - mlpack_radical - * - mlpack_range_search - * - mlpack_softmax_regression - * - mlpack_sparse_coding - * * @section tutorial Tutorials * * A few short tutorials on how to use mlpack are given below. @@ -106,159 +56,11 @@ * - @ref hpt * - @ref verinfo * - * Tutorials on specific methods are also available. - * - * - @ref nstutorial - * - @ref lrtutorial - * - @ref rstutorial - * - @ref dettutorial - * - @ref emst_tutorial - * - @ref kmtutorial - * - @ref fmkstutorial - * - @ref amftutorial - * - * @section methods Methods in mlpack - * - * The following methods are included in mlpack: - * - * - Density Estimation Trees - mlpack::det::DTree - * - Euclidean Minimum Spanning Trees - mlpack::emst::DualTreeBoruvka - * - Gaussian Mixture Models (GMMs) - mlpack::gmm::GMM - * - Hidden Markov Models (HMMs) - mlpack::hmm::HMM - * - Kernel PCA - mlpack::kpca::KernelPCA - * - K-Means Clustering - mlpack::kmeans::KMeans - * - Least-Angle Regression (LARS/LASSO) - mlpack::regression::LARS - * - Local Coordinate Coding - mlpack::lcc::LocalCoordinateCoding - * - Locality-Sensitive Hashing - mlpack::neighbor::LSHSearch - * - Naive Bayes Classifier - mlpack::naive_bayes::NaiveBayesClassifier - * - Neighborhood Components Analysis (NCA) - mlpack::nca::NCA - * - Principal Components Analysis (PCA) - mlpack::pca::PCA - * - RADICAL (ICA) - mlpack::radical::Radical - * - Simple Least-Squares Linear Regression - - * mlpack::regression::LinearRegression - * - Sparse Coding - mlpack::sparse_coding::SparseCoding - * - Tree-based neighbor search (KNN, KFN) - mlpack::neighbor::NeighborSearch - * - Tree-based range search - mlpack::range::RangeSearch - * * @section remarks Final Remarks * - * mlpack contributors include: - * - * - Ryan Curtin - * - James Cline - * - Neil Slagle - * - Matthew Amidon - * - Vlad Grantcharov - * - Ajinkya Kale - * - Bill March - * - Dongryeol Lee - * - Nishant Mehta - * - Parikshit Ram - * - Rajendran Mohan - * - Trironk Kiatkungwanglai - * - Patrick Mason - * - Chip Mappus - * - Hua Ouyang - * - Long Quoc Tran - * - Noah Kauffman - * - Guillermo Colon - * - Wei Guan - * - Ryan Riegel - * - Nikolaos Vasiloglou - * - Garry Boyer - * - Andreas Löf - * - Marcus Edel - * - Mudit Raj Gupta - * - Sumedh Ghaisas - * - Michael Fox - * - Ryan Birmingham - * - Siddharth Agrawal - * - Saheb Motiani - * - Yash Vadalia - * - Abhishek Laddha - * - Vahab Akbarzadeh - * - Andrew Wells - * - Zhihao Lou - * - Udit Saxena - * - Stephen Tu - * - Jaskaran Singh - * - Shangtong Zhang - * - Hritik Jain - * - Vladimir Glazachev - * - QiaoAn Chen - * - Janzen Brewer - * - Trung Dinh - * - Tham Ngap Wei - * - Grzegorz Krajewski - * - Joseph Mariadassou - * - Pavel Zhigulin - * - Andy Fang - * - Barak Pearlmutter - * - Ivari Horm - * - Dhawal Arora - * - Alexander Leinoff - * - Palash Ahuja - * - Yannis Mentekidis - * - Ranjan Mondal - * - Mikhail Lozhnikov - * - Marcos Pividori - * - Keon Kim - * - Nilay Jain - * - Peter Lehner - * - Anuraj Kanodia - * - Ivan Georgiev - * - Shikhar Bhardwaj - * - Yashu Seth - * - Mike Izbicki - * - Sudhanshu Ranjan - * - Piyush Jaiswal - * - Dinesh Raj - * - Prasanna Patil - * - Lakshya Agrawal - * - Vivek Pal - * - Praveen Ch - * - Kirill Mishchenko - * - Abhinav Moudgil - * - Thyrix Yang - * - Sagar B Hathwar - * - Nishanth Hegde - * - Parminder Singh - * - CodeAi (deep learning bug detector) - * - Franciszek Stokowacki - * - Samikshya Chand - * - N Rajiv Vaidyanathan - * - Kartik Nighania - * - Eugene Freyman - * - Manish Kumar - * - Haritha Sreedharan Nair - * - Sourabh Varshney - * - Projyal Dev - * - Nikhil Goel - * - Shikhar Jaiswal - * - B Kartheek Reddy - * - Atharva Khandait - * - Wenhao Huang - * - Roberto Hueso - * - Prabhat Sharma - * - Tan Jun An - * - Moksh Jain - * - Manthan-R-Sheth - * - Namrata Mukhija - * - Rohan Raj - * - Conrad Sanderson - * - Thanasis Mattas - * - Shashank Shekhar - * - Yasmine Dumouchel - * - German Lancioni - * - Arash Abghari - * - Ayush Chamoli - * - Tommi Laivamaa - * - Kim SangYeon - * - Niteya Shah - * - Bhavya Bahl - * - Toshal Agrawal - * - Dan Timson - * - Miguel Canteras + * For the list of contributors to mlpack, see + * http://www.mlpack.org/contributors.html. This library would not be possible + * without everyone's hard work and contributions! */ // First, include all of the prerequisites.