Work on grading service for Textbook/Learning platform

[vabarbosa]

Description

The Qiskit Textbook/Learning platform is a resource for learning and teaching about quantum computing. To further enhance the learning experience the platform provides multiple choice questions and coding exercises as a means to evaluate the reader's grasp of the content.

The goal of this project is to build up and further improve the current grading service to make it easier for content creators, university professors, etc. to create questions and exercises and automate the validation of the answers. This is one of the most highly anticipated features for the platform!

Deliverables

The output of this project will be

• an updated Qiskit Textbook/Learning platform grading service
• an improved workflow for submitting and evaluating exercises and questions

Mentors details

• Mentor 1
  • Name: va barbosa
  • GitHub ID: @vabarbosa
  • What they do: Developer on the Qiskit Digital education team

Number of mentees

1

Type of mentees

• Mentee 1
  • Required:
    • Interested in web and API application development
    • Interested in quantum education and learning
    • Knowledge of Python 3
  • Nice to have:
    • Experience in web and API application development
    • Experience with GitHub & open source contributions

[vabarbosa]

FYI @pandasa123

[pandasa123]

Content creators also include university professors etc. This is one of the most highly anticipated features for the platform

[AshwinKul28]

This sounds very interesting to me, as a full-time developer for IBM Cloud I have great experience developing APIs, and large-scale applications. Would like to contribute to this. let's connect.

[AshwinKul28]

HI @vabarbosa Do you want to connect sometime? Project sounds interesting.

[vabarbosa]

@AshwinKul28 thank you for your interest! i will be sending you an invite to discuss further.

[AshwinKul28]

HI @GemmaDawson I have got assigned to this issue. Will be working with @vabarbosa and the team. :)

[GemmaDawson]

Please add your Checkpoint 1 presentation materials.

[AshwinKul28]

HI @GemmaDawson, sorry I really missed your mail in the sea of emails.

[AshwinKul28]

Here's Presentation material for the checkpoint 1: cc - @vabarbosa

QAMP_Checkpoint1.pdf
QAMP_Checkpoint1.pptx

[AshwinKul28]

Checkpoint 2 Update

• We have finalized the scope for our APIs, the core functionalities, and requirements as well.

• The behavior of our APIs should be simpler and it should focus on the basic tasks regarding the questions lifecycle.

• Every question in an assignment can be one of the following two types

   1. MCQ based
  

  2. Code snippet based

The current approach is to take input in the form of the python textbook and then render it on the UI. But ofcourse that's not scalable.

Hence we've come up with a more scalable approach where questions can be added/removed/updated dynamically, basically we have introduced CRUD operations on the question as an entity.

• Add a question

POST /questions

1. MCQ based
{
  "text": "Answer the following",
  "type": "mcq",
  "mcq": {
    "option_1": "chicken came first?",
    "option_2": "egg came first",
    "option_3": "Quantum physics came first",
    "answer": 3
  }
}

2.  Code based
{
  "text": "Complete the following snippet?",
  "type": "code",
  "code": {
    "metadata":{
      "id": "ps1-quiz-2",
      "grader_answer": "qc",
      "grader_id": "textbook_practice_exam/problem2a"
    },
    "source": "from qiskit import *\n# Start your work here.\n# We've provided the circuit that is shown above\n# Your circuit MUST be named qc\nqc = QuantumCircuit(2)\nqc.draw()"
  }
}

---

• Get a Question

GET /questions/{id}

{
"id": "65aa343c-1d8f-42cc-8e2f-b1268584a03a",
"text": "Answer the following",
"type": "mcq",
      "mcq": {
          "option_1": "chicken came first?",
          "option_2": "egg came first",
          "option_3": "Quantum physics came first",
          "answer": 3
       },
}

---

• Get all Questions

GET /questions

{[
{
"id": "65aa343c-1d8f-42cc-8e2f-b1268584a03a",
"text": "Answer the following",
"type": "mcq",
      "mcq": {
          "option_1": "chicken came first?",
          "option_2": "egg came first",
          "option_3": "Quantum physics came first",
          "answer": 3
       },
},
{
  "id": "364fac1c-0ec5-45ef-aea9-cf64ac05b4e9",
  "text": "Complete the following snippet?",
  "type": "code",
  "code": {
    "metadata":{
      "id": "ps1-quiz-2",
      "grader_answer": "qc",
      "grader_id": "textbook_practice_exam/problem2a"
    },
    "source": "from qiskit import *\n# Start your work here.\n# We've provided the circuit that is shown above\n# Your circuit MUST be named qc\nqc = QuantumCircuit(2)\nqc.draw()"
  }
}
]}

---

• Delete a question

DELETE /questions/{id}

204 No content

---

• Update a question

PUT /questions/{id}

{
  "text": "Answer the following",
  "mcq": {
    "option_1": "chicken came first?",
    "option_2": "egg came first",
    "option_3": "Quantum physics came first",
    "option_4": "Egg and chicken were in the superposition states"
    "answer": 4
  }
}

All the above operations are completed with the implementations, And we have started work on the UI as well.

FYI - @vabarbosa @GemmaDawson

[GemmaDawson]

@AshwinKul28 - please upload your Final Showcase presentation materials, and if needed, update the project Title and/or description.

[AshwinKul28]

QAMP_Final.pptx
QAMP_Final.pdf

HI, @GemmaDawson Here's the final presentation material, and I cannot attach the video here as its too big. I have sent final video on the slack. Thanks

[GemmaDawson]

Congratulations on completing all the requirements for QAMP Fall 2022!! 🌟🌟🌟