diff --git a/docs/_static/css/style.css b/docs/_static/css/style.css index bc954b5b0..6d613065e 100644 --- a/docs/_static/css/style.css +++ b/docs/_static/css/style.css @@ -4,3 +4,7 @@ .wy-body-for-nav .wy-nav-content { max-width: none; /* use full width */ } + +.wy-table-responsive table td, .wy-table-responsive table th { + white-space: normal; +} \ No newline at end of file diff --git a/docs/images/subsystem_decomposition.svg b/docs/images/subsystem_decomposition.svg new file mode 100644 index 000000000..3086f3c0f --- /dev/null +++ b/docs/images/subsystem_decomposition.svg @@ -0,0 +1,1574 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Athena Assessment Service + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + «module» + + + + + + Programming LLM + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + «module» + + + + + + Text LLM + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + «module» + + + + + + CoFee + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Assessment Module + Manager + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Learning Management + System + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Playground + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Athena API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + «module» + + + + + + ThemisML + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + «module» + + + + + + Example + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Programming Module + + + + + + Text Module + + + + + + + diff --git a/docs/index.rst b/docs/index.rst index 5f42da067..604c9fac0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ Athena will use the information it is given and provide the automatic suggestion :includehidden: :maxdepth: 1 + overview/athena overview/playground .. toctree:: diff --git a/docs/overview/athena.rst b/docs/overview/athena.rst new file mode 100644 index 000000000..f77225025 --- /dev/null +++ b/docs/overview/athena.rst @@ -0,0 +1,48 @@ +Athena +========== + +List of Modules +---------------- + +.. list-table:: + :widths: 15 10 75 + :header-rows: 1 + + * - Module + - Type + - Description + * - ``module_example`` + - Programming + - Contains a simple example of a module, which can be used as a template for + new modules. It is only used for testing purposes. + * - ``module_programming_themisml`` + - Programming + - The module uses ANTLR47 and CodeBERT for parsing submissions and identifying feedback methods, + and refines feedback through filters, flagging overly generic feedback and reinstating valid + feedback when similar suggestions recur for the same method. + * - ``module_programming_llm`` + - Programming + - Employs large language models to generate context-specific feedback for programming + exercises by integrating elements like file-specific problem statements, grading instructions, + and submission files, following a workflow of formatting prompts, predicting, and parsing + feedback suggestions. + * - ``module_text_llm`` + - Text + - Large language model based feedback suggestions using a three-step workflow of formatting prompts with + rich context, predicting and parsing feedback suggestions, managing token limits by omitting parts of + input. Additionally, it incorporates an LLM-as-a-judge approach for automatic evaluation of suggestions. + * - ``module_text_cofee`` + - Text + - CoFee is a machine learning-based approach that automates grading by employing topic modeling, + segment-based grading, and hierarchical clustering to suggest feedback, significantly reducing + grading effort by identifying groups of similar text segments for efficient and precise feedback + generation. + +System Design +------------- + +.. figure:: ../images/subsystem_decomposition.svg + :width: 500px + :alt: Subsystem decomposition of Athena + + Subsystem decomposition of Athena