Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adaptive learning: Improve mastery calculation #8791

Merged
merged 37 commits into from
Jun 22, 2024

Conversation

JohannesStoehr
Copy link
Contributor

@JohannesStoehr JohannesStoehr commented Jun 13, 2024

🚨 🚨 This PR contains a database migration 🚨 🚨

Checklist

General

Server

  • Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
  • I strictly followed the server coding and design guidelines.
  • I added multiple integration tests (Spring) related to the features (with a high test coverage).
  • I added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
  • I documented the Java code using JavaDoc style.

Client

  • Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data.
  • I strictly followed the client coding and design guidelines.
  • I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
  • I documented the TypeScript code using JSDoc style.
  • I translated all newly inserted strings into English and German.

Motivation and Context

#8756
Tl;dr: Improve the calculation of the mastery for competencies.

Description

The progress now depends on the actual score of the exercises linked to that competency.
The confidence is no longer shown to students but is still use to calculate the mastery. It is now a factor that multiplied with the progress gives the mastery.

Steps for Testing

Prerequisites:

  • 1 Instructor
  • 1 Student
  1. Log in to Artemis
  2. Navigate to Course Administration
  3. Create a competency
  4. Create a lecture with lecture units. Link the lecture units to the competency during their creation
  5. Create exercises. Link them to the competency during their creation
  6. Participate as a student and check the following things:
    • The progress increases whenever you complete a lecture unit or increase your score in an exercise
    • The mastery is roughly the same as the progress unless:
      • There are multiple exercises and your latest scores are higher/lower than the average score
      • You mainly gained points in easy/hard exercises while there are also exercises with other difficulties linked to the competency
      • You quickly solved programming exercises (achieved >=80% in <= 3 submissions)
    • If the mastery is different, there is a help icon next to the mastery value in the details page and the student gets an explanation by hovering over it

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked






Review Progress

Performance Review

  • I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance
  • I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Test Coverage

Client

Class/File Line Coverage Confirmation (assert/expect)
competency-card.component.ts 100%
competency-rings.component.ts 84.21%
learning-path-node.component.ts 100%
competency-node-details.component.ts 95.23%
course-competencies-details.component.ts 77.01%
course-competencies.component.ts 96.61%

Server

Class/File Line Coverage Confirmation (assert/expect)
LearningObjectService.java 100%
ParticipantScoreService.java 95%
CompetencyProgressService.java 94%
LearningPathNgxService.java 97%
LearningPathRecommendationService.java 96%
LearningPathService.java 99%
LearningMetricsService.java 99%
ParticipantScoreScheduleService.java 89%
CompetencyResource.java 95%

Screenshots

New student course dashboard:

Bildschirmfoto 2024-06-22 um 12 54 28

Overview over all competencies with explanation for progress and mastery:

Bildschirmfoto 2024-06-22 um 12 45 38

Overview over one competency with explanation for diverging progress and confidence:

Bildschirmfoto 2024-06-22 um 12 45 59

Summary by CodeRabbit

  • New Features

    • Introduced constants for score thresholds for result evaluation.
    • Added confidence reason tracking in competency progress.
    • Enhanced competency progress calculations based on exercises and lecture units.
    • Refactored learning path and metrics services for improved performance and accuracy.
  • Bug Fixes

    • Corrected logic for determining completion status in exercises.
    • Fixed duplication issues in competency lecture unit retrieval.
  • Refactor

    • Improved readability and maintainability by using switch-case statements.
    • Consolidated confidence calculations and exercise mastery queries.
  • Tests

    • Added comprehensive tests for LearningObjectService methods to validate user completion status.

@JohannesStoehr JohannesStoehr added the server Pull requests that update Java code. (Added Automatically!) label Jun 13, 2024
@JohannesStoehr JohannesStoehr self-assigned this Jun 13, 2024
@github-actions github-actions bot added the tests label Jun 13, 2024
@JohannesStoehr JohannesStoehr added this to the 7.2.2 milestone Jun 13, 2024
@github-actions github-actions bot added the database Pull requests that update the database. (Added Automatically!). Require a CRITICAL deployment. label Jun 14, 2024
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Jun 17, 2024
@JohannesStoehr JohannesStoehr marked this pull request as ready for review June 17, 2024 19:54
@JohannesStoehr JohannesStoehr requested a review from a team as a code owner June 17, 2024 19:54
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

@krusche krusche merged commit c9521c2 into develop Jun 22, 2024
26 of 29 checks passed
@krusche krusche deleted the feature/adaptive-learning/better-mastery-calculation branch June 22, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) component:AdaptiveLearning database Pull requests that update the database. (Added Automatically!). Require a CRITICAL deployment. maintainer-approved The feature maintainer has approved the PR ready to merge server Pull requests that update Java code. (Added Automatically!) tests
Projects
Archived in project
Status: Done
Development

Successfully merging this pull request may close these issues.