Permalink
Browse files

More documentation in the website.

  • Loading branch information...
nikolavp committed Feb 4, 2012
1 parent 0813282 commit b060d918ffc4384f66b61a932030a9057dc17e66
@@ -11,9 +11,11 @@ Tests for the classifiers are really easy to write if you are using some of the
* vote
You just have to subclass our base test class for every classifier - ClassifierTestBase. After extending that class you will have to define
+
* A logger that will help you throughout the testing
* A classifier object which is just a simple default configuration of your classifier that you want to test
* A test descriptor that will describe what you want to test.
+
The last one is really interesting by itself - we define a contract by a descriptor that we want the base class to verify. Let's consider a simple example:
We are writing a new classifier for [MaxEnt](http://en.wikipedia.org/wiki/Maximum_entropy_classifier)(consider that this is not yet implemented), so we want to test our classifier on the iris dataset. Here is the code we have to
@@ -3,11 +3,11 @@ We are following the convention from weka, so if you want to register a new clas
When you implement our IClassifier interface which marks your class as a classifier, you will have to implement 3 methods:
-* *buildClassifier*<br/>
+* buildClassifier<br/>
Here you have to build the model for the classifier and store it somewhere. The model constructions will depend from the algorithm you are trying to implement.
-* *classifyInstance* <br/>
+* classifyInstance <br/>
After you have built the model in buildClassifier you should be able to classify instances depending on their attributes based on the model.
-* *getName* <br/>
+* getName <br/>
This should return a meaningful name of your classifier algorithm.
Consider writing tests for you classifier! Tests for the classifiers are really easy to write in our framework. Look at our [Testing] page for more information.
@@ -0,0 +1,32 @@
+# Site generation tools
+To generate this site we are using the [maven site plugin](http://maven.apache.org/plugins/maven-site-plugin/maven-3.html) with the help of some plugins for reporting. This currently include:
+
+* [maven project info](http://maven.apache.org/plugins/maven-project-info-reports-plugin/)
+* [maven javadoc plugin](http://maven.apache.org/plugins/maven-javadoc-plugin/)
+* [maven checkstyle plugin](http://maven.apache.org/plugins/maven-checkstyle-plugin/)
+* [maven pmd plugin](http://maven.apache.org/plugins/maven-pmd-plugin/)
+* [maven findbugs plugin](http://mojo.codehaus.org/findbugs-maven-plugin/)
+
+the last three are also used when developing to verify for code style compliance(see more [here](/spaska/static_analysis.html))
+
+# Syntax for the pages
+For the pages we are not using raw HTML, but rather take advantage of the [markdown maven plugin](http://markdown.tautua.org/doxia-module.html). The syntax of markdown is pretty straightforward and shouldn't take you more than 10 minutes to get you going if you are not familiar with it. More information on markdown can be found [here](http://daringfireball.net/projects/markdown/)
+
+# Site generation
+To generate a new version of the website locally you should run mvn site from the base directory of the project. If you also want to upload the website to the current url(http://nikolavp.github.com), you have to uncomment the executions section of the defined github maven site plugin in the pom.xml file. You will also have to provide credentials(username and password) as they are required by github. The credentials can be provided by your settings.xml with a section like this
+
+ <profiles>
+ <profile>
+ <id>github</id>
+ <properties>
+ <github.global.userName>user</github.global.userName>
+ <github.global.password>password</github.global.password>
+ </properties>
+ </profile>
+ </profiles>
+
+ <activeProfiles>
+ <activeProfile>github</activeProfile>
+ </activeProfiles>
+
+More information can be found [here](https://github.com/github/maven-plugins)
View
@@ -30,7 +30,8 @@
<item name="Testing" href="classifiers_tests.html" />
</menu>
<menu name="Development">
- <item name="Static analysis" href="static_analysis.html"/>
+ <item name="Static analysis" href="static_analysis.html" />
+ <item name="Site generation" href="site_generation.html" />
</menu>
</body>

0 comments on commit b060d91

Please sign in to comment.