nwflte / accord

Automatically exported from code.google.com/p/accord
1 stars 0 forks source link

Add more documentation examples #54

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago
Add more examples documenting:

 - How to create features in HCRFs;
 - How to learn HMMs using supervised learning;
 - Add samples on how to use LocalBinaryPatterns, Histogram of Oriented Gradients;
 - How to use PCA/KPCA/LDA/KDA with images;

Original issue reported on code.google.com by cesarso...@gmail.com on 24 Jun 2013 at 5:04

GoogleCodeExporter commented 8 years ago
Add documentation examples for

  - Usage of *all* statistical distributions (with numerical examples) 
  - Usafe of *all* statistical hypothesis tests

By the way, if anyone would like to tackle this issue, this would be very easy 
to do. All examples, including numerical outputs, are already available at the 
framework unit tests at

  - https://code.google.com/p/accord/source/browse/trunk#trunk%2FSources%2FAccord.Tests%2FAccord.Tests.Statistics%2FDistributions

It would just be a matter of copying and pasting into the right (xml) 
documentation sections above each class declaration.

Example: To complete the documentation for the BernoulliDistribution, one would 
have to get the method calls, the given parameters parameters and expected 
values from

 - https://code.google.com/p/accord/source/browse/trunk/Sources/Accord.Tests/Accord.Tests.Statistics/Distributions/Univariate/Discrete/BernoulliDistributionTest.cs#79

and put in the BernoulliDistribution.cs class. Repeat.

PS: _Every_ framework feature has an accompanying unit test (e.g. 
https://code.google.com/p/accord/source/browse/trunk/Sources/Accord.Tests/Accord
.Tests.Statistics/Testing/ZTestTest.cs for ZTest, and so on). If a feature 
doesn't have a unit test, then you can fill a bug report.

Original comment by cesarso...@gmail.com on 25 Jun 2013 at 12:51

GoogleCodeExporter commented 8 years ago
Partially addressed on 2.10. Still needs documentation for ImageBox, 
ScatterplotBox, DataGridBox and many others.

Documentation is also available at http://accord-net.github.io/docs/Index.html

Original comment by cesarso...@gmail.com on 3 Aug 2013 at 10:22

GoogleCodeExporter commented 8 years ago
Still needs documentation for the Kappa tests and other hypothesis tests.

Original comment by cesarso...@gmail.com on 28 Nov 2013 at 8:56