Package: aifeducation 1.1.5

Berding Florian

aifeducation: Artificial Intelligence for Education

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.

Authors:Berding Florian [aut, cre], Tykhonova Yuliia [aut], Pargmann Julia [ctb], Leube Anna [ctb], Riebenbauer Elisabeth [ctb], Rebmann Karin [ctb], Slopinski Andreas [ctb]

aifeducation_1.1.5.tar.gz
aifeducation_1.1.5.tar.gz(r-4.7-arm64)aifeducation_1.1.5.tar.gz(r-4.7-x86_64)aifeducation_1.1.5.tar.gz(r-4.6-arm64)aifeducation_1.1.5.tar.gz(r-4.6-x86_64)
aifeducation_1.1.5.tgz(r-4.6-emscripten)
manual.pdf |manual.html
card.svg |card.png
aifeducation/json (API)
NEWS

# Install 'aifeducation' in R:
install.packages('aifeducation', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/fberding/aifeducation/issues

Pkgdown/docs site:https://fberding.github.io

Uses libs:
  • openblas– Optimized BLAS
  • c++– GNU Standard C++ Library v3
  • openmp– GCC OpenMP (GOMP) support library

On CRAN:

Conda:

openblascppopenmp

3.51 score 13 scripts 639 downloads 114 exports 50 dependencies

Last updated from:8b507b00f2. Checks:6 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-devel-arm64OK208
linux-devel-x86_64OK159
source / vignettesOK283
linux-release-arm64OK200
linux-release-x86_64OK236
wasm-releaseOK169

Exports:add_missing_argsAIFEBaseModelAIFEMasterauto_n_coresBaseModelBertBaseModelCoreBaseModelDebertaV2BaseModelFunnelBaseModelModernBertBaseModelMPNetBaseModelRobertaBaseModelsIndexbuild_documentation_for_modelbuild_layer_stack_documentation_for_vignettecalc_standard_classification_measurescalc_tokenizer_statisticscat_messagecheck_aif_py_modulescheck_all_argscheck_class_and_typeclass_vector_to_py_datasetClassifiersBasedOnTextEmbeddingsclean_pytorch_log_transformerscohens_kappacreate_dircreate_objectcreate_synthetic_units_from_matrixdata.frame_to_py_datasetDataManagerClassifierDataSetsIndexEmbeddedTextextract_column_from_py_datasetfleiss_kappagenerate_args_for_testsgenerate_embeddingsgenerate_idgenerate_tensorsget_alpha_3_codesget_batches_indexget_called_argsget_coder_metricsget_current_args_for_printget_depr_obj_namesget_desc_for_core_model_architectureget_file_extensionget_fixed_test_tensorget_layer_documentationget_n_chunksget_param_defget_param_dictget_param_doc_descget_parameter_documentationget_py_package_versionget_py_package_versionsget_recommended_py_versionsget_synthetic_cases_from_matrixget_TEClassifiers_class_namesget_test_data_for_classifiersget_time_stampgwet_acHuggingFaceTokenizerinspect_tmp_dirinstall_aifeducationinstall_aifeducation_studioinstall_py_moduleskendalls_wknnorknnor_is_same_classkripp_alphaLargeDataSetBaseLargeDataSetForTextLargeDataSetForTextEmbeddingsload_all_py_scriptsload_from_diskload_py_scriptslong_load_target_datamatrix_to_array_cModelsBasedOnTextEmbeddingsmonitor_test_time_on_CIoutput_messageprepare_r_array_for_datasetprepare_sessionprint_messagepy_dataset_to_embeddingsrandom_bool_on_CIread_logread_loss_logreduce_to_uniquereset_logreset_loss_logrun_py_filesave_to_diskset_transformers_loggerstart_aifeducation_studiosummarize_args_for_long_taskTEClassifierParallelTEClassifierParallelPrototypeTEClassifierProtoNetTEClassifierRegularTEClassifiersBasedOnProtoNetTEClassifiersBasedOnRegularTEClassifierSequentialTEClassifierSequentialPrototypeTEFeatureExtractortensor_list_to_numpytensor_to_matrix_ctensor_to_numpyTextEmbeddingModelto_categorical_cTokenizerBaseTokenizerIndexupdate_aifeducationWordPieceTokenizerwrite_log

Dependencies:clicodetoolscpp11doParalleldplyrfarverforeachgenericsggalluvialggplot2gluegridExtragtablehereiotarelrisobanditeratorsjsonlitelabelinglatticelazyevallifecyclemagrittrMatrixpillarpkgconfigplyrpngpurrrR6rappdirsRColorBrewerRcppRcppArmadilloRcppTOMLreshape2reticulaterlangrprojrootS7scalesstringistringrtibbletidyrtidyselectutf8vctrsviridisLitewithr

01 Get started

Rendered fromaifeducation.Rmdusingknitr::rmarkdownon May 26 2026.

Last update: 2025-11-19
Started: 2023-08-15

Readme and manuals

Help Manual

Help pageTopics
Add missing arguments to a list of argumentsadd_missing_args
Base class for objects using a pytorch model as core model.AIFEBaseModel
Base class for most objectsAIFEMaster
Number of cores for multiple tasksauto_n_cores
BERT-TransformerBaseModelBert
Abstract class for all BaseModelsBaseModelCore
DeBERTa V2BaseModelDebertaV2
Funnel transformerBaseModelFunnel
ModernBertBaseModelModernBert
MPNetBaseModelMPNet
RoBERTaBaseModelRoberta
List of all available BaseModelsBaseModelsIndex
Generate documentation for a classifier classbuild_documentation_for_model
Generate documentation of all layers for an vignette or articlebuild_layer_stack_documentation_for_vignette
Calculate recall, precision, and f1-scorescalc_standard_classification_measures
Estimate tokenizer statisticscalc_tokenizer_statistics
Print message ('cat()')cat_message
Set sample size for argument combinationscheck_adjust_n_samples_on_CI
Check if all necessary python modules are availablecheck_aif_py_modules
Check arguments automaticallycheck_all_args
Check class and typecheck_class_and_type
Convert class vector to arrow data setclass_vector_to_py_dataset
Abstract class for all classifiers that use numerical representations of texts instead of words.ClassifiersBasedOnTextEmbeddings
Clean pytorch log of transformersclean_pytorch_log_transformers
Calculate Cohen's Kappacohens_kappa
Create directory if not existscreate_dir
Create object#'create_object
File path for caching data setscreate_py_dataset_cache_file_path
Create synthetic unitscreate_synthetic_units_from_matrix
Convert data.frame to arrow data setdata.frame_to_py_dataset
Data manager for classification tasksDataManagerClassifier
List of all available types of data setsDataSetsIndex
Abstract class for small data sets containing text embeddingsEmbeddedText
Extract columnextract_column_from_py_dataset
Calculate Fleiss' Kappafleiss_kappa
Generate combinations of argumentsgenerate_args_for_tests
Generate test embeddingsgenerate_embeddings
Generate ID suffix for objectsgenerate_id
Generate test tensorsgenerate_tensors
Country Alpha 3 Codesget_alpha_3_codes
Assign cases to batchesget_batches_index
Called argumentsget_called_args
Calculate reliability measures based on content analysisget_coder_metrics
Print argumentsget_current_args_for_print
Get names of deprecated objectsget_depr_obj_names
Generate documentation for core modelsget_desc_for_core_model_architecture
Get file extensionget_file_extension
Generate static test tensorget_fixed_test_tensor
Generate layer documentationget_layer_documentation
Magnitudes of an argumentget_magnitude_values
Get the number of chunks/sequences for each caseget_n_chunks
Definition of an argumentget_param_def
Get dictionary of all parametersget_param_dict
Description of an argumentget_param_doc_desc
Generate layer documentationget_parameter_documentation
Get versions of a specific python packageget_py_package_version
Get versions of python componentsget_py_package_versions
Recommended version of python packagesget_recommended_py_versions
Create synthetic cases for balancing training dataget_synthetic_cases_from_matrix
Get names of classifiersget_TEClassifiers_class_names
Get test dataget_test_data_for_classifiers
Time stampget_time_stamp
Calculate Gwet's AC1 and AC2gwet_ac
HuggingFaceTokenizerHuggingFaceTokenizer
Inspect Temporary directoryinspect_tmp_dir
Install aifeducation on a machineinstall_aifeducation
Install 'AI for Education - Studio' on a machineinstall_aifeducation_studio
Installing necessary python modules to an environmentinstall_py_modules
Calculate Kendall's coefficient of concordance wkendalls_w
K-Nearest Neighbor OveRsampling approach (KNNOR)knnor
Validate a new pointknnor_is_same_class
Calculate Krippendorff's Alphakripp_alpha
Abstract base class for large data setsLargeDataSetBase
Abstract class for large data sets containing raw textsLargeDataSetForText
Abstract class for large data sets containing text embeddingsLargeDataSetForTextEmbeddings
Load and re-load all python scriptsload_all_py_scripts
Loading objects created with 'aifeducation'load_from_disk
Load and re-load python scriptsload_py_scripts
Load target data for long running taskslong_load_target_data
Reshape matrix to arraymatrix_to_array_c
Base class for models using neural netsModelsBasedOnTextEmbeddings
Print duration of a test on CImonitor_test_time_on_CI
Print messageoutput_message
Convert R array for arrow data setprepare_r_array_for_dataset
Function for setting up a python environment within R.prepare_session
Print message ('message()')print_message
Convert arrow data set to an arrow data setpy_dataset_to_embeddings
Random bool on Continuous Integrationrandom_bool_on_CI
Function for reading a log file in Rread_log
Function for reading a log file containing a record of the loss during training.read_loss_log
Reduce to unique casesreduce_to_unique
Function that resets a log file.reset_log
Reset log for loss informationreset_loss_log
Run python filerun_py_file
Saving objects created with 'aifeducation'save_to_disk
Sets the level for logging information of the 'transformers' libraryset_transformers_logger
Aifeducation Studiostart_aifeducation_studio
Summarize arguments from shiny inputsummarize_args_for_long_task
Text embedding classifier with a neural netTEClassifierParallel
Text embedding classifier with a ProtoNetTEClassifierParallelPrototype
Text embedding classifier with a ProtoNetTEClassifierProtoNet
Text embedding classifier with a neural netTEClassifierRegular
Base class for classifiers relying on numerical representations of texts instead of words that use the architecture of Protonets and its corresponding training techniques.TEClassifiersBasedOnProtoNet
Base class for regular classifiers relying on EmbeddedText or LargeDataSetForTextEmbeddings as inputTEClassifiersBasedOnRegular
Text embedding classifier with a neural netTEClassifierSequential
Text embedding classifier with a ProtoNetTEClassifierSequentialPrototype
Feature extractor for reducing the number for dimensions of text embeddings.TEFeatureExtractor
Convert list of tensors into numpy arraystensor_list_to_numpy
Transform tensor to matrixtensor_to_matrix_c
Tensor_to_numpytensor_to_numpy
Text embedding modelTextEmbeddingModel
Transforming classes to one-hot encodingto_categorical_c
Base class for tokenizersTokenizerBase
List of all available TokenizersTokenizerIndex
Updates an existing installation of 'aifeducation' on a machineupdate_aifeducation
WordPieceTokenizerWordPieceTokenizer
Write logwrite_log