Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 3.15 KB

README.md

File metadata and controls

65 lines (41 loc) · 3.15 KB
Raw

Broadway

Build Status Coverage Status License Python Versions

The Broadway is a distributed grading service that receives, executes, and keeps track of grading jobs and runs.

The aim of this project is to provide a generic interface to a distributed autograding system that can be used by multiple courses. Broadway aims to provide the following benefits:

  • More stable and reliable grading runs. No one student can break the entire AG run.
  • Faster grading runs. Multiple machines can grade the same assignment.
  • Easier tracking and debugging of student failures during grading.
  • A more consistent environment to grade student code.
  • Easier to scale out the infrastructure.

Please read the Wiki for documentation. It explains how Broadway works and how to interact with it. Please be sure to read all the pages if you are planning on using Broadway.

See our contribution guidelines if you want to contribute.

Requirements

MongoDB must be installed and the mongod daemon must be running locally before starting the API. Default options are usually sufficient (but for security purposes, be sure to disallow external access to the store).

Python 3.6 is the minimum supported interpreter version. Python 3.7 should also work just fine.

To install the dependencies (with venv)

python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt

Configuration

Most of our configuration variables can be set from three sources: command-line flags, environment variables, config file, in the order of decreasing precedence.

Broadway API and grader

API and grader are two major parts of a broadway cluster. API is in charge of receiving and scheduling jobs across graders, while graders have the simple job of executing them in containers.

To bring up a functioning broadway cluster, you have spin up API first, then connect grader to the API using the authentication token (either given or automatically generated).

Running the API

(After installing requirements)

python3 -m broadway.api [--token TOKEN] [--bind-addr ADDR] [--bind-port PORT]

More info can be found by running python3 -m broadway.api --help

Running the grader

broadway.grader takes two positional arguments, where TOKEN is the cluster token in API, and GRADER_ID should be a unique identifier of the grader (and only letters, digits, and dashes are allowed)

API_ADDR points to where API was bound to along with the protocol you wish to use. e.g. ws://127.0.0.1:1470 means that grader should find API at 127.0.0.1:1470 and use the websocket version of our protocol.

python3 -m broadway.grader <TOKEN> <GRADER_ID> [--api-host API_ADDR]

More info can be found by running python3 -m broadway.grader --help