shogun-toolbox / shogun

Shōgun
http://shogun-toolbox.org
BSD 3-Clause "New" or "Revised" License
3.03k stars 1.04k forks source link

EASY: clean up meta example filenames #4050

Closed karlnapf closed 6 years ago

karlnapf commented 6 years ago

folders: gaussian_processes -> gaussian_process multiclass_classifier -> multiclass binary_classifier -> binary

no folder names inside the program listing names, e.g. gaussian_process_classifier -> classifier multiclass_linearmachine -> linear sparse_gaussian_process_regression -> sparse_regression multiclass_logisticregression -> logistic_regression

no abbreviations svm -> support_vector_machine knn -> k_nearest_neighbors

etc.

Make sure to change the cookbook filenames in doc/cookbook as well (try your changes with make cookbook)

Good way to learn about the examples in Shogun while cleaning up a bit

dgkim5360 commented 6 years ago

Hello, newbie here. May I work on this one? I managed to compile and install it on my Ubuntu machine, and it looks appropriate for me to do the first steps.

Thanks for the beginner-friendly issues :+1:

karlnapf commented 6 years ago

sure go for it :)

dgkim5360 commented 6 years ago

@karlnapf while working on the cookbook, I found some minor typos, e.g., in /doc/cookbook/source/examples/multiclass/k_nearest_neighbours.rst

diff --git a/doc/cookbook/source/examples/multiclass/k_nearest_neighbours.rst b/doc/cookbook/source/examples/multiclass/k_nearest_neighbours.rst
index 58d6c6f..b0888ce 100644
--- a/doc/cookbook/source/examples/multiclass/k_nearest_neighbours.rst
+++ b/doc/cookbook/source/examples/multiclass/k_nearest_neighbours.rst
@@ -8,7 +8,7 @@ For :math:`k=1`, the label for a test point :math:`x^*` is predicted to be the s

 .. math::

-   k=\argmin_j d(x^*, x_j).  
+   k=\arg\min_j d(x^*, x_j).  

 See Chapter 14 in :cite:`barber2012bayesian` for a detailed introduction.

Should I include such corrections, or just leave them untouched and commit for the original task?

karlnapf commented 6 years ago

Argmin should be defined. Check the cookbook readme it tell you where to put custom latex

karlnapf commented 6 years ago

If you find typos, make a separate pr

shivampkumar commented 6 years ago

Just starting out with Shogun. I will go with this one first...Is that cool? Or has it been handled?

karlnapf commented 6 years ago

Closed via #4055