Ticket #939 (closed task: fixed)

Opened 3 years ago

Last modified 3 years ago

Orange.classification.svm: documentation

Reported by: marko Owned by: miha
Milestone: 2.5 Component: other
Severity: minor Keywords:
Cc: Blocking:
Blocked By:

Description (last modified by marko) (diff)

Check the documentation to prepare it for proof-reading (after dealing with #851).

Please conform to the current style and terminology. Avoid conversational style that was common in previous documentation (for example, rewrite sentences containing "you"). Avoid future tense; use present instead (for example, "classifier will be used" -> classifier is used").

Documentation that is believed to be OK:

 http://orange.biolab.si/doc/orange25/orange.data.feature.html  http://orange.biolab.si/doc/orange25/Orange.feature.scoring.html  http://orange.biolab.si/doc/orange25/Orange.classification.knn.html

Some suggestions:

  • Start the documentation with an easy example on the top (with and without parameter tuning).
  • Main kernel wrapper classes need better descriptions (when and how to use them).

Change History

comment:1 Changed 3 years ago by marko

  • Description modified (diff)

comment:2 Changed 3 years ago by miha

  • Status changed from new to closed
  • Resolution set to fixed

comment:3 Changed 3 years ago by marko

  • Status changed from closed to reopened
  • Resolution fixed deleted

Miha, good work.

Please also fix the following:

  • The introduction is badly written. Also check the language in the whole page.
  • MeasureAttribute_* is now Score_* ("measure attribute relevance" is now "score attribute", you can also link to the scoring documentation).
  • There are still some camel case references left.
  • The "Note" environment is used excessively.
  • The "SVM learners" section should start with short description of differences between learners.
  • Use parameter name "data" rather "examples".
  • Explain what are the kernel wrappers and how to use them.
  • Move code samples from the classes to the main text, perhaps before of after the class description. Also, explain what do the samples do. Put an example of the most basic use (perhaps with SVMLearnerEasy) in the Introduction.

comment:4 Changed 3 years ago by miha

  • Status changed from reopened to closed
  • Resolution set to fixed
Note: See TracTickets for help on using tickets.