Package adams.data.djl.networkgenerator

Class AbstractNetworkGenerator

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, NetworkGenerator, adams.flow.core.FlowContextHandler, Serializable
    Direct Known Subclasses:
    AbstractScript, AbstractScriptedNetworkGenerator, TabularRegressionGenerator
    public abstract class AbstractNetworkGenerator
extends adams.core.option.AbstractOptionHandler
implements NetworkGenerator, adams.core.QuickInfoSupporter
    Ancestor for network generators.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.flow.core.Actor m_FlowContext
      the flow context.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected String check​(ai.djl.basicdataset.tabular.TabularDataset dataset)
      Checks the dataset before generating the network.
      protected abstract ai.djl.nn.Block doGenerate​(ai.djl.basicdataset.tabular.TabularDataset dataset)
      Generates the network using the supplied dataset.
      ai.djl.nn.Block generate​(ai.djl.basicdataset.tabular.TabularDataset dataset)
      Generates the network using the supplied dataset.
      adams.flow.core.Actor getFlowContext()
      Returns the flow context.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      boolean requiresFlowContext()
      Returns whether flow context is required.
      void setFlowContext​(adams.flow.core.Actor value)
      Sets the flow context.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_FlowContext

        protected transient adams.flow.core.Actor m_FlowContext
        the flow context.

    • Constructor Detail

      • AbstractNetworkGenerator

        public AbstractNetworkGenerator()

    • Method Detail

      • setFlowContext

        public void setFlowContext​(adams.flow.core.Actor value)
        Sets the flow context.
        Specified by:
        setFlowContext in interface adams.flow.core.FlowContextHandler
        Parameters:
        value - the context

      • getFlowContext

        public adams.flow.core.Actor getFlowContext()
        Returns the flow context.
        Specified by:
        getFlowContext in interface adams.flow.core.FlowContextHandler
        Returns:
        the context, null if not available

      • requiresFlowContext

        public boolean requiresFlowContext()
        Returns whether flow context is required.
        Default implementation returns false.
        Specified by:
        requiresFlowContext in interface NetworkGenerator
        Returns:
        true if required

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Default implementation returns null.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Returns:
        null if no info available, otherwise short string

      • check

        protected String check​(ai.djl.basicdataset.tabular.TabularDataset dataset)
        Checks the dataset before generating the network.
        Parameters:
        dataset - the dataset to generate the network for
        Returns:
        null if checks passed, otherwise error message

      • doGenerate

        protected abstract ai.djl.nn.Block doGenerate​(ai.djl.basicdataset.tabular.TabularDataset dataset)
        Generates the network using the supplied dataset.
        Parameters:
        dataset - the dataset to generate the network for
        Returns:
        the network

      • generate

        public ai.djl.nn.Block generate​(ai.djl.basicdataset.tabular.TabularDataset dataset)
        Generates the network using the supplied dataset.
        Specified by:
        generate in interface NetworkGenerator
        Parameters:
        dataset - the dataset to generate the network for
        Returns:
        the network