Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 4.81 KB

README.md

File metadata and controls

75 lines (45 loc) · 4.81 KB
Raw

Ahk CLI

Build

Ahk CLI is a .NET Core console application that executes evaluation on student homework assignments by running a containerized evaluation logic.

Please refer to https://akosdudas.github.io/automated-homework-evaluation/ for the "big picture" of automation of homework evaluation.

Example

Suppose you have homework submissions in a folder, one subfolder or zip file for each student. And you have a Docker container to evaluate a homework. The you can use this tool as follows:

Example evaluation process

The process will give you an Excel file with the results:

Example output

Evaluation method

The process of evaluation consist of two steps:

  1. Run an evaluation logic that assesses the student's work
  2. Process the outcome of the previous step and grade the work

The evaluation and grading mode is selected via the command line arguments: dotnet ahk.dll eval [evaluation mode] [grading mode] [options].

Evaluation modes

There is currently one mode supported: docker. A container is spawned for each student submission.

Grading modes

Grading takes an output from the evaluation step, collects the results and assigns a grade/points to the submission. This mode determines how the evaluation application needs to communicate the results. There are two modes of grading a submission: trx and consolemessage. You can refer to the two samples in folder sample-evaluator.

Usage

The application uses .NET Core 3.1. There are no binaries distributed; you need to build the application from source:

dotnet build -c Release
dotnet publish -c Release -o ./bin --no-build

To check the usage of the application run dotnet ahk.dll --help.

Arguments of eval

Global options

  • -s|--submissions: A directory containing the submissions to evaluate. The current directory if not specified.
  • -o|--output: A directory to use as output; the results of the evaluation are placed here. A new directory in the current directory if not specified.
  • -d|--studentid: A file name expected in the root of every submission folder/zip containing the identifier of the student. If value is an empty string, the application uses the name of the folder/file as student identifier. Default value is: neptun.txt.

Docker-based evalation: eval docker

These are the options of the Docker container used to execute the assessment. A new one is spawned for each submission with the specified options.

  • --image: The name of the Docker image to execute.
  • --container-env: Environment variables to pass to the container. Specify the argument multiple times to add multiple variables. E.g.: --container-env PARAM1=VALUE1 --container-env PARAM2=VAL2
  • --container-arg: Optional parameters for container creation, e.g., memory amount. Each item is a key-value pair in the form of key=value. The key is a parameter of Docker Engine API CreateContainer operations. (Supports only string and number values.) E.g.: --container-arg memory=268435456 --container-arg hostname=app
  • --mount-path: The path within the container to mount the submission folder to. The container should process the submission from this folder. Default value: /submission.
  • --artifact-path: The path within the container to fetch artifacts from (e.g., output files, generated content, etc.); defaults to none (nothing is fetched).
  • --timeout: Maximum time frame for a container to finish evaluation; the container is terminated if exceeded. Default: 00:03:00.

A service container can provide an additional service, like a database, needed by the software being evaluated. The service container is started along with the evaluator container and the two are linked with a Docker network.

  • --service-container: The name of the Docker image to run as a service container linked to the main container.
  • --service-container-name: Name to set for the service container. The main container can use this name as DNS to communicate with the service container.
  • --service-container-env: Key-value pairs to pass to the service container as environment variables similarly to how the main container expects them.

Grading options

  • [eval docker trx] --trxfile: Enables the TRX grading mechanism and specifies the name of the TRX file to parse for results. Expected in the output folder of the container (--artifact-path).
  • [eval docker consolemessage] --validationcode: Enables the ConsoleMessage grading mechanism and specifies the validation code expected in every message printed to console by the evaluation application.