Package net.algart.executors.modules.opencv.matrices.ml

Class AbstractMLTrain

java.lang.Object
net.algart.json.PropertyChecker
net.algart.executors.api.ExecutionBlock
net.algart.executors.api.Executor
net.algart.executors.modules.opencv.common.OpenCVExecutor
net.algart.executors.modules.opencv.matrices.ml.AbstractMLOperation
net.algart.executors.modules.opencv.matrices.ml.AbstractMLTrain
All Implemented Interfaces:
AutoCloseable
Direct Known Subclasses:
MLTrainANNMLP, MLTrainBoost, MLTrainNormalBayesClassifier, MLTrainRTrees, MLTrainSVM, MLTrainSVMSGD
public abstract class AbstractMLTrain extends AbstractMLOperation

  • Nested Class Summary

    Nested classes/interfaces inherited from class net.algart.executors.api.Executor

    net.algart.executors.api.Executor.SystemParameter, net.algart.executors.api.Executor.Timing

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    OUTPUT_ACTUAL_TRAINING_RESPONSES
     
    static final String
    OUTPUT_IS_CLASSIFIER
     
    static final String
    OUTPUT_TRAINING_ERROR
     
    static final String
    OUTPUT_TRAINING_METADATA
     
    static final String
    OUTPUT_TRAINING_MODEL_FILE
     

    Fields inherited from class net.algart.executors.modules.opencv.matrices.ml.AbstractMLOperation

    INPUT_SAMPLES, INPUT_TRAINING_RESPONSES, MAX_NUMBER_OF_CATEGORICAL_RESPONSES_FOR_CONVERSION_TO_BINARY

    Fields inherited from class net.algart.executors.api.Executor

    ENUM_VALUE_OF_NAME_CUSTOM_METHOD, LOG, LOGGABLE_DEBUG, LOGGABLE_INFO, LOGGABLE_TRACE, OUTPUT_EXECUTOR_ID_NAME, OUTPUT_PLATFORM_ID_NAME, OUTPUT_RESOURCE_FOLDER_NAME, STANDARD_VISIBLE_RESULT_PARAMETER_NAME

    Fields inherited from class net.algart.executors.api.ExecutionBlock

    DEFAULT_INPUT_PORT, DEFAULT_OUTPUT_PORT, GLOBAL_SHARED_SESSION_ID, SHOW_INFO_ON_STARTUP

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractMLTrain(MLSamplesType samplesType)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract boolean
    categoricalResponses()
     
    protected double
    doCalculateError(MLTrainer trainer, org.bytedeco.opencv.opencv_ml.TrainData trainData, org.bytedeco.opencv.opencv_core.Mat result)
     
    protected double
    doCalculateError(MLTrainer trainer, org.bytedeco.opencv.opencv_ml.TrainData trainData, org.bytedeco.opencv.opencv_core.UMat result)
     
    protected double
    doTrain(MLTrainer trainer, org.bytedeco.opencv.opencv_core.Mat samples, org.bytedeco.opencv.opencv_core.Mat responses, org.bytedeco.opencv.opencv_core.Mat autoTestResults)
     
    protected double
    doTrain(MLTrainer trainer, org.bytedeco.opencv.opencv_core.UMat samples, org.bytedeco.opencv.opencv_core.UMat responses, org.bytedeco.opencv.opencv_core.UMat autoTestResults)
     
    protected void
    doTrain(MLTrainer trainer, org.bytedeco.opencv.opencv_ml.TrainData trainData, int sampleLength, int responseLength)
     
    final boolean
    getTrainingFlagByMask(int bitMask)
     
    final int
    getTrainingFlags()
     
    final boolean
    isCalculateError()
     
    final boolean
    isConvertCategoricalResponses()
     
    final boolean
    isTestPredictTrainedSamples()
     
    final boolean
    isTrainingCombinedSamplesAndResponses()
     
    protected MLMetadataJson
    metadata(MLTrainer trainer)
     
    protected abstract MLKind
    modelKind()
     
    final void
    setCalculateError(boolean calculateError)
     
    final void
    setConvertCategoricalResponses(boolean convertCategoricalResponses)
     
    final void
    setTestPredictTrainedSamples(boolean testPredictTrainedSamples)
     
    final void
    setTrainingCombinedSamplesAndResponses(boolean trainingCombinedSamplesAndResponses)
     
    final void
    setTrainingFlagByMask(int bitMask, boolean value)
     
    final void
    setTrainingFlags(int trainingFlags)
     
    final void
    setTrainingFlags(MLStatModelTrainer trainer)
     
    final void
    train(MLTrainer trainer)
     
    double
    trainNumbers(MLTrainer trainer, net.algart.executors.api.data.SNumbers samples, net.algart.executors.api.data.SNumbers responses, net.algart.executors.api.data.SNumbers autoTestResult)
     
    double
    trainPixels(MLTrainer trainer, net.algart.executors.api.data.SMat samples, net.algart.executors.api.data.SMat responses, net.algart.executors.api.data.SMat autoTestResult)
     
    protected byte[]
    varType(int numberOfSamples, int numberOfResponses)
     
    final void
    writeTrainer(MLTrainer trainer)
     

    Methods inherited from class net.algart.executors.modules.opencv.matrices.ml.AbstractMLOperation

    categoricalToMultiBinaryResponses, categoricalToMultiBinaryResponses, getStatModelFile, samplesType, selectIndexesOfMaximalMultiResponses, selectIndexesOfMaximalMultiResponses, setStatModelFile, statModelFile

    Methods inherited from class net.algart.executors.modules.opencv.common.OpenCVExecutor

    close, isUseGPU, postprocess, putMat, setMat, setUseGPU, useGPU

    Methods inherited from class net.algart.executors.api.Executor

    addServiceTime, allocatedMemory, allOutputContainers, allParameters, checkOutputNecessary, configAllocatedMemory, debugTime, defaultInputPortName, defaultInputPortName, defaultOutputPortName, defaultOutputPortName, defaultVisibleResultsInformation, disableOnChangeParameterAutomatic, disableOnChangeParametersAutomatic, execute, execute, executorModel, executorModel, executorPlatform, executorResourceFolder, fillSystemOutputs, fineAllocatedMemory, finishTimingOfExecutingAll, freeAllInputPortData, freeAllOutputPortData, freeAllPortData, getCurrentDirectory, getEndProcessingTimeStamp, getServiceTime, getStartProcessingTimeStamp, infoTime, initialize, isCancellingExecutionRequested, isCancellingFurtherExecutionRequested, isMultithreadingEnvironment, isTimingEnabled, isUsingVisibleResultParameter, isVisiblePort, isVisibleResultDisabled, logDebug, logDebug, loggingEnabled, logInfo, logInfo, logTrace, logTrace, onChangeParameter, onChangeParameterAutomatic, parameterControlValueType, parameterJavaType, process, requestCancellingFurtherExecution, requestContinuingFurtherExecution, requestOutput, reset, resetTiming, setCurrentDirectory, setDefaultInputMat, setDefaultInputNumbers, setDefaultInputPort, setDefaultInputScalar, setDefaultOutputMat, setDefaultOutputNumbers, setDefaultOutputPort, setDefaultOutputScalar, setEndProcessingTimeStamp, setMultithreadingEnvironment, setStartProcessingTimeStamp, setTimingEnabled, showStatus, showStatus, skipStandardAutomaticParameters, startTimingOfExecutingAll, status, statusData, toString, translateCurrentDirectory, useVisibleResultParameter, valueOfLogLevel, visibleOutputPortName, visibleResultsInformation

    Methods inherited from class net.algart.executors.api.ExecutionBlock

    addInputData, addInputMat, addInputNumbers, addInputScalar, addOneTimeTaskAfterExecutingAll, addOutputData, addOutputMat, addOutputNumbers, addOutputScalar, addPort, addTaskAfterExecutingAll, addTaskBeforeExecutingAll, afterExecutingAll, allInputPorts, allOneTimeTasksAfterExecutingAll, allOutputPorts, allTasksAfterExecutingAll, allTasksBeforeExecutingAll, availableExecutorModelArray, availableExecutorModelDescriptions, beforeExecutingAll, checkInputNecessary, clearSession, contextPath, getCaller, getContextId, getContextName, getContextPath, getData, getData, getDoubleScalar, getDoubleScalar, getExecutorId, getExecutorModelDescription, getExecutorSpecification, getInputData, getInputData, getInputData, getInputData, getInputDataContainer, getInputDataContainer, getInputMat, getInputMat, getInputMat, getInputMat, getInputMatContainer, getInputMatContainer, getInputNumbers, getInputNumbers, getInputNumbers, getInputNumbers, getInputNumbersContainer, getInputNumbersContainer, getInputPort, getInputScalar, getInputScalar, getInputScalar, getInputScalar, getInputScalarContainer, getInputScalarContainer, getIntScalar, getIntScalar, getLongScalar, getLongScalar, getMat, getMat, getNumbers, getNumbers, getOutputPort, getOwnerId, getPlatformId, getPort, getRequiredInputPort, getRequiredOutputPort, getRootCaller, getScalar, getScalar, getSessionId, getStringScalar, getStringScalar, hasDefaultInputPort, hasDefaultOutputPort, hasInputPort, hasOutputPort, initializeExecutionSystem, interrupt, isAllOutputsNecessary, isClosed, isInputNecessary, isInterrupted, isInterruptionRequested, isOutputNecessary, isReadOnlyInput, isVisibleResultNecessary, needToRepeat, newExecutionBlock, parameters, putDoubleScalar, putDoubleScalar, putIntScalar, putIntScalar, putJsonScalar, putJsonScalar, putLongScalar, putLongScalar, putMat, putMat, putNumbers, putNumbers, putNumbers, putNumbers, putScalar, putScalar, putStringScalar, putStringScalar, recommendedCategory, recommendedName, registerExecutionBlockLoader, removeInputPort, removeOneTimeTaskAfterExecutingAll, removeOutputData, removeOutputPort, removeTaskAfterExecutingAll, removeTaskBeforeExecutingAll, replacePort, setAllOutputsNecessary, setBooleanParameter, setCaller, setContextId, setContextId, setContextName, setContextPath, setDoubleParameter, setInterruptionRequested, setIntParameter, setLongParameter, setOutputScalar, setOutputScalar, setOutputScalar, setOutputScalar, setOutputScalar, setOutputScalar, setOutputScalarIfNecessary, setOwnerId, setSessionId, setStringParameter, setVisibleResultNecessary

    Methods inherited from class net.algart.json.PropertyChecker

    doubleOrDefault, doubleOrNegativeInfinity, doubleOrNull, doubleOrPositiveInfinity, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, inRange, inRange, inRange, inRange, inRange, inRange, intOrDefault, intOrNull, longOrDefault, longOrNull, nonEmpty, nonEmpty, nonEmptyTrimmed, nonEmptyTrimmed, nonLessThan, nonLessThan, nonLessThan, nonLessThan, nonLessThan, nonLessThan, nonNegative, nonNegative, nonNegative, nonNegative, nonNegative, nonNegative, nonNull, nonNull, positive, positive, positive, positive, positive, positive, propertyName

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • AbstractMLTrain

      protected AbstractMLTrain(MLSamplesType samplesType)

  • Method Details

    • isConvertCategoricalResponses

      public final boolean isConvertCategoricalResponses()

    • setConvertCategoricalResponses

      public final void setConvertCategoricalResponses(boolean convertCategoricalResponses)

    • isCalculateError

      public final boolean isCalculateError()

    • setCalculateError

      public final void setCalculateError(boolean calculateError)

    • isTestPredictTrainedSamples

      public final boolean isTestPredictTrainedSamples()

    • setTestPredictTrainedSamples

      public final void setTestPredictTrainedSamples(boolean testPredictTrainedSamples)

    • isTrainingCombinedSamplesAndResponses

      public final boolean isTrainingCombinedSamplesAndResponses()

    • setTrainingCombinedSamplesAndResponses

      public final void setTrainingCombinedSamplesAndResponses(boolean trainingCombinedSamplesAndResponses)

    • getTrainingFlags

      public final int getTrainingFlags()

    • setTrainingFlags

      public final void setTrainingFlags(int trainingFlags)

    • setTrainingFlagByMask

      public final void setTrainingFlagByMask(int bitMask, boolean value)

    • getTrainingFlagByMask

      public final boolean getTrainingFlagByMask(int bitMask)

    • train

      public final void train(MLTrainer trainer)

    • trainNumbers

      public double trainNumbers(MLTrainer trainer, net.algart.executors.api.data.SNumbers samples, net.algart.executors.api.data.SNumbers responses, net.algart.executors.api.data.SNumbers autoTestResult)

    • trainPixels

      public double trainPixels(MLTrainer trainer, net.algart.executors.api.data.SMat samples, net.algart.executors.api.data.SMat responses, net.algart.executors.api.data.SMat autoTestResult)

    • writeTrainer

      public final void writeTrainer(MLTrainer trainer)

    • setTrainingFlags

      public final void setTrainingFlags(MLStatModelTrainer trainer)

    • modelKind

      protected abstract MLKind modelKind()

    • metadata

      protected MLMetadataJson metadata(MLTrainer trainer)

    • categoricalResponses

      protected abstract boolean categoricalResponses()

    • doTrain

      protected double doTrain(MLTrainer trainer, org.bytedeco.opencv.opencv_core.Mat samples, org.bytedeco.opencv.opencv_core.Mat responses, org.bytedeco.opencv.opencv_core.Mat autoTestResults)

    • doTrain

      protected double doTrain(MLTrainer trainer, org.bytedeco.opencv.opencv_core.UMat samples, org.bytedeco.opencv.opencv_core.UMat responses, org.bytedeco.opencv.opencv_core.UMat autoTestResults)

    • doTrain

      protected void doTrain(MLTrainer trainer, org.bytedeco.opencv.opencv_ml.TrainData trainData, int sampleLength, int responseLength)

    • doCalculateError

      protected double doCalculateError(MLTrainer trainer, org.bytedeco.opencv.opencv_ml.TrainData trainData, org.bytedeco.opencv.opencv_core.Mat result)

    • doCalculateError

      protected double doCalculateError(MLTrainer trainer, org.bytedeco.opencv.opencv_ml.TrainData trainData, org.bytedeco.opencv.opencv_core.UMat result)

    • varType

      protected byte[] varType(int numberOfSamples, int numberOfResponses)