Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-65639

Rename 'Time-splitting' to 'Analysis interval' + other wording improvements

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 3.8
    • Fix Version/s: 3.8
    • Component/s: Analytics
    • Labels:
    • Testing Instructions:
      Hide

      In this issue we remove the references to "time-splitting method" from the UI. Please report it if you see any reference to it.

      Prerequisites

      1. Log in as an admin
      2. Go to site admin > analytics > analytics settings
      3. Disable 'onlycli' setting and save changes
      1. Go to site admin > analytics > analytics models
      2. You SHOULD see a Analysis interval column
      3. Click on Actions > Edit for the Students at risk of dropping out model (if you can't see it listed restore it by clicking on New model > Restore default models)
      4. You SHOULD see a Analysis interval field
        1. Expand the select box. It SHOULD contain Last quarter and Last tenth options
        2. Select the first element in the select box (empty value)
        3. Save changes
      5. Check that the Analysis interval column for the Students at risk of dropping out model contains a Not yet defined. You can click on the help button, you SHOULD see a You need to select an analysis interval before enabling the model
      6. Edit the model again and now set the analysis interval to Last quarter and Save changes
      7. Click on the help button in the Analysis interval column for the Students at risk of dropping out model
      8. You SHOULD NOT see time-splitting method anywhere in the text
      1. Click on "Actions > Execute scheduled analysis" for any model.
      2. You SHOULD be forwarded to a page whose heading title is Analysis. Analysis SHOULD also be the active node in the breadcrumb.
      1. Execute php admin/tool/analytics/cli/evaluate_model.php in the CLI. The returned info SHOULD NOT contain any reference to time-splitting methods (Apart from the Example: ... --analysisinterval='\core\analytics\time_splitting\quarters'...  This is fine).
      Show
      In this issue we remove the references to "time-splitting method" from the UI. Please report it if you see any reference to it. Prerequisites Log in as an admin Go to site admin > analytics > analytics settings Disable 'onlycli' setting and save changes Go to site admin > analytics > analytics models You SHOULD see a Analysis interval column Click on Actions > Edit for the Students at risk of dropping out model (if you can't see it listed restore it by clicking on New model > Restore default models) You SHOULD see a Analysis interval field Expand the select box. It SHOULD contain Last quarter and Last tenth options Select the first element in the select box (empty value) Save changes Check that the Analysis interval column for the Students at risk of dropping out model contains a Not yet defined . You can click on the help button, you SHOULD see a You need to select an analysis interval before enabling the model Edit the model again and now set the analysis interval to Last quarter and Save changes Click on the help button in the Analysis interval column for the Students at risk of dropping out model You SHOULD NOT see time-splitting method anywhere in the text Click on "Actions > Execute scheduled analysis" for any model. You SHOULD be forwarded to a page whose heading title is Analysis . Analysis SHOULD also be the active node in the breadcrumb. Execute php admin/tool/analytics/cli/evaluate_model.php in the CLI. The returned info SHOULD NOT contain any reference to time-splitting methods (Apart from the Example: ... --analysisinterval='\core\analytics\time_splitting\quarters'...  This is fine).
    • Affected Branches:
      MOODLE_38_STABLE
    • Fixed Branches:
      MOODLE_38_STABLE
    • Pull from Repository:
    • Pull Master Branch:
      MDL-65639_master

      Description

      This issue involves 3 different aspects.

      Time-splitting method in the UI
      Time-splitting method is not a nice name, it is not even nice to type. It sounds like something very complex and weird and it does not even reflect what it really is as not all time-splitting methods split the duration of an analysable element in parts.

      To update all the internal references to time-splitting method would be hell, but we can change the references in the UI by something more user-friendly. After asking for suggestions Elizabeth Dalton proposed "Prediction interval" or "Analysis interval". I personally like "analysis interval" because those same intervals are also used to generate training data.

      The name of the time-splitting methods in core
      Naming specific time-splitting methods has also been challenging because:

      1. We talk about "the start" or about "the end" without mentioning the start or the end of what. The name of the target helps here, but still, it is not 100% clear. This is the price for having reusable elements in this API...
      2. We need to inform users of too many things in just 1 line
        1. How many predictions (i.e. intervals for analysis) will be generated?
        2. When will the system generate predictions?
        3. What interval will be used during each of the analysis?

      Therefore, as part of this change we should also review the names we have been using to describe the time-splitting methods we have in core as these options would not directly make sense when put next to a field named "Analysis interval". I propose to use the help link to clearly explain #1, #2.1, #2.2 and #2.3.

      I am writing a proposal for this that will be also useful for MDL-65633. This is the draft image.

      The "Get predictions" action is not a get predictions on-demand
      I can imagine someone that does not know much about this system expecting a model to generate predictions every time a user clicks on "Get predictions". This is not how time-splitting methods work and it is related with the point #2.2 in The name of the time-splitting methods in core. A model that uses a time-splitting method that only generates 1 prediction for each sample will calculate the indicators and generate the prediction the first time the "Get prediction" action is executed. The second time it is executed we will detect that this model already generated a prediction for that sample and will return a No new predictions yet message. The same happens with time-splitting methods that generate predictions after each quarter of the course. After the first quarter of the course a prediction will be generated when "Get predictions" is executed or when the cron executes it automatically. If a site manager manually executes "Get predictions" the following day, the No new predictions yet message will be displayed again and no new predictions will be generated until the next quarter of the course is over. We either need to rename the Get predictions action or to reword the No new predictions yet message.

        Attachments

          Issue Links

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Fix Release Date:
                  18/Nov/19

                  Time Tracking

                  Estimated:
                  Original Estimate - 0 minutes
                  0m
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 day, 5 hours, 35 minutes
                  1d 5h 35m