Type:	Package
Title:	Artificial Intelligence for Education
Version:	1.1.0
Description:	In social and educational settings, the use of Artificial Intelligence (AI) is a challenging task. Relevant data is often only available in handwritten forms, or the use of data is restricted by privacy policies. This often leads to small data sets. Furthermore, in the educational and social sciences, data is often unbalanced in terms of frequencies. To support educators as well as educational and social researchers in using the potentials of AI for their work, this package provides a unified interface for neural nets in 'PyTorch' to deal with natural language problems. In addition, the package ships with a shiny app, providing a graphical user interface. This allows the usage of AI for people without skills in writing python/R scripts. The tools integrate existing mathematical and statistical methods for dealing with small data sets via pseudo-labeling (e.g. Cascante-Bonilla et al. (2020) <doi:10.48550/arXiv.2001.06001>) and imbalanced data via the creation of synthetic cases (e.g. Islam et al. (2012) <doi:10.1016/j.asoc.2021.108288>). Performance evaluation of AI is connected to measures from content analysis which educational and social researchers are generally more familiar with (e.g. Berding & Pargmann (2022) <doi:10.30819/5581>, Gwet (2014) <ISBN:978-0-9708062-8-4>, Krippendorff (2019) <doi:10.4135/9781071878781>). Estimation of energy consumption and CO2 emissions during model training is done with the 'python' library 'codecarbon'. Finally, all objects created with this package allow to share trained AI models with other people.
License:	GPL-3
URL:	https://fberding.github.io/aifeducation/
BugReports:	https://github.com/cran/aifeducation/issues
Depends:	R (≥ 3.5.0)
Imports:	doParallel, foreach, iotarelr(≥ 0.1.5), methods, Rcpp (≥ 1.0.10), reshape2, reticulate (≥ 1.42.0), rlang, stringi, utils
Suggests:	bslib, DT, fs, future, ggplot2, knitr, pkgdown, promises, readtext, readxl, rmarkdown, shiny(≥ 1.9.0), shinyFiles, shinyWidgets, shinycssloaders, sortable, testthat (≥ 3.0.0)
LinkingTo:	Rcpp, RcppArmadillo
VignetteBuilder:	knitr
Config/testthat/edition:	3
Encoding:	UTF-8
LazyData:	true
RoxygenNote:	7.3.2
SystemRequirements:	PyTorch (see vignette "Get started")
Config/Needs/website:	rmarkdown
NeedsCompilation:	yes
Packaged:	2025-08-18 05:00:46 UTC; WissMit
Author:	Berding Florian [aut, cre], Tykhonova Yuliia [aut], Pargmann Julia [ctb], Leube Anna [ctb], Riebenbauer Elisabeth [ctb], Rebmann Karin [ctb], Slopinski Andreas [ctb]
Maintainer:	Berding Florian <florian.berding@uni-hamburg.de>
Repository:	CRAN
Date/Publication:	2025-08-19 09:50:02 UTC

Base R6 class for creation and definition of .AIFE*Transformer-like classes

Description

This base class is used to create and define .AIFE*Transformer-like classes. It serves as a skeleton for a future concrete transformer and cannot be used to create an object of itself (an attempt to call new-method will produce an error).

See p.1 Base Transformer Class in Transformers for Developers for details.

Create

The create-method is a basic algorithm that is used to create a new transformer, but cannot be called directly.

Train

The train-method is a basic algorithm that is used to train and tune the transformer but cannot be called directly.

Concrete transformer implementation

There are already implemented concrete (child) transformers (e.g. BERT, DeBERTa-V2, etc.), to implement a new one see p.4 Implement A Custom Transformer in Transformers for Developers

Public fields

Methods

Public methods

• .AIFEBaseTransformer$new()

• .AIFEBaseTransformer$init_transformer()

• .AIFEBaseTransformer$set_title()

• .AIFEBaseTransformer$set_model_param()

• .AIFEBaseTransformer$set_model_temp()

• .AIFEBaseTransformer$set_SFC_check_max_pos_emb()

• .AIFEBaseTransformer$set_SFC_create_tokenizer_draft()

• .AIFEBaseTransformer$set_SFC_calculate_vocab()

• .AIFEBaseTransformer$set_SFC_save_tokenizer_draft()

• .AIFEBaseTransformer$set_SFC_create_final_tokenizer()

• .AIFEBaseTransformer$set_SFC_create_transformer_model()

• .AIFEBaseTransformer$set_required_SFC()

• .AIFEBaseTransformer$set_SFT_load_existing_model()

• .AIFEBaseTransformer$set_SFT_cuda_empty_cache()

• .AIFEBaseTransformer$set_SFT_create_data_collator()

• .AIFEBaseTransformer$create()

• .AIFEBaseTransformer$train()

• .AIFEBaseTransformer$clone()

Method new()

An object of this class cannot be created. Thus, method's call will produce an error.

Usage

.AIFEBaseTransformer$new()

Returns

This method returns an error.

Method init_transformer()

Method to execute while initializing a new transformer.

Usage

.AIFEBaseTransformer$init_transformer(title, init_trace)

Arguments

Returns

This method returns nothing.s

Method set_title()

Setter for the title. Sets a new value for the title private attribute.

Usage

.AIFEBaseTransformer$set_title(title)

Arguments

Returns

This method returns nothing.

Method set_model_param()

Setter for the parameters. Adds a new parameter and its value to the params list.

Usage

.AIFEBaseTransformer$set_model_param(param_name, param_value)

Arguments

Returns

This method returns nothing.

Method set_model_temp()

Setter for the temporary model's parameters. Adds a new temporary parameter and its value to the temp list.

Usage

.AIFEBaseTransformer$set_model_temp(temp_name, temp_value)

Arguments

Returns

This method returns nothing.

Method set_SFC_check_max_pos_emb()

Setter for the check_max_pos_emb element of the private steps_for_creation list. Sets a new fun function as the check_max_pos_emb step.

Usage

.AIFEBaseTransformer$set_SFC_check_max_pos_emb(fun)

Arguments

Returns

This method returns nothing.

Method set_SFC_create_tokenizer_draft()

Setter for the create_tokenizer_draft element of the private steps_for_creation list. Sets a new fun function as the create_tokenizer_draft step.

Usage

.AIFEBaseTransformer$set_SFC_create_tokenizer_draft(fun)

Arguments

Returns

This method returns nothing.

Method set_SFC_calculate_vocab()

Setter for the calculate_vocab element of the private steps_for_creation list. Sets a new fun function as the calculate_vocab step.

Usage

.AIFEBaseTransformer$set_SFC_calculate_vocab(fun)

Arguments

Returns

This method returns nothing.

Method set_SFC_save_tokenizer_draft()

Setter for the save_tokenizer_draft element of the private steps_for_creation list. Sets a new fun function as the save_tokenizer_draft step.

Usage

.AIFEBaseTransformer$set_SFC_save_tokenizer_draft(fun)

Arguments

Returns

This method returns nothing.

Method set_SFC_create_final_tokenizer()

Setter for the create_final_tokenizer element of the private steps_for_creation list. Sets a new fun function as the create_final_tokenizer step.

Usage

.AIFEBaseTransformer$set_SFC_create_final_tokenizer(fun)

Arguments

Returns

This method returns nothing.

Method set_SFC_create_transformer_model()

Setter for the create_transformer_model element of the private steps_for_creation list. Sets a new fun function as the create_transformer_model step.

Usage

.AIFEBaseTransformer$set_SFC_create_transformer_model(fun)

Arguments

Returns

This method returns nothing.

Method set_required_SFC()

Setter for all required elements of the private steps_for_creation list. Executes setters for all required creation steps.

Usage

.AIFEBaseTransformer$set_required_SFC(required_SFC)

Arguments

Returns

This method returns nothing.

Method set_SFT_load_existing_model()

Setter for the load_existing_model element of the private steps_for_training list. Sets a new fun function as the load_existing_model step.

Usage

.AIFEBaseTransformer$set_SFT_load_existing_model(fun)

Arguments

Returns

This method returns nothing.

Method set_SFT_cuda_empty_cache()

Setter for the cuda_empty_cache element of the private steps_for_training list. Sets a new fun function as the cuda_empty_cache step.

Usage

.AIFEBaseTransformer$set_SFT_cuda_empty_cache(fun)

Arguments

Returns

This method returns nothing.

Method set_SFT_create_data_collator()

Setter for the create_data_collator element of the private steps_for_training list. Sets a new fun function as the create_data_collator step. Use this method to make a custom data collator for a transformer.

Usage

.AIFEBaseTransformer$set_SFT_create_data_collator(fun)

Arguments

Returns

This method returns nothing.

Method create()

This method creates a transformer configuration based on the child-transformer architecture and a vocabulary using the python libraries transformers and tokenizers.

This method adds the following parameters to the temp list:

• log_file

• raw_text_dataset

• pt_safe_save

• value_top

• total_top

• message_top

This method uses the following parameters from the temp list:

• log_file

• raw_text_dataset

• tokenizer

Usage

.AIFEBaseTransformer$create(
  model_dir,
  text_dataset,
  vocab_size,
  max_position_embeddings,
  hidden_size,
  num_attention_heads,
  intermediate_size,
  hidden_act,
  hidden_dropout_prob,
  attention_probs_dropout_prob,
  sustain_track,
  sustain_iso_code,
  sustain_region,
  sustain_interval,
  trace,
  pytorch_safetensors,
  log_dir,
  log_write_interval
)

Arguments

Returns

This method does not return an object. Instead, it saves the configuration and vocabulary of the new model to disk.

Method train()

This method can be used to train or fine-tune a transformer based on BERT architecture with the help of the python libraries transformers, datasets, and tokenizers.

This method adds the following parameters to the temp list:

• log_file

• loss_file

• from_pt

• from_tf

• load_safe

• raw_text_dataset

• pt_safe_save

• value_top

• total_top

• message_top

This method uses the following parameters from the temp list:

• log_file

• raw_text_dataset

• tokenized_dataset

• tokenizer

Usage

.AIFEBaseTransformer$train(
  output_dir,
  model_dir_path,
  text_dataset,
  p_mask,
  whole_word,
  val_size,
  n_epoch,
  batch_size,
  chunk_size,
  full_sequences_only,
  min_seq_len,
  learning_rate,
  sustain_track,
  sustain_iso_code,
  sustain_region,
  sustain_interval,
  trace,
  pytorch_trace,
  pytorch_safetensors,
  log_dir,
  log_write_interval
)

