Skip to content

jp-um/machine_learning_handbook

Repository files navigation

NOTE OF IMPORTANCE

Your work is not considered as submitted until your entry appears in the handbook .pdf file in my repository (master branch).

A Machine Learning Handbook

A student-sourced Machine Learning Handbook for ICS5110. Instructions for submission:

  1. Clone the repository
  2. Edit the ics5110_ml_handbook.tex file
    • Find the TODO labels inside this file (3 instances), change/add your stuff accordingly
  3. Add your term file and bibliography to the terms directory. This should have the form of term_initials.tex where term is your actual term and initials are your initials (e.g. overfitting_jpe.tex). Also add your bibliography (i.e. term_initials.bib) there.
  4. Create a pull request (read here for more details)

Submit as early as possible as you are bound to get feedback on your work (no need to wait for the deadline, everyone is doing something different anyway). Don't expect to get feedback if you submit your work close to the deadline

If you do not see your entry on the master branch, then you have not successfully submitted your entry to the handbook.

Guidelines

After a number of you made the following mistakes I think it makes sense to group everything here:

  1. Your submission must compile on Linux (using pdflatex). No errors should be reported. No, I will not fix your submission for you.
  2. Your submission should look good (e.g. no overlapping text or images, etc.) when compiled with LaTeX
  3. Your submission should work with the LATEST master version.
  4. Do not commit platform-specific files (e.g. .DS_Store)
  5. All tex/bib files should go under terms directory
  6. All graphics files should go under your topic subdirectory under graphics
  7. Use proper sectioning/subsectioning
  8. .bib references do not need url (for some entry types, e.g. article), eprint, DOI, pdf, keywords or abstract entries (other attributes to delete are Remove Date-Added, Date-Modified, Bdsk-File-1)
  9. No abbreviations (e.g. they're), but also no Fig., Eq. etc. This is a formal scientific document, not an email.
  10. Use non breaking space between a Figure and its number, e.g. Figure~\ref{fig:jp}
  11. Make sure to index important keywords in your entry (look here for details how to do this). Multi-page index entries should have paired start and end delimiters.
  12. When you submit a Pull Request make sure it is against the latest master version
  13. Your entries should be in alphabetic order (e.g. cross-validation comes before ROC)
  14. Use proper and detailed figure, table and equation captioning
  15. Do not hardcode spaces in the template
  16. Understand the difference between \citet (reference in text) and \citep (reference in brackets)
  17. Make sure your references are not duplicated (keep in mind someone who committed their entry before may be using the same book/paper). Please double check
  18. Do not hardcode author names -- always use \citep or \citet commands
  19. If you have an equation, the paragraph immediately after should explain all the symbols used (this is not optional)
  20. Avoid sentences which have zero information content, e.g. Structural Risk Minimization (SRM) is a technique first developed by Vapnik and Chervonenkis in their book from 1974. (Note this tells you nothing about the method).
  21. Index entries must be meaningful (e.g. overview is not a good index entry, overview of what??)
  22. Bibliographic entries should be scholarly in nature (not someone's blog or lecture notes -- find the original paper!)
  23. If you have an online resource in your bibliography you need the url (but not for papers)
  24. Index entries should be human (not machine!) readable
  25. The punctuation for the sentence goes AFTER the parenthesis of a citation
  26. Do not use double quotes character " or fancy single quotes character. In LaTeX to get double quotes use ``this''. For single quotes use ' character only
  27. You should not have two (or more) headings immediately following each other. You require some preamble; a sentence or two which explains what is coming next
  28. LaTeX adds spacing after periods, but you don't want this for common abbreviations such as (e.g. e.g. some words, i.e., et al.). To tell LaTeX this is not the end of a sentence, mark the space with a backslash (e.g. e.g.\ this entry).
  29. There should be zero BibTeX warnings
  30. URLs should go in footnotes (\footnote{...})
  31. You should use linebreak (\\, \newline), page breaks and \noindent sparingly. The template should take care of the typesetting for you
  32. Figure, Equation and Table should be capitalized when referred to as proper nound (e.g. as shown in Figure 2).
  33. When you take a figure from another paper you need to reference it in the caption; e.g. Reproduced from Ebejer et al. (2017). If you have taken the idea from somewhere but reimplemented the graphic use Adapted instead of Reproduced
  34. No hanging statements at bottom of page (e.g. The operations which take place are the following: with a list at the top of the next page). Use pagebreak hints to avoid this \pagebreak[1].
  35. No text operators (e.g. \textbf{...}) inside maths environments (e.g. equation or $...$).
  36. Do not use above or below in your text, as things may move around and there is no above (on top of page) or below (at end of page). Always use sectioning and internal references (\ref).

About

A student-sourced Machine Learning handbook

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages