Java doc updated

Author: deepnetts

src/main/java/javax/visrec/ml/classification/Classifiable.java

@@ -1,15 +1,19 @@
 package javax.visrec.ml.classification;
 
 /**
- * Classes that implement this interface enable direct classification of Java objects, no need to manually convert to data structures used internally by ML.
- * Simplifies usage and integration
- * This interface should be implemented for classes whose objects we want to be able to classify.Instances of classes that implement this interface can be classified, and used as examples
- * to build machine learning based classifiers.Typical implementation scenario is to wrap domain specific class and implement this interface.
+ * Classes that implement this interface enable direct classification of Java objects,
+ * no need to manually convert to data structures used internally by ML.
+ * 
+ * This interface simplifies usage and integration of machine learning based classifiers with Java objects.
+ * It should be implemented by classes whose objects we want to be able to classify.
+ * Instances of classes that implement this interface can be used as examples
+ * to build machine learning based classifiers.
+ * Typical implementation scenario is to wrap domain specific class and implement this interface.
  * 
  * Classifiable<T, C> can be classfied by the Classifier<T, C> (with the same T and C)
  * 
  * @param <T> Type of input for classifier
- * @param <C> Type of class instances (could be anything like enum, String, Integer or user defined class)
+ * @param <C> Type of categories/labels (could be anything like enum, String, Integer or user defined class)
  */
 public interface Classifiable<T, C> {
 

src/main/java/javax/visrec/ml/classification/Classifier.java

@@ -1,10 +1,12 @@
 package javax.visrec.ml.classification;
 
 /**
- * Classifier answers the question what is the category/type of an input object.
- * Each category/type has corresponding label or class name, which can be String, Enum or custom user defined class.
- * This is a generic classifier interface, that all classifiers should implement, and
+ * Generic classifier interface, that all classifiers should implement, and
  * it provides a method to classify given instances of some class.
+ * Each category/type has corresponding label or class, which can be String, Enum or custom user defined class.
+ * Machine learning based classifier can learn from examples how to determine a 
+ * category of an input object with high degree of confidence.
+ *
  * <p>
  * Implementations should specify input type <T> of instances that are classified,
  * and type of the returned vales <R>.

src/main/java/javax/visrec/ml/classification/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Classification represents task of determining a category of a given object.
+ * Machine learning classifiers are able to learn from examples how to determine
+ * a category for a given object, that has not seen before 
+ * (although it should be similar to examples that were used to build a classifier).
+ */
+package javax.visrec.ml.classification;

src/main/java/javax/visrec/ml/data/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * A collection of example data used to build/train machine learning model.
+ * The goal of this package is to have reusable data abstractions with common operations for building machine learning models.
+ */
+package javax.visrec.ml.data;

src/main/java/javax/visrec/ml/data/preprocessing/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Data preprocessing techniques used to prepare data for building machine learning models.
+ */
+package javax.visrec.ml.data.preprocessing;

src/main/java/javax/visrec/ml/detection/ObjectDetector.java

@@ -14,7 +14,7 @@
 public interface ObjectDetector<T> {
 
  /**
- * Detects object in specified image
+ * Detects object in specified image and returns a map with detected objects in bounding boxes.
  *
  * @param image image to search for object
  * @return a map of multiple {@link BoundingBox}

src/main/java/javax/visrec/ml/detection/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Object detection algorithms.
+ */
+package javax.visrec.ml.detection;

src/main/java/javax/visrec/package-info.java

@@ -1,5 +1,5 @@
 /**
- * Visual recognition API provides reusable abstractions for visual recognition tasks based on machine learning,
+ * Reusable abstractions for visual recognition tasks based on machine learning,
  * that simplify implementation and integration of various machine learning models and image types.
  */
 package javax.visrec;