fixed a bunch of stuff :) mostly exceptions. builders, removed util package

Author: deepnetts

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

@@ -1,5 +1,6 @@
 package javax.visrec.ml.classification;
 
+import java.util.Objects;
 import javax.visrec.ml.model.ModelProvider;
 
 /**
@@ -18,5 +19,9 @@ public abstract class LogisticRegression<MODEL_CLASS> implements BinaryClassifie
  public MODEL_CLASS getModel() {
  return model;
  }
+ 
+ protected final void setModel(MODEL_CLASS model) {
+ this.model = Objects.requireNonNull(model, "Model cannot be null!");
+ } 
 
 }

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

@@ -1,5 +1,6 @@
 package javax.visrec.ml.classification;
 
+import javax.visrec.ml.model.ModelCreationException;
 import javax.visrec.spi.ServiceProvider;
 import java.nio.file.Path;
 
@@ -62,7 +63,7 @@ private static <R> BuildingBlock<R> copyWithNewTargetClass(BuildingBlock<?> bloc
  }
  }
 
- class Builder<T> implements javax.visrec.util.Builder<BinaryClassifier<T>, ClassifierCreationException> {
+ class Builder<T> implements javax.visrec.ml.model.ModelBuilder<BinaryClassifier<T>> {
 
  private NeuralNetBinaryClassifier.BuildingBlock<T> block;
 
@@ -113,7 +114,7 @@ public NeuralNetBinaryClassifier.BuildingBlock<T> getBuildingBlock() {
  return block;
  }
 
- public BinaryClassifier<T> build() throws ClassifierCreationException {
+ public BinaryClassifier<T> build() throws ModelCreationException {
  return ServiceProvider.current().getClassifierFactoryService().createNeuralNetBinaryClassifier(block);
  }
  }

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

@@ -1,5 +1,6 @@
 package javax.visrec.ml.classification;
 
+import javax.visrec.ml.model.ModelCreationException;
 import javax.visrec.spi.ServiceProvider;
 import java.nio.file.Path;
 
@@ -88,7 +89,7 @@ private static <R> BuildingBlock<R> copyWithNewInputClass(BuildingBlock<?> block
  }
  }
 
- class Builder<T> implements javax.visrec.util.Builder<ImageClassifier<T>, ClassifierCreationException> {
+ class Builder<T> implements javax.visrec.ml.model.ModelBuilder<ImageClassifier<T>> {
 
  private BuildingBlock<T> block;
 
@@ -159,7 +160,7 @@ public BuildingBlock<T> getBuildingBlock() {
  return block;
  }
 
- public ImageClassifier<T> build() throws ClassifierCreationException {
+ public ImageClassifier<T> build() throws ModelCreationException {
  return ServiceProvider.current().getClassifierFactoryService().createNeuralNetImageClassifier(block);
  }
  }

src/main/java/javax/visrec/util/InvalidBuilderConfigurationException.java renamed to src/main/java/javax/visrec/ml/model/InvalidConfigurationException.java

@@ -1,4 +1,4 @@
-package javax.visrec.util;
+package javax.visrec.ml.model;
 
 /**
  * The Builder is able to attempt to invoke setter methods of the implemented Builder interface. If the
@@ -7,9 +7,9 @@
  *
  * @author Kevin Berendsen
  */