Arguments

Returns

This method does not return an object. Instead, it saves the configuration and vocabulary of the new model to disk.

Method clone()

The objects of this class are cloneable with this method.

Usage

.AIFEBaseTransformer$clone(deep = FALSE)

Arguments

References

Hugging Face transformers documantation:

• BERT

• DeBERTa

• Funnel

• Longformer

• RoBERTa

• MPNet

See Also

Other R6 classes for transformers: .AIFEBertTransformer, .AIFEFunnelTransformer, .AIFELongformerTransformer, .AIFEMpnetTransformer, .AIFERobertaTransformer

Child R6 class for creation and training of BERT transformers

Description

This class has the following methods:

• create: creates a new transformer based on BERT.

• train: trains and fine-tunes a BERT model.

Create

New models can be created using the .AIFEBertTransformer$create method.

Train

To train the model, pass the directory of the model to the method .AIFEBertTransformer$train.

Pre-Trained models that can be fine-tuned using this method are available at https://huggingface.co/.

The model is trained using dynamic masking, as opposed to the original paper, which used static masking.

Super class

aifeducation::.AIFEBaseTransformer -> .AIFEBertTransformer

Methods

Public methods

• .AIFEBertTransformer$new()

• .AIFEBertTransformer$create()

• .AIFEBertTransformer$train()

• .AIFEBertTransformer$clone()

Method new()

Creates a new transformer based on BERT and sets the title.

Usage

.AIFEBertTransformer$new(init_trace = TRUE)

Arguments

Returns

This method returns nothing.

Method create()

This method creates a transformer configuration based on the BERT base architecture and a vocabulary based on WordPiece by using the python libraries transformers and tokenizers.

This method adds the following 'dependent' parameters to the base class's inherited params list:

• vocab_do_lower_case

• num_hidden_layer

Usage

