Automatické vyhodnocování odpovědních dotazníkových formulářů - The Garbage Collectors

ai directory

codeowners: Dominik Zappe, Vladimíra Kimlová

How to run:

Prerekvizity

• Python verze 3+ (testováno na nejméně Python 3.7)
• Manažer python balíčků pip (většinou je nainstalován spolu s Pythonem)

Jednoduchá verze

• Ve složce /ai/ je připraven skript run.sh (pro Linux) nebo run.bat (pro Windows)
• Tento skript automaticky zakládá virtuální prostředí, instaluje potřebné závislosti a spouští aplikaci
• Příkaz: ./run.sh nebo run.bat

Složitější DYI verze

Příprava

Vytvoření virtuálního prostředí

• Nejprve je nutné si prostředí vůbec vytvořit
• Příkaz: python -m venv cesta/k/novemu/virtualnimu/prostredi
• Následně je nutné si ho aktivovat
• Příkaz: cesta/k/novemu/virtualnimu/prostredi/Scripts/activate

Instalace závislostí

• Ve složce ai/ je připraven soubor requirements.txt
• Příkaz: pip install -r requirements.txt

Spuštění

• Aplikace se spouští pomocí spuštění API, které naslouchá na daném portu (momentálně 5000)
• Příkaz: python src/api_gateway.py

Basic usage:

• Existuje konfigurační soubor /ai/config.json, ve kterém je možné nastavit např. barvy a texty, které se budou generovat do výsledných .pdf. Dále je v tomto konfiguračním souboru možné nastavit Google Classroom multiplikátor záporných bodů za špatnou odpověď (default: 0.25).

Vygenerování .pdf souborů na základě Moodle dat

• API na adrese http://localhost:8081/get_print_data čeká na .json soubor v podobě pole objektů, kde jednotlivé objekty jsou jednotlivé otázky v předem daném formátu (podle Moodle)
• Vrací .zip soubor se dvěma .pdf soubory - jedná se o mergnuté .pdf soubory jednotlivých otázkových souborů (resp. záznamových archů)
• Adresa: /get_print_data
• Metoda: POST
• Vstup: .json (export Moodle)
• Výstup: .zip (mergnuté .pdf)

Vygenerování .pdf souborů na základě Google Classroom dat

• API na adrese http://localhost:8081/generate-gf-data čeká na .json soubor v podobě pole objektů, kde jednotlivé objekty jsou jednotlivé otázky v předem daném formátu (podle Google Classroom)
• Prakticky se interně převádí na formát, který je následně zpracován stejně jako Moodle data
• Vrací .zip soubor se dvěma .pdf soubory - jedná se o mergnuté .pdf soubory jednotlivých otázkových souborů (resp. záznamových archů)
• Adresa: /generate-gf-data
• Metoda: POST
• Vstup: .json (export Google Classroom)
• Výstup: .zip (mergnuté .pdf)

Vyhodnocení naskenovaného .pdf testu

• API na adrese http://localhost:8081/test_evaluation čeká na .pdf soubor, který je následně zpracován a vyhodnocen jako naskenovaný vyplněný test
• Vrací .json odpověď (momentálně v podobě slovníku, kde na klíči "student_id" je ID daného studenta a na klíči "answers" je seřazené pole (dle původního .pdf souboru), kde ke každé otázce je vráceno pole odpovědí 1/0 (zaškrtnuto / nezaškrtnuto)
• Adresa: /test_evaluation
• Metoda: POST
• Vstup: .pdf (naskenovaný test)
• Výstup: .json (vyhodnocení)

web directory

codeowners: Miroslav Vdoviak, David Šavel, Jakub Šlechta

How to run

Prerekvizity

Node verze 18.18.0 nebo Node libovolné verze a NVM (node package manager)

Příprava

• Přechod do složky web
• Pokud je nainstalován NVM použijeme příkaz nvm use. Pokud daná verze neexistuje, použijeme příkaz nvm install <version> a po jejím nainstalování nvm use.
• nainstalování závislostí příkazem npm install

Spuštění

• dev pomocí příkazu npm run start:dev
• production pomocí příkazu npm run start:dev

Dobré nainstalovat

Visual studio code

Aplikace obsahuje konfigurace pro doplňky eslint a prettier. Je vhodné si do vscode tyto doplňky nainstalovat.

cicd

codeowners: Jakub Šlechta

Build docker images

Build se provávdí skrze skript build-publish-docker.sh, pro nápovědu spusťte ./scripts/build-publish-docker.sh --help:

Usage: ./scripts/build-publish-docker.sh [OPTIONS]
Options:
        --product, -p <product>         Select specific product to work with (web, ai or doc)
        --build-only, -b                Perform build only and do not publish the image
        --arch, -a <arch>               Select architecture to build for (amd64, arm64), defaults to amd64

Například, pokud cheme udělat build a publish pro všechny části projektu (web, ai, dokumentace) a architekturu amd64, tak pouze spustíme:

./scripts/build-publish-docker.sh

Pokud budeme chtít například udělat nový build (bez publishe) ai části pro architekturu arm64, spustíme:

./scripts/build-publish-docker.sh -b --arch arm64 --product ai

Před publishováním

Ve skriptu build-publish-docker.sh najdete dvě proměnné, které je třeba upravit:

REGISTRY_USER - uživatel, pod kterým se budeme přihlašovat
REGISTRY - registry, kam budeme ukládat buildnuté images

Dále je nuté přidat do vašeho enviromentu proměnnou ASWI_GITLAB_TOKEN (klidně můžete přejmenovat ;)), která bude obsahovat access token k registry do kterého budete ukládat buildnuté images.

Pozn.: pokud skript používate v CI workflows, přidejte token do envu v projektu, CICD pipelina je tam už připravená.