-public class InvalidBuilderConfigurationException extends RuntimeException {
+public class InvalidConfigurationException extends ModelCreationException {
 
- InvalidBuilderConfigurationException(String msg, Throwable throwable) {
+ InvalidConfigurationException(String msg, Throwable throwable) {
  super(msg, throwable);
  }
 

src/main/java/javax/visrec/util/Builder.java renamed to src/main/java/javax/visrec/ml/model/ModelBuilder.java

@@ -1,4 +1,4 @@
-package javax.visrec.util;
+package javax.visrec.ml.model;
 
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
@@ -12,30 +12,30 @@
  * @author Kevin Berendsen
  * @since 1.0
  */
-public interface Builder<T, E extends Throwable> {
+public interface ModelBuilder<T> {
 
  /**
  * Builds and returns an object using properties set using available builder methods.
  *
  * @return object specified by the builder to build
  */
- T build() throws E;
+ T build() throws ModelCreationException;
 
  /**
  * Builds an object using properties from the specified input argument
  *
  * @param configuration properties for the builder, a map of key, value pairs.
  * @return object specified by the builder to build
  */
- default T build(Map<String, Object> configuration) throws E, InvalidBuilderConfigurationException {
+ default T build(Map<String, Object> configuration) throws ModelCreationException {
  Method[] methods = this.getClass().getDeclaredMethods();
  for (Method method : methods) {
  if (!method.getName().equals("build") && method.getParameterCount() == 1
  && configuration.containsKey(method.getName())) {
  try {
  method.invoke(this, configuration.get(method.getName()));
  } catch (IllegalAccessException | InvocationTargetException | IllegalArgumentException e) {
- throw new InvalidBuilderConfigurationException("Couldn't invoke '" + method.getName() + "'", e);
+ throw new InvalidConfigurationException("Couldn't invoke '" + method.getName() + "'", e);
  }
  }
  }

src/main/java/javax/visrec/ml/classification/ClassifierCreationException.java renamed to src/main/java/javax/visrec/ml/model/ModelCreationException.java

@@ -1,18 +1,18 @@
-package javax.visrec.ml.classification;
+package javax.visrec.ml.model;
 
 /**
  * Exception thrown if anything fails in the creation of a classifier.
  *
  * @author Kevin Berendsen
  * @since 1.0
  */
-public class ClassifierCreationException extends Exception {
+public class ModelCreationException extends Exception {
 
  /**
  * Creates a new instance of the exception
  * @param message additional message of the cause.
  */
- public ClassifierCreationException(String message) {
+ public ModelCreationException(String message) {
  super(message);
  }
 
@@ -21,7 +21,7 @@ public ClassifierCreationException(String message) {
  * @param message additional message of the cause.
  * @param throwable caused by throwable.
  */
- public ClassifierCreationException(String message, Throwable throwable) {
+ public ModelCreationException(String message, Throwable throwable) {
  super(message, throwable);
  }
 

src/main/java/javax/visrec/ml/regression/SimpleLinearRegression.java

@@ -1,5 +1,6 @@
 package javax.visrec.ml.regression;
 
+import java.util.Objects;
 import javax.visrec.ml.model.ModelProvider;
 
 /**
@@ -18,9 +19,9 @@ public MODEL_CLASS getModel() {
  return model;
  }
 
-// protected void setModel(MODEL_CLASS model) {
-// this.model = model;
-// }
+ protected final void setModel(MODEL_CLASS model) {
+ this.model = Objects.requireNonNull(model, "Model cannot bu null!");
+ }
 
  @Override
  public abstract Float predict(Float input); 

src/main/java/javax/visrec/spi/BinaryClassifierFactory.java

@@ -1,13 +1,13 @@
 package javax.visrec.spi;
 
-import javax.visrec.ml.classification.ClassifierCreationException;
+import javax.visrec.ml.model.ModelCreationException;
 import javax.visrec.ml.classification.BinaryClassifier;
 import javax.visrec.ml.classification.NeuralNetBinaryClassifier;
 
 public interface BinaryClassifierFactory<T> {
 
  Class<T> getTargetClass();
 
- BinaryClassifier<T> create(NeuralNetBinaryClassifier.BuildingBlock<T> block) throws ClassifierCreationException;
+ BinaryClassifier<T> create(NeuralNetBinaryClassifier.BuildingBlock<T> block) throws ModelCreationException;
 
 }

src/main/java/javax/visrec/spi/ClassifierFactoryService.java

@@ -1,6 +1,6 @@
 package javax.visrec.spi;
 
-import javax.visrec.ml.classification.ClassifierCreationException;
+import javax.visrec.ml.model.ModelCreationException;
 import javax.visrec.ml.classification.*;
 import java.util.HashMap;
 import java.util.Map;
@@ -35,9 +35,9 @@ private ClassifierFactoryService() {
  *
  * @param block {@link NeuralNetImageClassifier.BuildingBlock} is provided to tune the building of the image classifier.
  * @return {@link ImageClassifier}
- * @throws ClassifierCreationException if the classifier can not be created due to any reason.
+ * @throws ModelCreationException if the classifier can not be created due to any reason.
  */
- public <T> ImageClassifier<T> createNeuralNetImageClassifier(NeuralNetImageClassifier.BuildingBlock<T> block) throws ClassifierCreationException {
+ public <T> ImageClassifier<T> createNeuralNetImageClassifier(NeuralNetImageClassifier.BuildingBlock<T> block) throws ModelCreationException {
  if (imageClassifierFactories == null) {
  imageClassifierFactories = new HashMap<>();
  for (ImageClassifierFactory<?> classifierCreator : ServiceLoader.load(ImageClassifierFactory.class)) {
@@ -47,7 +47,7 @@ public <T> ImageClassifier<T> createNeuralNetImageClassifier(NeuralNetImageClass
 
  ImageClassifierFactory<?> creator = imageClassifierFactories.get(block.getInputClass());
  if (creator == null) {
- throw new ClassifierCreationException("Unsupported image class");
+ throw new ModelCreationException("Unsupported image class");
  }
 
  @SuppressWarnings("unchecked")
@@ -61,9 +61,9 @@ public <T> ImageClassifier<T> createNeuralNetImageClassifier(NeuralNetImageClass
  *
  * @param block {@link NeuralNetBinaryClassifier.BuildingBlock} is provided to tune the building of the binary classifier.
  * @return {@link BinaryClassifier}
- * @throws ClassifierCreationException if the classifier can not be created due to any reason.
+ * @throws ModelCreationException if the classifier can not be created due to any reason.
  */
- public <T> BinaryClassifier<T> createNeuralNetBinaryClassifier(NeuralNetBinaryClassifier.BuildingBlock<T> block) throws ClassifierCreationException {
+ public <T> BinaryClassifier<T> createNeuralNetBinaryClassifier(NeuralNetBinaryClassifier.BuildingBlock<T> block) throws ModelCreationException {
  if (binaryClassifierFactories == null) {
  binaryClassifierFactories = new HashMap<>();
  for (BinaryClassifierFactory<?> classifierCreator : ServiceLoader.load(BinaryClassifierFactory.class)) {
@@ -73,7 +73,7 @@ public <T> BinaryClassifier<T> createNeuralNetBinaryClassifier(NeuralNetBinaryCl
 
  BinaryClassifierFactory<?> creator = binaryClassifierFactories.get(block.getInputClass());
  if (creator == null) {
- throw new ClassifierCreationException("Unsupported target class");
+ throw new ModelCreationException("Unsupported target class");
  }
 
  @SuppressWarnings("unchecked")

src/main/java/javax/visrec/spi/ImageClassifierFactory.java

@@ -1,13 +1,13 @@
 package javax.visrec.spi;
 
-import javax.visrec.ml.classification.ClassifierCreationException;
+import javax.visrec.ml.model.ModelCreationException;
 import javax.visrec.ml.classification.ImageClassifier;
 import javax.visrec.ml.classification.NeuralNetImageClassifier;
 
 public interface ImageClassifierFactory<T> {
 
  Class<T> getImageClass();
 
- ImageClassifier<T> create(NeuralNetImageClassifier.BuildingBlock<T> block) throws ClassifierCreationException;
+ ImageClassifier<T> create(NeuralNetImageClassifier.BuildingBlock<T> block) throws ModelCreationException;
 
 }