.AIFEBertTransformer$create(
  model_dir,
  text_dataset,
  vocab_size = 30522,
  vocab_do_lower_case = FALSE,
  max_position_embeddings = 512,
  hidden_size = 768,
  num_hidden_layer = 12,
  num_attention_heads = 12,
  intermediate_size = 3072,
  hidden_act = "GELU",
  hidden_dropout_prob = 0.1,
  attention_probs_dropout_prob = 0.1,
  sustain_track = FALSE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead, it saves the configuration and vocabulary of the new model to disk.

Method train()

This method can be used to train or fine-tune a transformer based on BERT architecture with the help of the python libraries transformers, datasets, and tokenizers.

Usage

.AIFEBertTransformer$train(
  output_dir,
  model_dir_path,
  text_dataset,
  p_mask = 0.15,
  whole_word = TRUE,
  val_size = 0.1,
  n_epoch = 1,
  batch_size = 12,
  chunk_size = 250,
  full_sequences_only = FALSE,
  min_seq_len = 50,
  learning_rate = 0.003,
  sustain_track = FALSE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_trace = 1,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead the trained or fine-tuned model is saved to disk.

Method clone()

The objects of this class are cloneable with this method.

Usage

.AIFEBertTransformer$clone(deep = FALSE)

Arguments

Note

This model uses a WordPiece tokenizer like BERT and can be trained with whole word masking. The transformer library may display a warning, which can be ignored.

References

Devlin, J., Chang, M.‑W., Lee, K., & Toutanova, K. (2019). BERT: Pre-training of Deep Bidirectional Transformers for Language Understanding. In J. Burstein, C. Doran, & T. Solorio (Eds.), Proceedings of the 2019 Conference of the North (pp. 4171–4186). Association for Computational Linguistics. doi:10.18653/v1/N19-1423

Hugging Face documentation

• https://huggingface.co/docs/transformers/model_doc/bert

• https://huggingface.co/docs/transformers/model_doc/bert#transformers.BertForMaskedLM

• https://huggingface.co/docs/transformers/model_doc/bert#transformers.TFBertForMaskedLM

See Also

Other R6 classes for transformers: .AIFEBaseTransformer, .AIFEFunnelTransformer, .AIFELongformerTransformer, .AIFEMpnetTransformer, .AIFERobertaTransformer

Child R6 class for creation and training of Funnel transformers

Description

This class has the following methods:

• create: creates a new transformer based on Funnel.

• train: trains and fine-tunes a Funnel model.

Create

New models can be created using the .AIFEFunnelTransformer$create method.

Model is created with separete_cls = TRUE, truncate_seq = TRUE, and pool_q_only = TRUE.

Train

To train the model, pass the directory of the model to the method .AIFEFunnelTransformer$train.

Pre-Trained models which can be fine-tuned with this function are available at https://huggingface.co/.

Training of the model makes use of dynamic masking.

Super class

aifeducation::.AIFEBaseTransformer -> .AIFEFunnelTransformer

Methods

Public methods

• .AIFEFunnelTransformer$new()

• .AIFEFunnelTransformer$create()

• .AIFEFunnelTransformer$train()

• .AIFEFunnelTransformer$clone()

Method new()

Creates a new transformer based on Funnel and sets the title.

Usage

.AIFEFunnelTransformer$new(init_trace = TRUE)

Arguments

Returns

This method returns nothing.

Method create()

This method creates a transformer configuration based on the Funnel transformer base architecture and a vocabulary based on WordPiece using the python transformers and tokenizers libraries.

This method adds the following 'dependent' parameters to the base class's inherited params list:

• vocab_do_lower_case

• target_hidden_size

• block_sizes

• num_decoder_layers

• pooling_type

• activation_dropout

Usage

.AIFEFunnelTransformer$create(
  model_dir,
  text_dataset,
  vocab_size = 30522,
  vocab_do_lower_case = FALSE,
  max_position_embeddings = 512,
  hidden_size = 768,
  target_hidden_size = 64,
  block_sizes = c(4, 4, 4),
  num_attention_heads = 12,
  intermediate_size = 3072,
  num_decoder_layers = 2,
  pooling_type = "Mean",
  hidden_act = "GELU",
  hidden_dropout_prob = 0.1,
  attention_probs_dropout_prob = 0.1,
  activation_dropout = 0,
  sustain_track = TRUE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead, it saves the configuration and vocabulary of the new model to disk.

Method train()

This method can be used to train or fine-tune a transformer based on Funnel Transformer architecture with the help of the python libraries transformers, datasets, and tokenizers.

Usage

.AIFEFunnelTransformer$train(
  output_dir,
  model_dir_path,
  text_dataset,
  p_mask = 0.15,
  whole_word = TRUE,
  val_size = 0.1,
  n_epoch = 1,
  batch_size = 12,
  chunk_size = 250,
  full_sequences_only = FALSE,
  min_seq_len = 50,
  learning_rate = 0.003,
  sustain_track = TRUE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_trace = 1,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead the trained or fine-tuned model is saved to disk.

Method clone()

The objects of this class are cloneable with this method.

Usage

.AIFEFunnelTransformer$clone(deep = FALSE)

Arguments

Note

The model uses a configuration with truncate_seq = TRUE to avoid implementation problems with tensorflow.

This model uses a WordPiece tokenizer like BERT and can be trained with whole word masking. The transformer library may display a warning, which can be ignored.

References

Dai, Z., Lai, G., Yang, Y. & Le, Q. V. (2020). Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing. doi:10.48550/arXiv.2006.03236

Hugging Face documentation

• https://huggingface.co/docs/transformers/model_doc/funnel#funnel-transformer

• https://huggingface.co/docs/transformers/model_doc/funnel#transformers.FunnelModel

• https://huggingface.co/docs/transformers/model_doc/funnel#transformers.TFFunnelModel

See Also

Other R6 classes for transformers: .AIFEBaseTransformer, .AIFEBertTransformer, .AIFELongformerTransformer, .AIFEMpnetTransformer, .AIFERobertaTransformer

Child R6 class for creation and training of Longformer transformers

Description

This class has the following methods:

• create: creates a new transformer based on Longformer.

• train: trains and fine-tunes a Longformer model.

Create

New models can be created using the .AIFELongformerTransformer$create method.

Train

To train the model, pass the directory of the model to the method .AIFELongformerTransformer$train.

Pre-Trained models which can be fine-tuned with this function are available at https://huggingface.co/.

Training of this model makes use of dynamic masking.

Super class

aifeducation::.AIFEBaseTransformer -> .AIFELongformerTransformer

Methods

Public methods

• .AIFELongformerTransformer$new()

• .AIFELongformerTransformer$create()

• .AIFELongformerTransformer$train()

• .AIFELongformerTransformer$clone()

Method new()

Creates a new transformer based on Longformer and sets the title.

Usage

.AIFELongformerTransformer$new(init_trace = TRUE)

Arguments

Returns

This method returns nothing.

Method create()

This method creates a transformer configuration based on the Longformer base architecture and a vocabulary based on ⁠Byte-Pair Encoding⁠ (BPE) tokenizer using the python transformers and tokenizers libraries.

This method adds the following 'dependent' parameters to the base class's inherited params list:

• add_prefix_space

• trim_offsets

• num_hidden_layer

• attention_window

Usage

.AIFELongformerTransformer$create(
  model_dir,
  text_dataset,
  vocab_size = 30522,
  add_prefix_space = FALSE,
  trim_offsets = TRUE,
  max_position_embeddings = 512,
  hidden_size = 768,
  num_hidden_layer = 12,
  num_attention_heads = 12,
  intermediate_size = 3072,
  hidden_act = "GELU",
  hidden_dropout_prob = 0.1,
  attention_probs_dropout_prob = 0.1,
  attention_window = 512,
  sustain_track = TRUE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead, it saves the configuration and vocabulary of the new model to disk.

Method train()

This method can be used to train or fine-tune a transformer based on Longformer Transformer architecture with the help of the python libraries transformers, datasets, and tokenizers.

Usage

.AIFELongformerTransformer$train(
  output_dir,
  model_dir_path,
  text_dataset,
  p_mask = 0.15,
  val_size = 0.1,
  n_epoch = 1,
  batch_size = 12,
  chunk_size = 250,
  full_sequences_only = FALSE,
  min_seq_len = 50,
  learning_rate = 0.03,
  sustain_track = TRUE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_trace = 1,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead the trained or fine-tuned model is saved to disk.

Method clone()

The objects of this class are cloneable with this method.

Usage

.AIFELongformerTransformer$clone(deep = FALSE)

Arguments

References

Beltagy, I., Peters, M. E., & Cohan, A. (2020). Longformer: The Long-Document Transformer. doi:10.48550/arXiv.2004.05150

Hugging Face Documentation

• https://huggingface.co/docs/transformers/model_doc/longformer

• https://huggingface.co/docs/transformers/model_doc/longformer#transformers.LongformerModel

• https://huggingface.co/docs/transformers/model_doc/longformer#transformers.TFLongformerModel

See Also

Other R6 classes for transformers: .AIFEBaseTransformer, .AIFEBertTransformer, .AIFEFunnelTransformer, .AIFEMpnetTransformer, .AIFERobertaTransformer

Child R6 class for creation and training of ModernBERT transformers

Description

This class has the following methods:

• create: creates a new transformer based on ModernBERT.

• train: trains and fine-tunes a ModernBERT model.

Create

New models can be created using the .AIFEModernBertTransformer$create method.

Train

To train the model, pass the directory of the model to the method .AIFEModernBertTransformer$train.

Pre-Trained models that can be fine-tuned using this method are available at https://huggingface.co/.

The model is trained using dynamic masking, as opposed to the original paper, which used static masking.

Super class

aifeducation::.AIFEBaseTransformer -> .AIFEModernBertTransformer

Methods

Public methods

• .AIFEModernBertTransformer$new()

• .AIFEModernBertTransformer$create()

• .AIFEModernBertTransformer$train()

• .AIFEModernBertTransformer$clone()

Method new()

Creates a new transformer based on ModernBERT and sets the title.

Usage

.AIFEModernBertTransformer$new(init_trace = TRUE)

Arguments

Returns

This method returns nothing.

Method create()

This method creates a transformer configuration based on the ModernBERT base architecture and a vocabulary based on WordPiece by using the python libraries transformers and tokenizers.

This method adds the following 'dependent' parameters to the base class's inherited params list:

• vocab_do_lower_case

• num_hidden_layer

Usage

.AIFEModernBertTransformer$create(
  model_dir,
  text_dataset,
  vocab_size = 30522,
  vocab_do_lower_case = FALSE,
  max_position_embeddings = 512,
  hidden_size = 768,
  num_hidden_layer = 12,
  num_attention_heads = 12,
  intermediate_size = 3072,
  hidden_act = "GELU",
  hidden_dropout_prob = 0.1,
  attention_probs_dropout_prob = 0.1,
  sustain_track = FALSE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead, it saves the configuration and vocabulary of the new model to disk.

Method train()

This method can be used to train or fine-tune a transformer based on ModernBERT architecture with the help of the python libraries transformers, datasets, and tokenizers.

Usage

.AIFEModernBertTransformer$train(
  output_dir,
  model_dir_path,
  text_dataset,
  p_mask = 0.15,
  whole_word = TRUE,
  val_size = 0.1,
  n_epoch = 1,
  batch_size = 12,
  chunk_size = 250,
  full_sequences_only = FALSE,
  min_seq_len = 50,
  learning_rate = 0.003,
  sustain_track = FALSE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_trace = 1,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead the trained or fine-tuned model is saved to disk.

Method clone()

The objects of this class are cloneable with this method.

Usage

.AIFEModernBertTransformer$clone(deep = FALSE)

Arguments

Note

This model uses a WordPiece tokenizer like BERT and can be trained with whole word masking. The transformer library may display a warning, which can be ignored.

References

Devlin, J., Chang, M.‑W., Lee, K., & Toutanova, K. (2019). BERT: Pre-training of Deep Bidirectional Transformers for Language Understanding. In J. Burstein, C. Doran, & T. Solorio (Eds.), Proceedings of the 2019 Conference of the North (pp. 4171–4186). Association for Computational Linguistics. doi:10.18653/v1/N19-1423

Hugging Face documentation

• https://huggingface.co/docs/transformers/model_doc/bert

• https://huggingface.co/docs/transformers/model_doc/bert#transformers.BertForMaskedLM

• https://huggingface.co/docs/transformers/model_doc/bert#transformers.TFBertForMaskedLM

See Also

Other Transformers for developers: .AIFETrConfig, .AIFETrModel, .AIFETrModelMLM, .AIFETrObj, .AIFETrTokenizer, .aife_transformer.check_type(), aife_transformer.load_model(), aife_transformer.load_model_config(), aife_transformer.load_model_mlm(), aife_transformer.load_tokenizer()

Child R6 class for creation and training of MPNet transformers

Description

This class has the following methods:

• create: creates a new transformer based on MPNet.

• train: trains and fine-tunes a MPNet model.

Create

New models can be created using the .AIFEMpnetTransformer$create method.

Train

To train the model, pass the directory of the model to the method .AIFEMpnetTransformer$train.

Super class

aifeducation::.AIFEBaseTransformer -> .AIFEMpnetTransformer

Public fields

Methods

Public methods

• .AIFEMpnetTransformer$new()

• .AIFEMpnetTransformer$create()

• .AIFEMpnetTransformer$train()

• .AIFEMpnetTransformer$clone()

Method new()

Creates a new transformer based on MPNet and sets the title.

Usage

.AIFEMpnetTransformer$new(init_trace = TRUE)

Arguments

Returns

This method returns nothing.

Method create()

This method creates a transformer configuration based on the MPNet base architecture.

This method adds the following 'dependent' parameters to the base class's inherited params list:

• vocab_do_lower_case

• num_hidden_layer

Usage

.AIFEMpnetTransformer$create(
  model_dir,
  text_dataset,
  vocab_size = 30522,
  vocab_do_lower_case = FALSE,
  max_position_embeddings = 512,
  hidden_size = 768,
  num_hidden_layer = 12,
  num_attention_heads = 12,
  intermediate_size = 3072,
  hidden_act = "GELU",
  hidden_dropout_prob = 0.1,
  attention_probs_dropout_prob = 0.1,
  sustain_track = FALSE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead, it saves the configuration and vocabulary of the new model to disk.

Method train()

This method can be used to train or fine-tune a transformer based on MPNet architecture with the help of the python libraries transformers, datasets, and tokenizers.

This method adds the following 'dependent' parameter to the base class's inherited params list:

• p_perm

Usage

.AIFEMpnetTransformer$train(
  output_dir,
  model_dir_path,
  text_dataset,
  p_mask = 0.15,
  p_perm = 0.15,
  whole_word = TRUE,
  val_size = 0.1,
  n_epoch = 1,
  batch_size = 12,
  chunk_size = 250,
  full_sequences_only = FALSE,
  min_seq_len = 50,
  learning_rate = 0.003,
  sustain_track = FALSE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_trace = 1,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead the trained or fine-tuned model is saved to disk.

Method clone()

The objects of this class are cloneable with this method.

Usage

.AIFEMpnetTransformer$clone(deep = FALSE)

Arguments

Note

Using this class with tensorflow is not supported. Supported framework is pytorch.

References

Song,K., Tan, X., Qin, T., Lu, J. & Liu, T.-Y. (2020). MPNet: Masked and Permuted Pre-training for Language Understanding. doi:10.48550/arXiv.2004.09297

Hugging Face documentation

• https://huggingface.co/docs/transformers/model_doc/mpnet

• https://huggingface.co/docs/transformers/model_doc/mpnet#transformers.MPNetForMaskedLM

• https://huggingface.co/docs/transformers/model_doc/mpnet#transformers.TFMPNetForMaskedLM

See Also

Other R6 classes for transformers: .AIFEBaseTransformer, .AIFEBertTransformer, .AIFEFunnelTransformer, .AIFELongformerTransformer, .AIFERobertaTransformer

Child R6 class for creation and training of RoBERTa transformers

Description

This class has the following methods:

• create: creates a new transformer based on RoBERTa.

• train: trains and fine-tunes a RoBERTa model.

Create

New models can be created using the .AIFERobertaTransformer$create method.

Train

To train the model, pass the directory of the model to the method .AIFERobertaTransformer$train.

Pre-Trained models which can be fine-tuned with this function are available at https://huggingface.co/.

Training of this model makes use of dynamic masking.

Super class

aifeducation::.AIFEBaseTransformer -> .AIFERobertaTransformer

Methods

Public methods

• .AIFERobertaTransformer$new()

• .AIFERobertaTransformer$create()

• .AIFERobertaTransformer$train()

• .AIFERobertaTransformer$clone()

Method new()

Creates a new transformer based on RoBERTa and sets the title.

Usage

.AIFERobertaTransformer$new(init_trace = TRUE)

Arguments

Returns

This method returns nothing.

Method create()

This method creates a transformer configuration based on the RoBERTa base architecture and a vocabulary based on ⁠Byte-Pair Encoding⁠ (BPE) tokenizer using the python transformers and tokenizers libraries.

This method adds the following 'dependent' parameters to the base class' inherited params list:

• add_prefix_space

• trim_offsets

• num_hidden_layer

Usage

.AIFERobertaTransformer$create(
  model_dir,
  text_dataset,
  vocab_size = 30522,
  add_prefix_space = FALSE,
  trim_offsets = TRUE,
  max_position_embeddings = 512,
  hidden_size = 768,
  num_hidden_layer = 12,
  num_attention_heads = 12,
  intermediate_size = 3072,
  hidden_act = "GELU",
  hidden_dropout_prob = 0.1,
  attention_probs_dropout_prob = 0.1,
  sustain_track = TRUE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead, it saves the configuration and vocabulary of the new model to disk.

Method train()

This method can be used to train or fine-tune a transformer based on RoBERTa Transformer architecture with the help of the python libraries transformers, datasets, and tokenizers.

Usage

.AIFERobertaTransformer$train(
  output_dir,
  model_dir_path,
  text_dataset,
  p_mask = 0.15,
  val_size = 0.1,
  n_epoch = 1,
  batch_size = 12,
  chunk_size = 250,
  full_sequences_only = FALSE,
  min_seq_len = 50,
  learning_rate = 0.03,
  sustain_track = TRUE,
  sustain_iso_code = NULL,
  sustain_region = NULL,
  sustain_interval = 15,
  trace = TRUE,
  pytorch_trace = 1,
  pytorch_safetensors = TRUE,
  log_dir = NULL,
  log_write_interval = 2
)

Arguments

Returns

This method does not return an object. Instead the trained or fine-tuned model is saved to disk.

Method clone()

The objects of this class are cloneable with this method.

Usage

.AIFERobertaTransformer$clone(deep = FALSE)

Arguments

References

Liu, Y., Ott, M., Goyal, N., Du, J., Joshi, M., Chen, D., Levy, O., Lewis, M., Zettlemoyer, L., & Stoyanov, V. (2019). RoBERTa: A Robustly Optimized BERT Pretraining Approach. doi:10.48550/arXiv.1907.11692

Hugging Face Documentation

• https://huggingface.co/docs/transformers/model_doc/roberta

• https://huggingface.co/docs/transformers/model_doc/roberta#transformers.RobertaModel

• https://huggingface.co/docs/transformers/model_doc/roberta#transformers.TFRobertaModel

See Also

Other R6 classes for transformers: .AIFEBaseTransformer, .AIFEBertTransformer, .AIFEFunnelTransformer, .AIFELongformerTransformer, .AIFEMpnetTransformer

Configuration class names

Description

This list contains configuration class names. Elements of the list are used in aife_transformer.load_model_config() to get a configuration for a transformer model. This list is not designed to be used directly.

Usage

.AIFETrConfig

Format

An object of class list of length 6.

See Also

Other Transformers for developers: .AIFEModernBertTransformer, .AIFETrModel, .AIFETrModelMLM, .AIFETrObj, .AIFETrTokenizer, .aife_transformer.check_type(), aife_transformer.load_model(), aife_transformer.load_model_config(), aife_transformer.load_model_mlm(), aife_transformer.load_tokenizer()

Model class names

Description

This list contains model class names. Elements of the list are used in aife_transformer.load_model() to get a transformer model. This list is not designed to be used directly.

Usage

.AIFETrModel

Format

An object of class list of length 6.

See Also

Other Transformers for developers: .AIFEModernBertTransformer, .AIFETrConfig, .AIFETrModelMLM, .AIFETrObj, .AIFETrTokenizer, .aife_transformer.check_type(), aife_transformer.load_model(), aife_transformer.load_model_config(), aife_transformer.load_model_mlm(), aife_transformer.load_tokenizer()

MLM-Model class names

Description

This list contains MLM-model class names. Elements of the list are used in aife_transformer.load_model() to get a transformer MLM-model. This list is not designed to be used directly.

Usage

.AIFETrModelMLM

Format

An object of class list of length 6.

See Also

Other Transformers for developers: .AIFEModernBertTransformer, .AIFETrConfig, .AIFETrModel, .AIFETrObj, .AIFETrTokenizer, .aife_transformer.check_type(), aife_transformer.load_model(), aife_transformer.load_model_config(), aife_transformer.load_model_mlm(), aife_transformer.load_tokenizer()

Transformer objects

Description

This list contains transformer objects. Elements of the list can be used in aife_transformer.make() function as input parameter type. This list is not designed to be used directly.

It has the following elements: bert, roberta, funnel, longformer, mpnet, modernbert

Usage

.AIFETrObj

Format

An object of class list of length 6.

See Also

Other Transformers for developers: .AIFEModernBertTransformer, .AIFETrConfig, .AIFETrModel, .AIFETrModelMLM, .AIFETrTokenizer, .aife_transformer.check_type(), aife_transformer.load_model(), aife_transformer.load_model_config(), aife_transformer.load_model_mlm(), aife_transformer.load_tokenizer()

Tokenizer class names

Description

This list contains tokenizer class names. Elements of the list are used in aife_transformer.load_tokenizer() to get a tokenizer for a transformer model. This list is not designed to be used directly.

Usage

.AIFETrTokenizer

Format

An object of class list of length 6.

See Also

Other Transformers for developers: .AIFEModernBertTransformer, .AIFETrConfig, .AIFETrModel, .AIFETrModelMLM, .AIFETrObj, .aife_transformer.check_type(), aife_transformer.load_model(), aife_transformer.load_model_config(), aife_transformer.load_model_mlm(), aife_transformer.load_tokenizer()

Check transformer type

Description

Check the passed type of transformer.

Usage

.aife_transformer.check_type(type)

Arguments

Value

If success - nothing, otherwise - an error.

See Also

Other Transformers for developers: .AIFEModernBertTransformer, .AIFETrConfig, .AIFETrModel, .AIFETrModelMLM, .AIFETrObj, .AIFETrTokenizer, aife_transformer.load_model(), aife_transformer.load_model_config(), aife_transformer.load_model_mlm(), aife_transformer.load_tokenizer()

Base class for models using neural nets

Description

Abstract class for all models that do not rely on the python library 'transformers'. 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.

Value

A new object of this class.

Public fields

Methods

Public methods

• AIFEBaseModel$get_model_info()

• AIFEBaseModel$set_publication_info()

• AIFEBaseModel$get_publication_info()

• AIFEBaseModel$set_model_license()

• AIFEBaseModel$get_model_license()

• AIFEBaseModel$set_documentation_license()

• AIFEBaseModel$get_documentation_license()

• AIFEBaseModel$set_model_description()

• AIFEBaseModel$get_model_description()

• AIFEBaseModel$save()

• AIFEBaseModel$load()

• AIFEBaseModel$get_package_versions()

• AIFEBaseModel$get_sustainability_data()

• AIFEBaseModel$get_ml_framework()

• AIFEBaseModel$count_parameter()

• AIFEBaseModel$is_configured()

• AIFEBaseModel$is_trained()

• AIFEBaseModel$get_private()

• AIFEBaseModel$get_all_fields()

• AIFEBaseModel$clone()

Method get_model_info()

Method for requesting the model information.

Usage

AIFEBaseModel$get_model_info()

Returns

list of all relevant model information.

Method set_publication_info()

Method for setting publication information of the model.

Usage

AIFEBaseModel$set_publication_info(authors, citation, url = NULL)

Arguments

Returns

Function does not return a value. It is used for setting the private members for publication information.

Method get_publication_info()

Method for requesting the bibliographic information of the model.

Usage

AIFEBaseModel$get_publication_info()

Returns

list with all saved bibliographic information.

Method set_model_license()

Method for setting the license of the model.

Usage

AIFEBaseModel$set_model_license(license = "CC BY")

Arguments

Returns

Function does not return a value. It is used for setting the private member for the software license of the model.

Method get_model_license()

Method for getting the license of the model.

Usage

AIFEBaseModel$get_model_license()

Arguments

Returns

string representing the license for the model.

Method set_documentation_license()

Method for setting the license of the model's documentation.

Usage

AIFEBaseModel$set_documentation_license(license = "CC BY")

Arguments

Returns

Function does not return a value. It is used for setting the private member for the documentation license of the model.

Method get_documentation_license()

Method for getting the license of the model's documentation.

Usage

AIFEBaseModel$get_documentation_license()

Arguments

Returns

Returns the license as a string.

Method set_model_description()

Method for setting a description of the model.

Usage

AIFEBaseModel$set_model_description(
  eng = NULL,
  native = NULL,
  abstract_eng = NULL,
  abstract_native = NULL,
  keywords_eng = NULL,
  keywords_native = NULL
)

Arguments

Returns

Function does not return a value. It is used for setting the private members for the description of the model.

Method get_model_description()

Method for requesting the model description.

Usage

AIFEBaseModel$get_model_description()

Returns

list with the description of the classifier in English and the native language.

Method save()

Method for saving a model.

Usage

AIFEBaseModel$save(dir_path, folder_name)

Arguments

Returns

Function does not return a value. It saves the model to disk.

Method load()

Method for importing a model.

Usage

AIFEBaseModel$load(dir_path)

Arguments

Returns

Function does not return a value. It is used to load the weights of a model.

Method get_package_versions()

Method for requesting a summary of the R and python packages' versions used for creating the model.

Usage

AIFEBaseModel$get_package_versions()

Returns

Returns a list containing the versions of the relevant R and python packages.

Method get_sustainability_data()

Method for requesting a summary of tracked energy consumption during training and an estimate of the resulting CO2 equivalents in kg.

Usage

AIFEBaseModel$get_sustainability_data()

Returns

Returns a list containing the tracked energy consumption, CO2 equivalents in kg, information on the tracker used, and technical information on the training infrastructure.

Method get_ml_framework()

Method for requesting the machine learning framework used for the model.

Usage

AIFEBaseModel$get_ml_framework()

Returns

Returns a string describing the machine learning framework used for the classifier.

Method count_parameter()

Method for counting the trainable parameters of a model.

Usage

AIFEBaseModel$count_parameter()

Returns

Returns the number of trainable parameters of the model.

Method is_configured()

Method for checking if the model was successfully configured. An object can only be used if this value is TRUE.

Usage

AIFEBaseModel$is_configured()

Returns

bool TRUE if the model is fully configured. FALSE if not.

Method is_trained()

Check if the TEFeatureExtractor is trained.

Usage

AIFEBaseModel$is_trained()

Returns

Returns TRUE if the object is trained and FALSE if not.

Method get_private()

Method for requesting all private fields and methods. Used for loading and updating an object.

Usage

AIFEBaseModel$get_private()

Returns

Returns a list with all private fields and methods.

Method get_all_fields()

Return all fields.

Usage

AIFEBaseModel$get_all_fields()

Returns

Method returns a list containing all public and private fields of the object.

Method clone()

The objects of this class are cloneable with this method.

Usage

AIFEBaseModel$clone(deep = FALSE)

Arguments

See Also

Other R6 Classes for Developers: ClassifiersBasedOnTextEmbeddings, LargeDataSetBase, ModelsBasedOnTextEmbeddings, TEClassifiersBasedOnProtoNet, TEClassifiersBasedOnRegular

Transformer types

Description

This list contains transformer types. Elements of the list can be used in aife_transformer.make() function as input parameter type.

It has the following elements:

• bert = 'bert'

• roberta = 'roberta'

• funnel = 'funnel'

• longformer = 'longformer'

• mpnet = 'mpnet'

• modernbert = 'modernbert'

  Elements can be used like AIFETrType$bert, AIFETrType$modernbert, AIFETrType$funnel, etc.

Usage

AIFETrType

Format

An object of class list of length 6.

See Also

Other Transformer: aife_transformer.make()

Abstract class for all classifiers that use numerical representations of texts instead of words.

Description

Base class for classifiers relying on EmbeddedText or LargeDataSetForTextEmbeddings generated with a TextEmbeddingModel.

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.

Value

A new object of this class.

Super classes

aifeducation::AIFEBaseModel -> aifeducation::ModelsBasedOnTextEmbeddings -> ClassifiersBasedOnTextEmbeddings

Public fields

Methods

Public methods

• ClassifiersBasedOnTextEmbeddings$predict()

• ClassifiersBasedOnTextEmbeddings$check_embedding_model()

• ClassifiersBasedOnTextEmbeddings$check_feature_extractor_object_type()

• ClassifiersBasedOnTextEmbeddings$requires_compression()

• ClassifiersBasedOnTextEmbeddings$save()

• ClassifiersBasedOnTextEmbeddings$load_from_disk()

• ClassifiersBasedOnTextEmbeddings$adjust_target_levels()

• ClassifiersBasedOnTextEmbeddings$plot_training_history()

• ClassifiersBasedOnTextEmbeddings$plot_coding_stream()

• ClassifiersBasedOnTextEmbeddings$clone()

Method predict()

Method for predicting new data with a trained neural net.

Usage

ClassifiersBasedOnTextEmbeddings$predict(
  newdata,
  batch_size = 32,
  ml_trace = 1
)

Arguments

Returns

Returns a data.frame containing the predictions and the probabilities of the different labels for each case.

Method check_embedding_model()

Method for checking if the provided text embeddings are created with the same TextEmbeddingModel as the classifier.

Usage

ClassifiersBasedOnTextEmbeddings$check_embedding_model(
  text_embeddings,
  require_compressed = FALSE
)

Arguments

Returns

TRUE if the underlying TextEmbeddingModel is the same. FALSE if the models differ.

Method check_feature_extractor_object_type()

Method for checking an object of class TEFeatureExtractor.

Usage

ClassifiersBasedOnTextEmbeddings$check_feature_extractor_object_type(
  feature_extractor
)

Arguments

Returns

This method does nothing returns. It raises an error if

• the object is NULL

• the object does not rely on the same machine learning framework as the classifier

• the object is not trained.

Method requires_compression()

Method for checking if provided text embeddings must be compressed via a TEFeatureExtractor before processing.

Usage

ClassifiersBasedOnTextEmbeddings$requires_compression(text_embeddings)

Arguments

Returns

Return TRUE if a compression is necessary and FALSE if not.

Method save()

Method for saving a model.

Usage

ClassifiersBasedOnTextEmbeddings$save(dir_path, folder_name)

Arguments

Returns

Function does not return a value. It saves the model to disk.

Method load_from_disk()

loads an object from disk and updates the object to the current version of the package.

Usage

ClassifiersBasedOnTextEmbeddings$load_from_disk(dir_path)

Arguments

Returns

Method does not return anything. It loads an object from disk.

Method adjust_target_levels()

Method transforms the levels of a factor into numbers corresponding to the models definition.

Usage

ClassifiersBasedOnTextEmbeddings$adjust_target_levels(data_targets)

Arguments

Returns

Method returns a factor containing the numerical representation of categories/classes.

Method plot_training_history()

Method for requesting a plot of the training history. This method requires the R package 'ggplot2' to work.

Usage

ClassifiersBasedOnTextEmbeddings$plot_training_history(
  final_training = FALSE,
  pl_step = NULL,
  measure = "loss",
  y_min = NULL,
  y_max = NULL,
  add_min_max = TRUE,
  text_size = 10
)

Arguments

Returns

Returns a plot of class ggplot visualizing the training process.

Method plot_coding_stream()

Method for requesting a plot the coding stream. The plot shows how the cases of different categories/classes are assigned to a the available classes/categories. The visualization is helpful for analyzing the consequences of coding errors.

Usage

ClassifiersBasedOnTextEmbeddings$plot_coding_stream(
  label_categories_size = 3,
  key_size = 0.5,
  text_size = 10
)

Arguments

Returns

Returns a plot of class ggplot visualizing the training process.

Method clone()

The objects of this class are cloneable with this method.

Usage

ClassifiersBasedOnTextEmbeddings$clone(deep = FALSE)

Arguments

See Also

Other R6 Classes for Developers: AIFEBaseModel, LargeDataSetBase, ModelsBasedOnTextEmbeddings, TEClassifiersBasedOnProtoNet, TEClassifiersBasedOnRegular

Data manager for classification tasks

Description

Abstract class for managing the data and samples during training a classifier. DataManagerClassifier is used with all classifiers based on text embeddings.

Value

Objects of this class are used for ensuring the correct data management for training different types of classifiers. They are also used for data augmentation by creating synthetic cases with different techniques.

Public fields

Methods

Public methods

• DataManagerClassifier$new()

• DataManagerClassifier$get_config()

• DataManagerClassifier$get_labeled_data()

• DataManagerClassifier$get_unlabeled_data()

• DataManagerClassifier$get_samples()

• DataManagerClassifier$set_state()

• DataManagerClassifier$get_n_folds()

• DataManagerClassifier$get_n_classes()

• DataManagerClassifier$get_statistics()

• DataManagerClassifier$contains_unlabeled_data()

• DataManagerClassifier$get_dataset()

• DataManagerClassifier$get_val_dataset()

• DataManagerClassifier$get_test_dataset()

• DataManagerClassifier$create_synthetic()

• DataManagerClassifier$add_replace_pseudo_data()

• DataManagerClassifier$clone()

Method new()

Creating a new instance of this class.

Usage

DataManagerClassifier$new(
  data_embeddings,
  data_targets,
  folds = 5,
  val_size = 0.25,
  pad_value = -100,
  class_levels,
  one_hot_encoding = TRUE,
  add_matrix_map = TRUE,
  sc_methods = "knnor",
  sc_min_k = 1,
  sc_max_k = 10,
  trace = TRUE,
  n_cores = auto_n_cores()
)

Arguments

Returns

Method returns an initialized object of class DataManagerClassifier.

Method get_config()

Method for requesting the configuration of the DataManagerClassifier.

Usage

DataManagerClassifier$get_config()

Returns

Returns a list storing the configuration of the DataManagerClassifier.

Method get_labeled_data()

Method for requesting the complete labeled data set.

Usage

DataManagerClassifier$get_labeled_data()

Returns

Returns an object of class datasets.arrow_dataset.Dataset containing all cases with labels.

Method get_unlabeled_data()

Method for requesting the complete unlabeled data set.

Usage

DataManagerClassifier$get_unlabeled_data()

Returns

Returns an object of class datasets.arrow_dataset.Dataset containing all cases without labels.

Method get_samples()

Method for requesting the assignments to train, validation, and test data sets for every fold and the final training.

Usage

DataManagerClassifier$get_samples()

Returns

Returns a list storing the assignments to a train, validation, and test data set for every fold. In the case of the sample for the final training the test data set is always empty (NULL).

Method set_state()

Method for setting the current state of the DataManagerClassifier.

Usage

DataManagerClassifier$set_state(iteration, step = NULL)

Arguments

Returns

Method does not return anything. It is used for setting the internal state of the DataManager.

Method get_n_folds()

Method for requesting the number of folds the DataManagerClassifier can use with the current data.

Usage

DataManagerClassifier$get_n_folds()

Returns

Returns the number of folds the DataManagerClassifier uses.

Method get_n_classes()

Method for requesting the number of classes.

Usage

DataManagerClassifier$get_n_classes()

Returns

Returns the number classes.

Method get_statistics()

Method for requesting descriptive sample statistics.

Usage

DataManagerClassifier$get_statistics()

Returns

Returns a table describing the absolute frequencies of the labeled and unlabeled data. The rows contain the length of the sequences while the columns contain the labels.

Method contains_unlabeled_data()

Method for checking if the dataset contains cases without labels.

Usage

DataManagerClassifier$contains_unlabeled_data()

Returns

Returns TRUE if the dataset contains cases without labels. Returns FALSE if all cases have labels.

Method get_dataset()

Method for requesting a data set for training depending in the current state of the DataManagerClassifier.

Usage

DataManagerClassifier$get_dataset(
  inc_labeled = TRUE,
  inc_unlabeled = FALSE,
  inc_synthetic = FALSE,
  inc_pseudo_data = FALSE
)

Arguments

Returns

Returns an object of class datasets.arrow_dataset.Dataset containing the requested kind of data along with all requested transformations for training. Please note that this method returns a data sets that is designed for training only. The corresponding validation data set is requested with get_val_dataset and the corresponding test data set with get_test_dataset.

Method get_val_dataset()

Method for requesting a data set for validation depending in the current state of the DataManagerClassifier.

Usage

DataManagerClassifier$get_val_dataset()

Returns

Returns an object of class datasets.arrow_dataset.Dataset containing the requested kind of data along with all requested transformations for validation. The corresponding data set for training can be requested with get_dataset and the corresponding data set for testing with get_test_dataset.

Method get_test_dataset()

Method for requesting a data set for testing depending in the current state of the DataManagerClassifier.

Usage

DataManagerClassifier$get_test_dataset()

Returns

Returns an object of class datasets.arrow_dataset.Dataset containing the requested kind of data along with all requested transformations for validation. The corresponding data set for training can be requested with get_dataset and the corresponding data set for validation with get_val_dataset.

Method create_synthetic()

Method for generating synthetic data used during training. The process uses all labeled data belonging to the current state of the DataManagerClassifier.

Usage

DataManagerClassifier$create_synthetic(trace = TRUE, inc_pseudo_data = FALSE)

Arguments

Returns

This method does nothing return. It generates a new data set for synthetic cases which are stored as an object of class datasets.arrow_dataset.Dataset in the field datasets$data_labeled_synthetic. Please note that a call of this method will override an existing data set in the corresponding field.

Method add_replace_pseudo_data()

Method for adding data with pseudo labels generated by a classifier

Usage

DataManagerClassifier$add_replace_pseudo_data(inputs, labels)

Arguments

Returns

This method does nothing return. It generates a new data set for synthetic cases which are stored as an object of class datasets.arrow_dataset.Dataset in the field datasets$data_labeled_pseudo. Please note that a call of this method will override an existing data set in the corresponding field.

Method clone()

The objects of this class are cloneable with this method.

Usage

DataManagerClassifier$clone(deep = FALSE)

Arguments

Abstract class for small data sets containing text embeddings

Description

Object of class R6 which stores the text embeddings generated by an object of class TextEmbeddingModel. The text embeddings are stored within memory/RAM. In the case of a high number of documents the data may not fit into memory/RAM. Thus, please use this object only for a small sample of texts. In general, it is recommended to use an object of class LargeDataSetForTextEmbeddings which can deal with any number of texts.

Value

Returns an object of class EmbeddedText. These objects are used for storing and managing the text embeddings created with objects of class TextEmbeddingModel. Objects of class EmbeddedText serve as input for objects of class TEClassifierRegular, TEClassifierProtoNet, and TEFeatureExtractor. The main aim of this class is to provide a structured link between embedding models and classifiers. Since objects of this class save information on the text embedding model that created the text embedding it ensures that only embedding generated with same embedding model are combined. Furthermore, the stored information allows objects to check if embeddings of the correct text embedding model are used for training and predicting.

Public fields

Methods

Public methods

• EmbeddedText$configure()

• EmbeddedText$save()

• EmbeddedText$is_configured()

• EmbeddedText$load_from_disk()

• EmbeddedText$get_model_info()

• EmbeddedText$get_model_label()

• EmbeddedText$get_times()

• EmbeddedText$get_features()

• EmbeddedText$get_original_features()

• EmbeddedText$get_pad_value()

• EmbeddedText$is_compressed()

• EmbeddedText$add_feature_extractor_info()

• EmbeddedText$get_feature_extractor_info()

• EmbeddedText$convert_to_LargeDataSetForTextEmbeddings()

• EmbeddedText$n_rows()

• EmbeddedText$get_all_fields()

• EmbeddedText$set_package_versions()

• EmbeddedText$get_package_versions()

• EmbeddedText$clone()

Method configure()

Creates a new object representing text embeddings.

Usage

EmbeddedText$configure(
  model_name = NA,
  model_label = NA,
  model_date = NA,
  model_method = NA,
  model_version = NA,
  model_language = NA,
  param_seq_length = NA,
  param_chunks = NULL,
  param_features = NULL,
  param_overlap = NULL,
  param_emb_layer_min = NULL,
  param_emb_layer_max = NULL,
  param_emb_pool_type = NULL,
  param_aggregation = NULL,
  param_pad_value = -100,
  embeddings
)

Arguments

Returns

Returns an object of class EmbeddedText which stores the text embeddings produced by an objects of class TextEmbeddingModel.

Method save()

Saves a data set to disk.

Usage

EmbeddedText$save(dir_path, folder_name, create_dir = TRUE)

Arguments

Returns

Method does not return anything. It write the data set to disk.

Method is_configured()

Method for checking if the model was successfully configured. An object can only be used if this value is TRUE.

Usage

EmbeddedText$is_configured()

Returns

bool TRUE if the model is fully configured. FALSE if not.

Method load_from_disk()

loads an object of class EmbeddedText from disk and updates the object to the current version of the package.

Usage

EmbeddedText$load_from_disk(dir_path)

Arguments

Returns

Method does not return anything. It loads an object from disk.

Method get_model_info()

Method for retrieving information about the model that generated this embedding.

Usage

EmbeddedText$get_model_info()

Returns

list contains all saved information about the underlying text embedding model.

Method get_model_label()

Method for retrieving the label of the model that generated this embedding.

Usage

EmbeddedText$get_model_label()

Returns

string Label of the corresponding text embedding model

Method get_times()

Number of chunks/times of the text embeddings.

Usage

EmbeddedText$get_times()

Returns

Returns an int describing the number of chunks/times of the text embeddings.

Method get_features()

Number of actual features/dimensions of the text embeddings.In the case a feature extractor was used the number of features is smaller as the original number of features. To receive the original number of features (the number of features before applying a feature extractor) you can use the method get_original_features of this class.

Usage

EmbeddedText$get_features()

Returns

Returns an int describing the number of features/dimensions of the text embeddings.

Method get_original_features()

Number of original features/dimensions of the text embeddings.

Usage

EmbeddedText$get_original_features()

Returns

Returns an int describing the number of features/dimensions if no feature extractor) is used or before a feature extractor) is applied.

Method get_pad_value()

Value for indicating padding.

Usage

EmbeddedText$get_pad_value()

Returns

Returns an int describing the value used for padding.

Method is_compressed()

Checks if the text embedding were reduced by a feature extractor.

Usage

EmbeddedText$is_compressed()

Returns

Returns TRUE if the number of dimensions was reduced by a feature extractor. If not return FALSE.

Method add_feature_extractor_info()

Method setting information on the feature extractor that was used to reduce the number of dimensions of the text embeddings. This information should only be used if a feature extractor was applied.

Usage

EmbeddedText$add_feature_extractor_info(
  model_name,
  model_label = NA,
  features = NA,
  method = NA,
  noise_factor = NA,
  optimizer = NA
)

Arguments

Returns

Method does nothing return. It sets information on a feature extractor.

Method get_feature_extractor_info()

Method for receiving information on the feature extractor that was used to reduce the number of dimensions of the text embeddings.

Usage

EmbeddedText$get_feature_extractor_info()

Returns

Returns a list with information on the feature extractor. If no feature extractor was used it returns NULL.

Method convert_to_LargeDataSetForTextEmbeddings()

Method for converting this object to an object of class LargeDataSetForTextEmbeddings.

Usage

EmbeddedText$convert_to_LargeDataSetForTextEmbeddings()

Returns

Returns an object of class LargeDataSetForTextEmbeddings which uses memory mapping allowing to work with large data sets.

Method n_rows()

Number of rows.

Usage

EmbeddedText$n_rows()

Returns

Returns the number of rows of the text embeddings which represent the number of cases.

Method get_all_fields()

Return all fields.

Usage

EmbeddedText$get_all_fields()

Returns

Method returns a list containing all public and private fields of the object.

Method set_package_versions()

Method for setting the package version for 'aifeducation', 'reticulate', 'torch', and 'numpy' to the currently used versions.

Usage

EmbeddedText$set_package_versions()

Returns

Method does not return anything. It is used to set the private fields fo package versions.

Method get_package_versions()

Method for requesting a summary of the R and python packages' versions used for creating the model.

Usage

EmbeddedText$get_package_versions()

Returns

Returns a list containing the versions of the relevant R and python packages.

Method clone()

The objects of this class are cloneable with this method.

Usage

EmbeddedText$clone(deep = FALSE)

Arguments

See Also

Other Data Management: LargeDataSetForText, LargeDataSetForTextEmbeddings

Abstract base class for large data sets

Description

This object contains public and private methods which may be useful for every large data sets. Objects of this class are not intended to be used directly.

Value

Returns a new object of this class.

Methods

Public methods

• LargeDataSetBase$n_cols()

• LargeDataSetBase$n_rows()

• LargeDataSetBase$get_colnames()

• LargeDataSetBase$get_dataset()

• LargeDataSetBase$reduce_to_unique_ids()

• LargeDataSetBase$select()

• LargeDataSetBase$get_ids()

• LargeDataSetBase$save()

• LargeDataSetBase$load_from_disk()

• LargeDataSetBase$load()

• LargeDataSetBase$set_package_versions()

• LargeDataSetBase$get_package_versions()

• LargeDataSetBase$get_all_fields()

• LargeDataSetBase$clone()

Method n_cols()

Number of columns in the data set.

Usage

LargeDataSetBase$n_cols()

Returns

int describing the number of columns in the data set.

Method n_rows()

Number of rows in the data set.

Usage

LargeDataSetBase$n_rows()

Returns

int describing the number of rows in the data set.

Method get_colnames()

Get names of the columns in the data set.

Usage

LargeDataSetBase$get_colnames()

Returns

vector containing the names of the columns as strings.

Method get_dataset()

Get data set.

Usage

LargeDataSetBase$get_dataset()

Returns

Returns the data set of this object as an object of class datasets.arrow_dataset.Dataset.

Method reduce_to_unique_ids()

Reduces the data set to a data set containing only unique ids. In the case an id exists multiple times in the data set the first case remains in the data set. The other cases are dropped.

Attention Calling this method will change the data set in place.

Usage

LargeDataSetBase$reduce_to_unique_ids()

Returns

Method does not return anything. It changes the data set of this object in place.

Method select()

Returns a data set which contains only the cases belonging to the specific indices.

Usage

LargeDataSetBase$select(indicies)

Arguments

Returns

Returns a data set of class datasets.arrow_dataset.Dataset with the selected rows.

Method get_ids()

Get ids

Usage

LargeDataSetBase$get_ids()

Returns

Returns a vector containing the ids of every row as strings.

Method save()

Saves a data set to disk.

Usage

LargeDataSetBase$save(dir_path, folder_name, create_dir = TRUE)

Arguments

Returns

Method does not return anything. It write the data set to disk.

Method load_from_disk()

loads an object of class LargeDataSetBase from disk 'and updates the object to the current version of the package.

Usage

LargeDataSetBase$load_from_disk(dir_path)

Arguments

Returns

Method does not return anything. It loads an object from disk.

Method load()

Loads a data set from disk.

Usage

LargeDataSetBase$load(dir_path)

Arguments

Returns

Method does not return anything. It loads a data set from disk.

Method set_package_versions()

Method for setting the package version for 'aifeducation', 'reticulate', 'torch', and 'numpy' to the currently used versions.

Usage

LargeDataSetBase$set_package_versions()

Returns

Method does not return anything. It is used to set the private fields fo package versions.

Method get_package_versions()

Method for requesting a summary of the R and python packages' versions used for creating the model.

Usage

LargeDataSetBase$get_package_versions()

Returns

Returns a list containing the versions of the relevant R and python packages.

Method get_all_fields()

Return all fields.

Usage

LargeDataSetBase$get_all_fields()

Returns

Method returns a list containing all public and private fields of the object.

Method clone()

The objects of this class are cloneable with this method.

Usage

LargeDataSetBase$clone(deep = FALSE)

Arguments

See Also

Other R6 Classes for Developers: AIFEBaseModel, ClassifiersBasedOnTextEmbeddings, ModelsBasedOnTextEmbeddings, TEClassifiersBasedOnProtoNet, TEClassifiersBasedOnRegular

Abstract class for large data sets containing raw texts

Description

This object stores raw texts. The data of this objects is not stored in memory directly. By using memory mapping these objects allow to work with data sets which do not fit into memory/RAM.

Value

Returns a new object of this class.

Super class

aifeducation::LargeDataSetBase -> LargeDataSetForText

Methods

Public methods

• LargeDataSetForText$new()

• LargeDataSetForText$add_from_files_txt()

• LargeDataSetForText$add_from_files_pdf()

• LargeDataSetForText$add_from_files_xlsx()

• LargeDataSetForText$add_from_data.frame()

• LargeDataSetForText$get_private()

• LargeDataSetForText$clone()

Method new()

Method for creation of LargeDataSetForText instance. It can be initialized with init_data parameter if passed (Uses add_from_data.frame() method if init_data is data.frame).

Usage

LargeDataSetForText$new(init_data = NULL)

Arguments

Returns

A new instance of this class initialized with init_data if passed.

Method add_from_files_txt()

Method for adding raw texts saved within .txt files to the data set. Please note the the directory should contain one folder for each .txt file. In order to create an informative data set every folder can contain the following additional files:

• bib_entry.txt: containing a text version of the bibliographic information of the raw text.

• license.txt: containing a statement about the license to use the raw text such as "CC BY".

• url_license.txt: containing the url/link to the license in the internet.

• text_license.txt: containing the license in raw text.

• url_source.txt: containing the url/link to the source in the internet.

  The id of every .txt file is the file name without file extension. Please be aware to provide unique file names. Id and raw texts are mandatory, bibliographic and license information are optional.

Usage

LargeDataSetForText$add_from_files_txt(
  dir_path,
  batch_size = 500,
  log_file = NULL,
  log_write_interval = 2,
  log_top_value = 0,
  log_top_total = 1,
  log_top_message = NA,
  clean_text = TRUE,
  trace = TRUE
)

Arguments

Returns

The method does not return anything. It adds new raw texts to the data set.

Method add_from_files_pdf()

Method for adding raw texts saved within .pdf files to the data set. Please note the the directory should contain one folder for each .pdf file. In order to create an informative data set every folder can contain the following additional files:

• bib_entry.txt: containing a text version of the bibliographic information of the raw text.

• license.txt: containing a statement about the license to use the raw text such as "CC BY".

• url_license.txt: containing the url/link to the license in the internet.

• text_license.txt: containing the license in raw text.

• url_source.txt: containing the url/link to the source in the internet.

  The id of every .pdf file is the file name without file extension. Please be aware to provide unique file names. Id and raw texts are mandatory, bibliographic and license information are optional.

Usage

LargeDataSetForText$add_from_files_pdf(
  dir_path,
  batch_size = 500,
  log_file = NULL,
  log_write_interval = 2,
  log_top_value = 0,
  log_top_total = 1,
  log_top_message = NA,
  clean_text = TRUE,
  trace = TRUE
)

Arguments

Returns

The method does not return anything. It adds new raw texts to the data set.

Method add_from_files_xlsx()

Method for adding raw texts saved within .xlsx files to the data set. The method assumes that the texts are saved in the rows and that the columns store the id and the raw texts in the columns. In addition, a column for the bibliography information and the license can be added. The column names for these rows must be specified with the following arguments. They must be the same for all .xlsx files in the chosen directory. Id and raw texts are mandatory, bibliographic, license, license's url, license's text, and source's url are optional. Additional columns are dropped.

Usage

LargeDataSetForText$add_from_files_xlsx(
  dir_path,
  trace = TRUE,
  id_column = "id",
  text_column = "text",
  bib_entry_column = "bib_entry",
  license_column = "license",
  url_license_column = "url_license",
  text_license_column = "text_license",
  url_source_column = "url_source",
  log_file = NULL,
  log_write_interval = 2,
  log_top_value = 0,
  log_top_total = 1,
  log_top_message = NA
)

Arguments

Returns

The method does not return anything. It adds new raw texts to the data set.

Method add_from_data.frame()

Method for adding raw texts from a data.frame

Usage

LargeDataSetForText$add_from_data.frame(data_frame)

Arguments

Returns

The method does not return anything. It adds new raw texts to the data set.

Method get_private()

Method for requesting all private fields and methods. Used for loading and updating an object.

Usage

LargeDataSetForText$get_private()

Returns

Returns a list with all private fields and methods.

Method clone()

The objects of this class are cloneable with this method.

Usage

LargeDataSetForText$clone(deep = FALSE)

Arguments

See Also

Other Data Management: EmbeddedText, LargeDataSetForTextEmbeddings

Abstract class for large data sets containing text embeddings

Description

This object stores text embeddings which are usually produced by an object of class TextEmbeddingModel. The data of this objects is not stored in memory directly. By using memory mapping these objects allow to work with data sets which do not fit into memory/RAM.

LargeDataSetForTextEmbeddings are used for storing and managing the text embeddings created with objects of class TextEmbeddingModel. Objects of class LargeDataSetForTextEmbeddings serve as input for objects of class ClassifiersBasedOnTextEmbeddings and TEFeatureExtractor. The main aim of this class is to provide a structured link between embedding models and classifiers. Since objects of this class save information on the text embedding model that created the text embedding it ensures that only embeddings generated with same embedding model are combined. Furthermore, the stored information allows objects to check if embeddings of the correct text embedding model are used for training and predicting.

This class is not designed for a direct use.

Value

Returns a new object of this class.

Super class

aifeducation::LargeDataSetBase -> LargeDataSetForTextEmbeddings

Methods

Public methods

• LargeDataSetForTextEmbeddings$configure()

• LargeDataSetForTextEmbeddings$is_configured()

• LargeDataSetForTextEmbeddings$get_text_embedding_model_name()

• LargeDataSetForTextEmbeddings$get_model_info()

• LargeDataSetForTextEmbeddings$load_from_disk()

• LargeDataSetForTextEmbeddings$get_model_label()

• LargeDataSetForTextEmbeddings$add_feature_extractor_info()

• LargeDataSetForTextEmbeddings$get_feature_extractor_info()

• LargeDataSetForTextEmbeddings$is_compressed()

• LargeDataSetForTextEmbeddings$get_times()

• LargeDataSetForTextEmbeddings$get_features()

• LargeDataSetForTextEmbeddings$get_original_features()

• LargeDataSetForTextEmbeddings$get_pad_value()

• LargeDataSetForTextEmbeddings$add_embeddings_from_array()

• LargeDataSetForTextEmbeddings$add_embeddings_from_EmbeddedText()

• LargeDataSetForTextEmbeddings$add_embeddings_from_LargeDataSetForTextEmbeddings()

• LargeDataSetForTextEmbeddings$convert_to_EmbeddedText()

• LargeDataSetForTextEmbeddings$clone()

Method configure()

Creates a new object representing text embeddings.

Usage

LargeDataSetForTextEmbeddings$configure(
  model_name = NA,
  model_label = NA,
  model_date = NA,
  model_method = NA,
  model_version = NA,
  model_language = NA,
  param_seq_length = NA,
  param_chunks = NULL,
  param_features = NULL,
  param_overlap = NULL,
  param_emb_layer_min = NULL,
  param_emb_layer_max = NULL,
  param_emb_pool_type = NULL,
  param_pad_value = -100,
  param_aggregation = NULL
)

Arguments

Returns

The method returns a new object of this class.

Method is_configured()

Method for checking if the model was successfully configured. An object can only be used if this value is TRUE.

Usage

LargeDataSetForTextEmbeddings$is_configured()

Returns

bool TRUE if the model is fully configured. FALSE if not.

Method get_text_embedding_model_name()

Method for requesting the name (unique id) of the underlying text embedding model.

Usage

LargeDataSetForTextEmbeddings$get_text_embedding_model_name()

Returns

Returns a string describing name of the text embedding model.

Method get_model_info()

Method for retrieving information about the model that generated this embedding.

Usage

LargeDataSetForTextEmbeddings$get_model_info()

Returns

list containing all saved information about the underlying text embedding model.

Method load_from_disk()

loads an object of class LargeDataSetForTextEmbeddings from disk and updates the object to the current version of the package.

Usage

LargeDataSetForTextEmbeddings$load_from_disk(dir_path)

Arguments

Returns

Method does not return anything. It loads an object from disk.

Method get_model_label()

Method for retrieving the label of the model that generated this embedding.

Usage

LargeDataSetForTextEmbeddings$get_model_label()

Returns

string Label of the corresponding text embedding model

Method add_feature_extractor_info()

Method setting information on the TEFeatureExtractor that was used to reduce the number of dimensions of the text embeddings. This information should only be used if a TEFeatureExtractor was applied.

Usage

LargeDataSetForTextEmbeddings$add_feature_extractor_info(
  model_name,
  model_label = NA,
  features = NA,
  method = NA,
  noise_factor = NA,
  optimizer = NA
)

Arguments

Returns

Method does nothing return. It sets information on a TEFeatureExtractor.

Method get_feature_extractor_info()

Method for receiving information on the TEFeatureExtractor that was used to reduce the number of dimensions of the text embeddings.

Usage

LargeDataSetForTextEmbeddings$get_feature_extractor_info()

Returns

Returns a list with information on the TEFeatureExtractor. If no TEFeatureExtractor was used it returns NULL.

Method is_compressed()

Checks if the text embedding were reduced by a TEFeatureExtractor.

Usage

LargeDataSetForTextEmbeddings$is_compressed()

Returns

Returns TRUE if the number of dimensions was reduced by a TEFeatureExtractor. If not return FALSE.

Method get_times()

Number of chunks/times of the text embeddings.

Usage

LargeDataSetForTextEmbeddings$get_times()

Returns

Returns an int describing the number of chunks/times of the text embeddings.

Method get_features()

Number of actual features/dimensions of the text embeddings.In the case a TEFeatureExtractor was used the number of features is smaller as the original number of features. To receive the original number of features (the number of features before applying a TEFeatureExtractor) you can use the method get_original_features of this class.

Usage

LargeDataSetForTextEmbeddings$get_features()

Returns

Returns an int describing the number of features/dimensions of the text embeddings.

Method get_original_features()

Number of original features/dimensions of the text embeddings.

Usage

LargeDataSetForTextEmbeddings$get_original_features()

Returns

Returns an int describing the number of features/dimensions if no TEFeatureExtractor) is used or before a TEFeatureExtractor) is applied.

Method get_pad_value()

Value for indicating padding.

Usage

LargeDataSetForTextEmbeddings$get_pad_value()

Returns

Returns an int describing the value used for padding.

Method add_embeddings_from_array()

Method for adding new data to the data set from an array. Please note that the method does not check if cases already exist in the data set. To reduce the data set to unique cases call the method reduce_to_unique_ids.

Usage

LargeDataSetForTextEmbeddings$add_embeddings_from_array(embedding_array)

Arguments

Returns

The method does not return anything. It adds new data to the data set.

Method add_embeddings_from_EmbeddedText()

Method for adding new data to the data set from an EmbeddedText. Please note that the method does not check if cases already exist in the data set. To reduce the data set to unique cases call the method reduce_to_unique_ids.

Usage

LargeDataSetForTextEmbeddings$add_embeddings_from_EmbeddedText(EmbeddedText)

Arguments

Returns

The method does not return anything. It adds new data to the data set.

Method add_embeddings_from_LargeDataSetForTextEmbeddings()

Method for adding new data to the data set from an LargeDataSetForTextEmbeddings. Please note that the method does not check if cases already exist in the data set. To reduce the data set to unique cases call the method reduce_to_unique_ids.

Usage

LargeDataSetForTextEmbeddings$add_embeddings_from_LargeDataSetForTextEmbeddings(
  dataset
)

Arguments

Returns

The method does not return anything. It adds new data to the data set.

Method convert_to_EmbeddedText()

Method for converting this object to an object of class EmbeddedText.

Attention This object uses memory mapping to allow the usage of data sets that do not fit into memory. By calling this method the data set will be loaded and stored into memory/RAM. This may lead to an out-of-memory error.

Usage

LargeDataSetForTextEmbeddings$convert_to_EmbeddedText()

Returns

LargeDataSetForTextEmbeddings an object of class EmbeddedText which is stored in the memory/RAM.

Method clone()

The objects of this class are cloneable with this method.

Usage

LargeDataSetForTextEmbeddings$clone(deep = FALSE)

Arguments

See Also

Other Data Management: EmbeddedText, LargeDataSetForText

Server function for: graphical user interface for showing the license.

Description

Functions generates the functionality of a page on the server.

Usage

License_Server(id)

Arguments

Value

This function does nothing return. It is used to create the functionality of a page for a shiny app.

Base class for models using neural nets

Description

Abstract class for all models that do not rely on the python library 'transformers'. All models of this class require text embeddings as input. These are provided as objects of class EmbeddedText or LargeDataSetForTextEmbeddings.

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.

Value

A new object of this class.

Super class

aifeducation::AIFEBaseModel -> ModelsBasedOnTextEmbeddings

Methods

Public methods

• ModelsBasedOnTextEmbeddings$get_text_embedding_model()

• ModelsBasedOnTextEmbeddings$get_text_embedding_model_name()

• ModelsBasedOnTextEmbeddings$check_embedding_model()

• ModelsBasedOnTextEmbeddings$load_from_disk()

• ModelsBasedOnTextEmbeddings$plot_training_history()

• ModelsBasedOnTextEmbeddings$clone()

Method get_text_embedding_model()

Method for requesting the text embedding model information.

Usage

ModelsBasedOnTextEmbeddings$get_text_embedding_model()

Returns

list of all relevant model information on the text embedding model underlying the model.

Method get_text_embedding_model_name()

Method for requesting the name (unique id) of the underlying text embedding model.

Usage

ModelsBasedOnTextEmbeddings$get_text_embedding_model_name()

Returns

Returns a string describing name of the text embedding model.

Method check_embedding_model()

Method for checking if the provided text embeddings are created with the same TextEmbeddingModel as the model.

Usage

ModelsBasedOnTextEmbeddings$check_embedding_model(text_embeddings)

Arguments

Returns

TRUE if the underlying TextEmbeddingModel are the same. FALSE if the models differ.

Method load_from_disk()

loads an object from disk and updates the object to the current version of the package.

Usage

ModelsBasedOnTextEmbeddings$load_from_disk(dir_path)

Arguments

Returns

Method does not return anything. It loads an object from disk.

Method plot_training_history()

Method for requesting a plot of the training history. This method requires the R package 'ggplot2' to work.

Usage

ModelsBasedOnTextEmbeddings$plot_training_history(
  final_training = FALSE,
  pl_step = NULL,
  measure = "loss",
  y_min = NULL,
  y_max = NULL,
  add_min_max = TRUE,
  text_size = 10
)

Arguments

Returns

Returns a plot of class ggplot visualizing the training process. Prepare history data of objects Function for preparing the history data of a model in order to be plotted in AI for Education - Studio.

final bool If TRUE the history data of the final training is used for the data set. pl_step int If use_pl=TRUE select the step within pseudo labeling for which the data should be prepared. Returns a named list with the training history data of the model. The reported measures depend on the provided model.

Utils Studio Developers internal

Method clone()

The objects of this class are cloneable with this method.

Usage

ModelsBasedOnTextEmbeddings$clone(deep = FALSE)

Arguments

See Also

Other R6 Classes for Developers: AIFEBaseModel, ClassifiersBasedOnTextEmbeddings, LargeDataSetBase, TEClassifiersBasedOnProtoNet, TEClassifiersBasedOnRegular

Server function for: graphical user interface for displaying the reliability of classifiers.

Description

Functions generates the functionality of a page on the server.

Usage

Reliability_Server(id, model)

Arguments

Value

This function does nothing return. It is used to create the functionality of a page for a shiny app.

See Also

Other studio_gui_page_classifier_reliability: Reliability_UI()

Graphical user interface for displaying the reliability of classifiers.

Description

Functions generates the tab within a page for displaying infomration on the reliability of classifiers.

Usage

Reliability_UI(id)

Arguments

Value

This function does nothing return. It is used to build a page for a shiny app.

See Also

Other studio_gui_page_classifier_reliability: Reliability_Server()

Text embedding classifier with a neural net

Description

Classification Type

This is a probability classifier that predicts a probability distribution for different classes/categories. This is the standard case most common in literature.

Parallel Core Architecture

This model is based on a parallel architecture. An input is passed to different types of layers separately. At the end the outputs are combined to create the final output of the whole model.

Transformer Encoder Layers

Description

The transformer encoder layers follow the structure of the encoder layers used in transformer models. A single layer is designed as described by Chollet, Kalinowski, and Allaire (2022, p. 373) with the exception that single components of the layers (such as the activation function, the kind of residual connection, the kind of normalization or the kind of attention) can be customized. All parameters with the prefix tf_ can be used to configure this layer.

Feature Layer

Description

The feature layer is a dense layer that can be used to increase or decrease the number of features of the input data before passing the data into your model. The aim of this layer is to increase or reduce the complexity of the data for your model. The output size of this layer determines the number of features for all following layers. In the special case that the requested number of features equals the number of features of the text embeddings this layer is reduced to a dropout layer with masking capabilities. All parameters with the prefix feat_ can be used to configure this layer.

Dense Layers

Description

A fully connected layer. The layer is applied to every step of a sequence. All parameters with the prefix dense_ can be used to configure this layer.

Multiple N-Gram Layers

Description

This type of layer focuses on sub-sequence and performs an 1d convolutional operation. On a word and token level these sub-sequences can be interpreted as n-grams (Jacovi, Shalom & Goldberg 2018). The convolution is done across all features. The number of filters equals the number of features of the input tensor. Thus, the shape of the tensor is retained (Pham, Kruszewski & Boleda 2016).

The layer is able to consider multiple n-grams at the same time. In this case the convolution of the n-grams is done seprately and the resulting tensors are concatenated along the feature dimension. The number of filters for every n-gram is set to num_features/num_n-grams. Thus, the resulting tensor has the same shape as the input tensor.

Sub-sequences that are masked in the input are also masked in the output.

The output of this layer can be understand as the results of the n-gram filters. Stacking this layer allows the model to perform n-gram detection of n-grams (meta perspective). All parameters with the prefix ng_conv_ can be used to configure this layer.

Recurrent Layers

Description

A regular recurrent layer either as Gated Recurrent Unit (GRU) or Long Short-Term Memory (LSTM) layer. Uses PyTorchs implementation. All parameters with the prefix rec_ can be used to configure this layer.

Merge Layer

Description

Layer for combining the output of different layers. All inputs must be sequential data of shape (Batch, Times, Features). First, pooling over time is applied extracting the minimal and/or maximal features. Second, the pooled tensors are combined by calculating their weighted sum. Different attention mechanism can be used to dynamically calculate the corresponding weights. This allows the model to decide which part of the data is most usefull. Finally, pooling over features is applied extracting a specific number of maximal and/or minimal features. A normalization of all input at the begining of the layer is possible. All parameters with the prefix merge_ can be used to configure this layer.

Training and Prediction

For the creation and training of a classifier an object of class EmbeddedText or LargeDataSetForTextEmbeddings on the one hand and a factor on the other hand are necessary.

The object of class EmbeddedText or LargeDataSetForTextEmbeddings contains the numerical text representations (text embeddings) of the raw texts generated by an object of class TextEmbeddingModel. For supporting large data sets it is recommended to use LargeDataSetForTextEmbeddings instead of EmbeddedText.

The factor contains the classes/categories for every text. Missing values (unlabeled cases) are supported and can be used for pseudo labeling.

For predictions an object of class EmbeddedText or LargeDataSetForTextEmbeddings has to be used which was created with the same TextEmbeddingModel as for training.

Value

Returns a new object of this class ready for configuration or for loading a saved classifier.

Super classes

aifeducation::AIFEBaseModel -> aifeducation::ModelsBasedOnTextEmbeddings -> aifeducation::ClassifiersBasedOnTextEmbeddings -> aifeducation::TEClassifiersBasedOnRegular -> TEClassifierParallel

Methods

Public methods

• TEClassifierParallel$configure()

• TEClassifierParallel$clone()