ImFusion C++ SDK 4.4.0
ImFusion::ML::RepeatDataLoader Class Reference

#include <ImFusion/ML/DataLoaders/RepeatDataLoader.h>

Repeats items coming from a nested loader. More...

Inheritance diagram for ImFusion::ML::RepeatDataLoader:

Detailed Description

Repeats items coming from a nested loader.

Repetition can either by per epoch (i.e. the entire epoch of the nested data loader is repeated) or per item (i.e. each item is repeated a certain number of times) or both.

Public Member Functions

 RepeatDataLoader (std::unique_ptr< DataLoader > loader, int numEpochRepetitions=-1, int numItemRepetitions=1, bool verbose=false)
 RepeatDataLoader (DataLoaderList dataLoaders, const Properties &prop)
std::optional< DataItemnext () override
 Advance the loader by one iteration.
std::optional< size_t > size () const override
 Size of the loader, has value only for fixed cardinalities.
void reset () override
 Reset the loader in order to restart the iteration.
void configure (const Properties *properties) override
 Configure this object instance by de-serializing the given Properties.
Public Member Functions inherited from ImFusion::ML::DataLoader
 DataLoader (std::string name, bool verbose=false)
 Constructor to be used by DataReaders, as they are the first elements in the chain.
 DataLoader (std::string name, std::unique_ptr< DataLoader > loader, bool verbose=false)
 Constructor to be used by all other derived DataLoaders.
 DataLoader (std::string name, DataLoaderList &&dataLoaders, bool verbose=false)
 Constructor to be used by all other derived DataLoaders.
const std::stringname () const
 Name of the loader.
virtual void reinit ()
 Reinitialize the loader state, cleaning it up if necessary Overload this method if your loader has state that must survive reset (i.e.
virtual Cardinality cardinality () const
 Cardinality of this specific loader node.
DataLoadersingleUnderlyingLoader () const
 Return a single underlying dataloader Expects there to be only one, returns a nullptr otherwise.
std::unique_ptr< DataLoaderextractDataloader ()
 Return a single underlying dataloader Expects there to be only one, throws an exception otherwise.
DataLoaderList & loaders ()
DataLoaderList const & loaders () const
bool verbose () const
virtual void setRandomSeed (unsigned int seed)
virtual Status canBePrefetched () const
 Indicates whether a loader is eligible for prefetching.
const std::stringlogDomain () const
 Log domain for AdvancedParameter.
Public Member Functions inherited from ImFusion::Configurable
virtual void configuration (Properties *p) const
 Serialize the current object configuration into the given Properties object.
virtual void configureDefaults ()
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 Configurable (const Configurable &rhs)
 Configurable (Configurable &&rhs) noexcept
Configurable & operator= (const Configurable &)
Configurable & operator= (Configurable &&) noexcept
Public Member Functions inherited from ImFusion::SignalReceiver
 SignalReceiver ()=default
 Default constructor.
 SignalReceiver (const SignalReceiver &other)
 Copy constructor, does not copy any existing signal connections from other.
SignalReceiveroperator= (SignalReceiver rhs)
 Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
virtual ~SignalReceiver ()
 Virtual destructor disconnects from all connected signals.

Public Attributes

LoaderParam< int > m_numEpochRepetitions = {"num_epoch_repetitions", -1, this, ParamRequired::Yes, "num_epochs"}
LoaderParam< int > m_numItemRepetitions = {"num_item_repetitions", 1, this, ParamRequired::No}
Public Attributes inherited from ImFusion::ML::DataLoader
LoaderParam< bool > m_verbose = {"verbose", false, this, ParamRequired::No}
 If enabled, print log messages with extra information like timings.
Public Attributes inherited from ImFusion::Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members

Protected Member Functions inherited from ImFusion::Utils::NotCopyable
 NotCopyable (NotCopyable &&) noexcept=default
NotCopyable & operator= (NotCopyable &&) noexcept=default
 NotCopyable (const NotCopyable &)=delete
NotCopyable & operator= (const NotCopyable &)=delete
Protected Member Functions inherited from ImFusion::SignalReceiver
void disconnectAll ()
 Disconnects all existing connections.
Protected Attributes inherited from ImFusion::ML::DataLoader
std::string m_name
Cardinality m_cardinality = Cardinality::Fixed
Random::Generator m_randGenerator
DataLoaderList m_dataLoaders
Protected Attributes inherited from ImFusion::Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ next()

std::optional< DataItem > ImFusion::ML::RepeatDataLoader::next ( )
overridevirtual

Advance the loader by one iteration.

The function must pull an item from the underlying node, process it and return it. If the underlyng loader is exhausted, returns an empty optional.

Implements ImFusion::ML::DataLoader.

◆ size()

std::optional< size_t > ImFusion::ML::RepeatDataLoader::size ( ) const
overridevirtual

Size of the loader, has value only for fixed cardinalities.

Implements ImFusion::ML::DataLoader.

◆ reset()

void ImFusion::ML::RepeatDataLoader::reset ( )
overridevirtual

Reset the loader in order to restart the iteration.

Reimplemented from ImFusion::ML::DataLoader.

◆ configure()

void ImFusion::ML::RepeatDataLoader::configure ( const Properties * p)
overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configuration() for the inverse functionality

Reimplemented from ImFusion::ML::DataLoader.


The documentation for this class was generated from the following file:
  • ImFusion/ML/DataLoaders/RepeatDataLoader.h
Search Tab / S to search, Esc to close