Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marcusgreen authored May 23, 2024
1 parent ffcc307 commit e7c70f5
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### Moodle AI Text Quiz Question type by Marcus Green

This is a fork of the core essay question type which can use the ChatGPT Large language model to give automatic feedback and marking for submitted responses. For custom development and consultancy contact Moodle Partner Catalyst EU (https://www.catalyst-eu.net/).
This Moodle question type accepts free text which is then evaluated by a remote Large Language Model AI system such as ChatGPT. Each question can have its own feedback and grading prompts. For custom development and consultancy contact Moodle Partner Catalyst EU (https://www.catalyst-eu.net/).

If you are a Moodle developer and you use vscode/vscodium you should consider this plugin https://marketplace.visualstudio.com/items?itemName=LMSCloud.mdlcode

It requires either a paid for ChatGPT api account which will give access to ChatGPT4 or Ollama hosted Large Language Model. Accounts are available from https://platform.openai.com, Ollama is available from https://github.com/ollama/ollama. It depends on the Moodle aiconnect tool which is available from
It requires either a paid for ChatGPT api account which will give access to ChatGPT4 or
other Large Language Model such as Ollama or https://groq.com.

It depends on this plugin for the api calls to work.
https://github.com/marcusgreen/moodle-tool_aiconnect

## Prompting
Expand All @@ -17,14 +17,10 @@ It may help to test prompts directly on the Chat GPT site to confirm they work

## Limitations

Although it is based on a clone of the core esssay question type with lots of inspiration from Gordon Batesons essay_autograde plugin, it is being built and tested mainly on text responses and so things like the inclusion of
images in the question display may not work. It will only work with the immediate feedback question behaviour.
Although it is based on a clone of the core esssay question type with lots of inspiration from Gordon Batesons essay_autograde plugin, it is being built and tested mainly on text responses and so things like the inclusion of images in the question display may not work. It will only work with the immediate feedback question behaviour.

## Roadmap
~~Support other LLM systems. Supporting a self hosted LLM will ensure data sovereignty~~ done
If you are a Moodle developer and you use vscode/vscodium you should consider this plugin https://marketplace.visualstudio.com/items?itemName=LMSCloud.mdlcode.

Moderation: Do not show ai feedback until previewed and approved by a teacher
## Roadmap

Cron based evaluation. Allow for slow LLM systems by marking on a cron timer

Allow it to work with other question behaviour types such as Interactive with multiple tries.

0 comments on commit e7c70f5

Please sign in to comment.