CVB.Net 15.0
Loading...
Searching...
No Matches

Base class for classifier factory classes. More...

Inherited by PredictorFactoryBaseEx, and SearchPredictorFactory.

Public Member Functions

void Dispose ()
 Disposes of the native data needed for marshalling.
 
void UseSettingsFromPredictor (PredictorBase clf)
 Copy the classifier generation settings from a classifier.
 

Static Public Member Functions

static string FormatPreprocessingCode (string input)
 Correct a preprocessing code to make sure that no invalid characters are in the code and the code does not exceed the maximum length.
 

Static Public Attributes

static readonly ValueRange< double > LambdaRange = new ValueRange<double>(0.0, 10.0)
 Acceptable scale factor range for search classifier training.
 
const double LambdaDefault = 0.1
 Default value for lambda.
 
const int FeatureResolutionDefault = 1
 Default value for feature resolution.
 
static readonly ValueRange< int > FeatureResolutionRange = new ValueRange<int>(0, 10)
 Valid range of feature resolution value.
 
const int PreprocessingMaxLength = InternalExtensions.PreprocessingMaxLength
 Maximum length of a preprocessing code (excluding the terminating zero).
 
const string PreprocessingValidCharacters = InternalExtensions.PreprocessingValidCharacters
 characters that a preprocessing string may contain.
 

Protected Member Functions

 PredictorFactoryBase ()
 ctor (internal).
 
virtual void Dispose (bool disposing)
 Clean-up of managed-to-native data structures.
 
virtual void OnStartProgressReport (int id, string caption, int stepsTotal)
 Event raiser.
 
virtual void OnProgressReport (int id, ref bool retval)
 Event raiser.
 
virtual void OnEndProgressReport (int id)
 Event raiser.
 

Properties

double Lambda [get, set]
 Regularization value to be used for generating the object. Possible values range from 0 to 10, good starting values for experiments are usually around 0.01.
 
string Preprocessing [get, set]
 Preprocessing code with which the object is to be generated.
 

Events

EventHandler< StartProgressReportEventArgsStartProgressReport
 Event that will be fired when a new progress stage was initiated.
 
EventHandler< ProgressReportEventArgsProgressReport
 Event that informs about a progress step in the given stage.
 
EventHandler< EndProgressReportEventArgsEndProgressReport
 Event that informs about the finalization of a given stage.
 

Detailed Description

Base class for classifier factory classes.

Member Function Documentation

◆ Dispose()

virtual void Dispose ( bool disposing)
protectedvirtual

Clean-up of managed-to-native data structures.

Parameters
disposing

◆ FormatPreprocessingCode()

static string FormatPreprocessingCode ( string input)
static

Correct a preprocessing code to make sure that no invalid characters are in the code and the code does not exceed the maximum length.

Parameters
inputString to be corrected
Returns
Corrected string

◆ OnEndProgressReport()

virtual void OnEndProgressReport ( int id)
protectedvirtual

Event raiser.

Parameters
idID for which progress reporting ends.

◆ OnProgressReport()

virtual void OnProgressReport ( int id,
ref bool retval )
protectedvirtual

Event raiser.

Parameters
idID for which progress reporting was called.
retvalWhen set to true the operation continues, when set to false it will terminate at the next possible opportunity.

◆ OnStartProgressReport()

virtual void OnStartProgressReport ( int id,
string caption,
int stepsTotal )
protectedvirtual

Event raiser.

Parameters
idID for which progress reporting starts.
captionCaption under which progress reporting starts.
stepsTotalThe total number of steps (= calls to OnProgressReport(int, ref bool)) to be expected.

◆ UseSettingsFromPredictor()

void UseSettingsFromPredictor ( PredictorBase clf)

Copy the classifier generation settings from a classifier.

Parameters
clfClassifier to take the settings from.