Objects of this class containing fields and methods used in several other classes in 'AI for Education'.
This class is not designed for a direct application and should only be used by developers.
A new object of this class.
last_training('list()')
List for storing the history, the configuration, and the results of the last
training. This information will be overwritten if a new training is started.
last_training$start_time: Time point when training started.
last_training$learning_time: Duration of the training process.
last_training$finish_time: Time when the last training finished.
last_training$history: History of the last training.
last_training$data: Object of class table storing the initial frequencies of the passed data.
last_training$config: List storing the configuration used for the last training.
get_model_info()Method for requesting the model information.
AIFEMaster$get_model_info()list of all relevant model information.
set_publication_info()Method for setting publication information of the model.
AIFEMaster$set_publication_info(authors, citation, url = NULL)authorsList of authors.
citationFree text citation.
urlURL of a corresponding homepage.
Function does not return a value. It is used for setting the private members for publication information.
get_publication_info()Method for requesting the bibliographic information of the model.
AIFEMaster$get_publication_info()list with all saved bibliographic information.
set_model_license()Method for setting the license of the model.
AIFEMaster$set_model_license(license = "CC BY")licensestring containing the abbreviation of the license or the license text.
Function does not return a value. It is used for setting the private member for the software license of the model.
get_model_license()Method for getting the license of the model.
AIFEMaster$get_model_license()licensestring containing the abbreviation of the license or the license text.
string representing the license for the model.
set_documentation_license()Method for setting the license of the model's documentation.
AIFEMaster$set_documentation_license(license = "CC BY")licensestring containing the abbreviation of the license or the license text.
Function does not return a value. It is used for setting the private member for the documentation license of the model.
get_documentation_license()Method for getting the license of the model's documentation.
AIFEMaster$get_documentation_license()licensestring containing the abbreviation of the license or the license text.
Returns the license as a string.
set_model_description()Method for setting a description of the model.
AIFEMaster$set_model_description(
eng = NULL,
native = NULL,
abstract_eng = NULL,
abstract_native = NULL,
keywords_eng = NULL,
keywords_native = NULL
)engstring A text describing the training, its theoretical and empirical background, and output in
English.
nativestring A text describing the training , its theoretical and empirical background, and output in
the native language of the model.
abstract_engstring A text providing a summary of the description in English.
abstract_nativestring A text providing a summary of the description in the native language of the
model.
keywords_engvector of keyword in English.
keywords_nativevector of keyword in the native language of the model.
Function does not return a value. It is used for setting the private members for the description of the model.
get_model_description()Method for requesting the model description.
AIFEMaster$get_model_description()list with the description of the classifier in English and the native language.
get_package_versions()Method for requesting a summary of the R and python packages' versions used for creating the model.
AIFEMaster$get_package_versions()Returns a list containing the versions of the relevant R and python packages.
get_sustainability_data()Method for requesting a summary of tracked energy consumption during training and an estimate of the resulting CO2 equivalents in kg.
AIFEMaster$get_sustainability_data(track_mode = "training")track_modestring Determines the stept to which the data refer. Allowed values: 'training', 'inference'
Returns a list containing the tracked energy consumption, CO2 equivalents in kg, information on the
tracker used, and technical information on the training infrastructure.
get_ml_framework()Method for requesting the machine learning framework used for the model.
AIFEMaster$get_ml_framework()Returns a string describing the machine learning framework used for the classifier.
is_configured()Method for checking if the model was successfully configured. An object can only be used if this
value is TRUE.
AIFEMaster$is_configured()bool TRUE if the model is fully configured. FALSE if not.
is_trained()Check if the TEFeatureExtractor is trained.
AIFEMaster$is_trained()Returns TRUE if the object is trained and FALSE if not.
get_private()Method for requesting all private fields and methods. Used for loading and updating an object.
AIFEMaster$get_private()Returns a list with all private fields and methods.
get_all_fields()Return all fields.
AIFEMaster$get_all_fields()Method returns a list containing all public and private fields
of the object.
get_model_config()Method for requesting the model configuration.
AIFEMaster$get_model_config()Returns a list with all configuration parameters used during configuration.
clone()The objects of this class are cloneable with this method.
AIFEMaster$clone(deep = FALSE)deepWhether to make a deep clone.
Other R6 Classes for Developers:
AIFEBaseModel,
BaseModelCore,
ClassifiersBasedOnTextEmbeddings,
DataManagerClassifier,
LargeDataSetBase,
ModelsBasedOnTextEmbeddings,
TEClassifiersBasedOnProtoNet,
TEClassifiersBasedOnRegular,
TokenizerBase