{% extends 'base.html' %} {% block title %}Documentation - AutograderGen{% endblock %} {% block content %}

Configuration Schema Explorer

Pydantic v2 Schema

AutograderGen validates your autograder_gen.yaml against a strict structure defined by AutograderConfigModel. Use this explorer to understand all properties, nested components, and validation rules.

Root Configuration (AutograderConfigModel)

The top-level object containing global setup parameters and the test suite questions list.

Field Type Requirement Description & Constraints
version string Required Schema version identifier. Example: "1.0".
language string Required Programming language to evaluate. Allowed values: python, java.
global_time_limit integer Default: 300 Global maximum test execution time limit (in milliseconds). Minimum: 1.
setup_commands array of strings Default: [] Commands executed inside the sandbox during setup (e.g., installing package dependencies).
files_necessary array of strings Required List of files required to be submitted by the student. Validated on submission.
questions array of QuestionModel Required List of assignment questions. Minimum items: 1.

Question Specification (QuestionModel)

Defines an individual graded question consisting of a name, description, and list of sub-tests.

Field Type Requirement Description & Constraints
name string Required Title of the question displayed on GradeScope.
description string Default: "" Question details, instructions, or examples. Supports markdown formatting.
marking_items array of MarkingItemModel Required List of testing check items linked to this question. Minimum items: 1.

Marking Item Check (MarkingItemModel)

Specifies a single automated verification check (test case or signature constraint) on student submissions.

Field Type Requirement Description & Constraints
target_file string Required The file to check. Must be listed under global files_necessary.
total_mark integer Required The mark/score value awarded if this check passes.
type string Required Type of automated check. Enum: file_exists, output_comparison, signature_check, function_test.
time_limit integer Default: 30 Individual execution timeout limit in seconds.
visibility string Default: "visible" Score visibility control. Enum: visible, hidden, after_due_date, after_published.
name string Default: "" Descriptive check name. If omitted, default type templates are used.
expected_input string Default: "" Required input fed to stdout in output_comparison checks.
expected_output string Default: "" Required stdout generated in output_comparison checks.
function_name string Optional Name of the function to test. Required if type is function_test or signature_check.
expected_parameters string Optional Parameters signature string expected in signature_check (e.g. "a, b").
expected_return_type string Optional Return type expected in signature_check (e.g. "int").
test_cases array of objects Default: [] Function arguments and expected values for function_test. Each test case consists of args list and expected output string. 

{{ schema }}
{% endblock %}