Quick Start

Here is a quick-start example for using EduStudio. EduStudio supports 3 ways to run model, i.e.,create a python file to run, run with command and run with config file run.

Create a python file to run

create a python file (e.g., run.py) anywhere, the content is as follows:

from edustudio.quickstart import run_edustudio

run_edustudio(
    dataset='ASSIST_0910',
    cfg_file_name=None,
    traintpl_cfg_dict={
        'cls': 'GeneralTrainTPL',
    },
    datatpl_cfg_dict={
        'cls': 'CDInterExtendsQDataTPL'
    },
    modeltpl_cfg_dict={
        'cls': 'KaNCD',
    },
    evaltpl_cfg_dict={
        'clses': ['PredictionEvalTPL', 'InterpretabilityEvalTPL'],
    }
)

To find out which templates are used for a model, we can find in the Reference Table

Then run the following command:

python run.py

Run with command

You can run the following command with parameters based on created file above.

cd examples
python run.py -dt ASSIST_0910 --modeltpl_cfg.cls NCDM --traintpl_cfg.batch_size 512

Run with config file

create a yaml file conf/ASSIST_0910/NCDM.yaml:

datatpl_cfg:
  cls: CDInterDataTPL

traintpl_cfg:
  cls: GeneralTrainTPL
  batch_size: 512

modeltpl_cfg:
  cls: NCDM

evaltpl_cfg:
  clses: [PredictionEvalTPL, InterpretabilityEvalTPL]

then, run command:

cd examples
python run.py -f NCDM.yaml -dt ASSIST_0910