Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EASY: clean up meta example filenames #4050

Closed
karlnapf opened this issue Dec 25, 2017 · 7 comments
Closed

EASY: clean up meta example filenames #4050

karlnapf opened this issue Dec 25, 2017 · 7 comments

Comments

@karlnapf
Copy link
Member

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
Copy link
Contributor

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 👍

@karlnapf
Copy link
Member Author

sure go for it :)

@dgkim5360
Copy link
Contributor

@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
Copy link
Member Author

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

@karlnapf
Copy link
Member Author

If you find typos, make a separate pr

dgkim5360 added a commit to dgkim5360/shogun that referenced this issue Dec 28, 2017
dgkim5360 added a commit to dgkim5360/shogun that referenced this issue Dec 28, 2017
@shivampkumar
Copy link

shivampkumar commented Dec 31, 2017

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

@karlnapf
Copy link
Member Author

Closed via #4055

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants