save_ai_model

Function for saving models created with 'aifeducation'.

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 'keras',
'tensorflow', and '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. Lee (2013)
<https://www.researchgate.net/publication/280581078_Pseudo-Label_The_Simple_and_Efficient_Semi-Supervised_Learning_Method_for_Deep_Neural_Networks>,
Cascante-Bonilla et al. (2020) <doi:10.48550/arXiv.2001.06001>) and
imbalanced data via the creation of synthetic cases (e.g.
Bunkhumpornpat et al. (2012) <doi:10.1007/s10489-011-0287-y>).
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.

Berding Florian

aifeducation

Artificial Intelligence for Education

Pargmann Julia

Riebenbauer Elisabeth

Rebmann Karin

Slopinski Andreas

save_ai_model function

<dl><dt>model</dt>
<dd>Object of class TextEmbeddingClassifierNeuralNet or
TextEmbeddingModel which should be saved.</dd>
<dt>model_dir</dt>
<dd>Path to the directory where the should model is stored.</dd>
<dt>dir_name</dt>
<dd>Name of the folder that will be created at <code>model_dir</code>.
If<code>dir_name=NULL</code> the model's name will be used. If additionally <code>append_ID=TRUE</code>
the models's name and ID will be used for generating a name for that directory.</dd>
<dt>save_format</dt>
<dd>Only relevant for TextEmbeddingClassifierNeuralNet.
Format for saving the model. For 'tensorflow'/'keras' models
<code>"keras"</code> for 'Keras v3 format',
<code>"tf"</code> for SavedModel
or <code>"h5"</code> for HDF5.
For 'pytorch' models <code>"safetensors"</code> for 'safetensors' or
<code>"pt"</code> for 'pytorch via pickle'.
Use <code>"default"</code> for the standard format. This is keras for
'tensorflow'/'keras' models and safetensors for 'pytorch' models.</dd>
<dt>append_ID</dt>
<dd><code>bool</code> <code>TRUE</code> if the ID should be appended to
the model directory for saving purposes. <code>FALSE</code> if not.</dd></dl>

Arguments

Saving models created with 'aifeducation' — save_ai_model

<dl>

<dt>model</dt>
<dd>Object of class TextEmbeddingClassifierNeuralNet or
TextEmbeddingModel which should be saved.</dd>


<dt>model_dir</dt>
<dd>Path to the directory where the should model is stored.</dd>


<dt>dir_name</dt>
<dd>Name of the folder that will be created at <code>model_dir</code>.
If<code>dir_name=NULL</code> the model's name will be used. If additionally <code>append_ID=TRUE</code>
the models's name and ID will be used for generating a name for that directory.</dd>


<dt>save_format</dt>
<dd>Only relevant for TextEmbeddingClassifierNeuralNet.
Format for saving the model. For 'tensorflow'/'keras' models
<code>"keras"</code> for 'Keras v3 format',
<code>"tf"</code> for SavedModel
or <code>"h5"</code> for HDF5.
For 'pytorch' models <code>"safetensors"</code> for 'safetensors' or
<code>"pt"</code> for 'pytorch via pickle'.
Use <code>"default"</code> for the standard format. This is keras for
'tensorflow'/'keras' models and safetensors for 'pytorch' models.</dd>


<dt>append_ID</dt>
<dd><code>bool</code> <code>TRUE</code> if the ID should be appended to
the model directory for saving purposes. <code>FALSE</code> if not.</dd>

</dl>

save_ai_model: Saving models created with 'aifeducation'

Description

Usage

Value

Arguments

See Also