aac-metrics 0.1.8 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 554fc52ede0b5dffdcf9315ec279a9f42a3ef2a44a324195018eda56538336b1
-  data.tar.gz: 2b082df38edf52ddf495045969db894ef02f7718641658d8d1ca4b012456e14c
+  metadata.gz: bddb8e430a21868a5b26312fb5924f36b914446dc212d849330462768fd9b233
+  data.tar.gz: c5ddd0e2b835678f0dabf8743099b29d462612d94a4aa4dd261e1cb7337eaa02
 SHA512:
-  metadata.gz: 58c3c7e8128b0bee8754baa3b218a36491cf985ed752b917733a0508bc9a4c8abe8c3e2c40ddcb7cd9098bea51a6c3d9143f5ba4cbd2d9098f59f16899bf1e0b
-  data.tar.gz: c9e2ec540feee357aaf6b1a20b11e5b938d2f4f8d28ba6d03eee80245167b1eb339ab5a2e1440588db6a31cffbe27bee37a44d6ef35f0078f5381d363c06226c
+  metadata.gz: 876e09d6be2b2e2b7579c11bb06367296ee7fbba627db0f8d421b4e60d2b7042d9a41433f9b1af10c78a6fc8ac84077170224e059a5a5ba30db6b217cab56936
+  data.tar.gz: 5072598db0226690da77985e4e1ed760b24f0d0edc2bc99a5961e59d7f8e8bfa549073f4d0b223559ba48d7d2348556041d8b513944e5427c9c158db3b467f6c

data/lib/aac-metrics/loader.rb

@@ -20,6 +20,7 @@ module AACMetrics::Loader
           }
           if button['load_board'] && button['load_board']['id']
             new_button['load_board'] = {'id' => button['load_board']['id']}
+            new_button['load_board']['add_to_sentence'] = true if button['load_board']['add_to_sentence']
           end
           new_board['buttons'].push(new_button)
         end
@@ -177,6 +178,7 @@ module AACMetrics::Loader
                 else
                   puts "Link found with no access #{btn['load_board'].to_json}"
                 end
+                new_btn['load_board']['add_to_sentence'] = true if new_btn['load_board'] && btn['load_board']['add_to_sentence']
               elsif btn['action']
                 # TODO: track keyboard actions and don't
                 # treat action buttons for metrics
@@ -391,9 +393,18 @@ module AACMetrics::Loader
       end
     end
     all_words.uniq!
-    @@synonyms[locale] = all_words
+    @@fringe_words[locale] = all_words
   end
-  
+
+  def self.common_fringe_words(locale)
+    @@common_fringe_words ||= {}
+    return @@common_fringe_words[locale] if @@common_fringe_words[locale]
+    common = self.common_words(locale)['words']
+    core = self.core_lists('en').map{|r| r['words'] }.flatten.compact.uniq
+    all_words = common - core
+    @@common_fringe_words[locale] = all_words
+  end
+
   def self.base_words(locale)
     @@base_words ||= {}
     return @@base_words[locale] if @@base_words[locale]

data/lib/aac-metrics/metrics.rb

@@ -1,14 +1,14 @@
 # TODO:
 # Qualitative evaluation criteria:
-# - this set is easy to learn for communicators
-# - this set is easy to learn for supporters
-# - the vocabulary organization of this set makes sense
-# - this set provides clear opportunities for user-specific words to be added
-# - grammatical forms, growth over time
-# - works well for age group X, Y, Z
-# - works well for a beginning communicator
-# - allows long-term growth as-is
-# - comprehensive core
+# - this set looks easy to learn for communicators
+# - this set looks easy to learn for supporters
+# - this vocabulary organization of this set makes sense
+# - this set provides clear locations for user-specific words to be added
+# - this set supports the use of grammatical forms (tenses and other inflections)
+# - this set provides predefined simplification for beginning communicators
+# - this set allows for long-term vocabulary growth over time
+# - this vocabulary looks like it will work well for young users
+# - this vocabulary looks like it will work well for adult users
 
 # Effort algorithms for scanning/eyes
 module AACMetrics::Metrics
@@ -54,6 +54,7 @@ module AACMetrics::Metrics
       visited_board_ids = {}
       to_visit = [{board: obfset[0], level: 0, entry_x: 1.0, entry_y: 1.0}]
       set_refs = {}
+      cell_refs = {}
       rows_tally = 0.0
       cols_tally = 0.0
       root_rows = nil
@@ -73,6 +74,13 @@ module AACMetrics::Metrics
             set_refs[id] += 1
           end
         end
+        board['grid']['rows'].times do |row_idx|
+          board['grid']['columns'].times do |col_idx|
+            id = (board['grid']['order'][row_idx] || [])[col_idx]
+            cell_refs["#{row_idx}.#{col_idx}"] ||= 0.0
+            cell_refs["#{row_idx}.#{col_idx}"] += id ? 1.0 : 0.25
+          end
+        end
         if board['semantic_ids']
           board['semantic_ids'].each do |id|
             set_refs[id] ||= 0
@@ -88,7 +96,8 @@ module AACMetrics::Metrics
       end
       set_pcts = {}
       set_refs.each do |id, cnt|
-        set_pcts[id] = cnt.to_f / obfset.length.to_f
+        loc = id.split(/-/)[1]
+        set_pcts[id] = cnt.to_f / (cell_refs[loc] || obfset.length).to_f
       end
       locale = obfset[0]['locale']
       known_buttons = {}
@@ -115,9 +124,9 @@ module AACMetrics::Metrics
             button_id = (board[:board]['grid']['order'][row_idx] || [])[col_idx]
             button = board[:board]['buttons'].detect{|b| b['id'] == button_id }
             if button && button['clone_id'] && set_pcts[button['clone_id']]
-              reuse_discount += REUSED_CLONE_FROM_OTHER_DISCOUNT * set_pcts[button['clone_id']]
+              reuse_discount += REUSED_CLONE_FROM_OTHER_BONUS * set_pcts[button['clone_id']]
             elsif button && button['semantic_id'] && set_pcts[button['semantic_id']]
-              reuse_discount += REUSED_SEMANTIC_FROM_OTHER_DISCOUNT * set_pcts[button['semantic_id']]
+              reuse_discount += REUSED_SEMANTIC_FROM_OTHER_BONUS * set_pcts[button['semantic_id']]
             end
           end
         end
@@ -186,9 +195,13 @@ module AACMetrics::Metrics
             button_effort = board_effort
             if board_pcts[button['semantic_id']]
               # TODO: Pull out these magic numbers
+              prior = button_effort
               button_effort = [button_effort, button_effort * SAME_LOCATION_AS_PRIOR_DISCOUNT / board_pcts[button['semantic_id']]].min
+#              puts "  #{button['label']} #{prior.round(1)} - #{prior - button_effort}"
             elsif board_pcts["upstream-#{button['semantic_id']}"]
+              prior = button_effort
               button_effort = [button_effort, button_effort * RECOGNIZABLE_SEMANTIC_FROM_PRIOR_DISCOUNT / board_pcts["upstream-#{button['semantic_id']}"]].min
+              # puts "  #{button['label']} #{prior.round(1)} - #{prior - button_effort}"
             end
             if board_pcts[button['clone_id']]
               button_effort = [button_effort, button_effort * SAME_LOCATION_AS_PRIOR_DISCOUNT / board_pcts[button['clone_id']]].min
@@ -237,6 +250,10 @@ module AACMetrics::Metrics
             effort += board[:prior_effort] || 0
             prior_buttons += 1
 
+            # TODO: If any board links are sticky, or if
+            # the board set isn't auto-home, or any board links
+            # are add_to_sentence, then the logic will be different
+            # for calculating effort scores, since the route matters
             if button['load_board']
               try_visit = false
               # For linked buttons, only traverse if
@@ -265,7 +282,8 @@ module AACMetrics::Metrics
                   })
                 end
               end
-            else
+            end
+            if !button['load_board'] || button['load_board']['add_to_sentence']
               word = button['label']
               existing = known_buttons[word]
               if !existing || effort < existing[:effort] #board[:level] < existing[:level]
@@ -326,11 +344,11 @@ module AACMetrics::Metrics
   SKIPPED_VISUAL_SCAN_DISTANCE_MULTIPLIER = 0.5
   SAME_LOCATION_AS_PRIOR_DISCOUNT = 0.1
   RECOGNIZABLE_SEMANTIC_FROM_PRIOR_DISCOUNT = 0.5
-  RECOGNIZABLE_SEMANTIC_FROM_OTHER_DISCOUNT = 0.6
+  RECOGNIZABLE_SEMANTIC_FROM_OTHER_DISCOUNT = 0.5
+  REUSED_SEMANTIC_FROM_OTHER_BONUS = 0.0025
   RECOGNIZABLE_CLONE_FROM_PRIOR_DISCOUNT = 0.33
-  RECOGNIZABLE_CLONE_FROM_OTHER_DISCOUNT = 0.4
-  REUSED_SEMANTIC_FROM_OTHER_DISCOUNT = 0.0025
-  REUSED_CLONE_FROM_OTHER_DISCOUNT = 0.005
+  RECOGNIZABLE_CLONE_FROM_OTHER_DISCOUNT = 0.33
+  REUSED_CLONE_FROM_OTHER_BONUS = 0.005
 
   def self.button_size_effort(rows, cols)
     BUTTON_SIZE_MULTIPLIER * (rows + cols) / 2
@@ -407,6 +425,7 @@ module AACMetrics::Metrics
     synonyms = AACMetrics::Loader.synonyms(target[:locale])
     sentences = AACMetrics::Loader.sentences(target[:locale])
     fringe = AACMetrics::Loader.fringe_words(target[:locale])
+    common_fringe = AACMetrics::Loader.common_fringe_words(target[:locale])
     common_words_obj['efforts'].each{|w, e| sortable_efforts[w] ||= e }
     common_words = common_words_obj['words']
     
@@ -476,6 +495,7 @@ module AACMetrics::Metrics
     res[:cores] = {
       :common => {name: "Common Word List", list: common_words, average_effort: common_effort, comp_effort: comp_effort}
     }
+    res[:care_components] = {}
     target_effort_tally = 0.0
     comp_effort_tally = 0.0
     # For each core list, find any missing words, and compute
@@ -505,6 +525,7 @@ module AACMetrics::Metrics
         end
         # Fallback penalty for missing word
         effort ||= spelling_effort(word)
+        reffort = effort
         list_effort += effort
 
         effort = comp_efforts[word]
@@ -513,6 +534,7 @@ module AACMetrics::Metrics
         end
         effort ||= spelling_effort(word)
         comp_effort += effort
+        # puts "#{word} - #{reffort.round(1)} - #{effort.round(1)}"
       end
       if missing.length > 0
         # puts "MISSING FROM #{list['id']} (#{missing.length}):"
@@ -525,8 +547,10 @@ module AACMetrics::Metrics
       comp_effort_tally += comp_effort
       res[:cores][list['id']] = {name: list['name'], list: list['words'], average_effort: list_effort, comp_effort: comp_effort}
     end
-    target_effort_tally = (target_effort_tally / core_lists.to_a.length) * 5.0
-    comp_effort_tally = (comp_effort_tally / core_lists.to_a.length) * 5.0
+    res[:care_components][:core] = (target_effort_tally / core_lists.to_a.length) * 5.0
+    target_effort_tally = res[:care_components][:core]
+    res[:care_components][:comp_core] = (comp_effort_tally / core_lists.to_a.length) * 5.0
+    comp_effort_tally = res[:care_components][:comp_core]
 
     # TODO: Assemble or allow a battery of word combinations,
     # and calculate the level of effort for each sequence,
@@ -574,8 +598,10 @@ module AACMetrics::Metrics
       comp_effort_score = comp_effort_score / words.length
       res[:sentences] << {sentence: words.join(' '), words: words, effort: target_effort_score, comp_effort: comp_effort_score}
     end
-    target_effort_tally += res[:sentences].map{|s| s[:effort] }.sum.to_f / res[:sentences].length.to_f * 3.0
-    comp_effort_tally += res[:sentences].map{|s| s[:comp_effort] }.sum.to_f / res[:sentences].length.to_f * 3.0
+    res[:care_components][:sentences] = res[:sentences].map{|s| s[:effort] }.sum.to_f / res[:sentences].length.to_f * 3.0
+    target_effort_tally += res[:care_components][:sentences]
+    res[:care_components][:comp_sentences] = res[:sentences].map{|s| s[:comp_effort] }.sum.to_f / res[:sentences].length.to_f * 3.0
+    comp_effort_tally += res[:care_components][:comp_sentences]
 
     res[:fringe_words] = []
     fringe.each do |word|
@@ -586,6 +612,7 @@ module AACMetrics::Metrics
       if !effort
         synonym_words.each{|w| effort ||= target_efforts[w] }
       end
+      # puts "!#{word}" unless effort
       effort ||= spelling_effort(word)
       target_effort_score += effort
 
@@ -597,16 +624,48 @@ module AACMetrics::Metrics
       comp_effort_score += effort
       res[:fringe_words] << {word: word, effort: target_effort_score, comp_effort: comp_effort_score}
     end
-    target_effort_tally += res[:fringe_words].map{|s| s[:effort] }.sum.to_f / res[:fringe_words].length.to_f * 2.0
-    comp_effort_tally += res[:fringe_words].map{|s| s[:comp_effort] }.sum.to_f / res[:fringe_words].length.to_f * 2.0
+    res[:care_components][:fringe] = res[:fringe_words].map{|s| s[:effort] }.sum.to_f / res[:fringe_words].length.to_f * 2.0
+    target_effort_tally += res[:care_components][:fringe]
+    res[:care_components][:comp_fringe] = res[:fringe_words].map{|s| s[:comp_effort] }.sum.to_f / res[:fringe_words].length.to_f * 2.0
+    comp_effort_tally += res[:care_components][:comp_fringe]
+
+    res[:common_fringe_words] = []
+    common_fringe.each do |word|
+      target_effort_score = 0.0
+      comp_effort_score = 0.0
+      synonym_words = [word] + (synonyms[word] || [])
+      effort = target_efforts[word] || target_efforts[word.downcase]
+      if !effort
+        synonym_words.each{|w| effort ||= target_efforts[w] }
+      end
+      effort ||= spelling_effort(word)
+      target_effort_score += effort
+
+      effort = comp_efforts[word] || comp_efforts[word.downcase]
+      if !effort
+        synonym_words.each{|w| effort ||= comp_efforts[w] }
+      end
+      effort ||= spelling_effort(word)
+      comp_effort_score += effort
+      res[:common_fringe_words] << {word: word, effort: target_effort_score, comp_effort: comp_effort_score}
+    end
+    res[:care_components][:common_fringe] = res[:common_fringe_words].map{|s| s[:effort] }.sum.to_f / res[:common_fringe_words].length.to_f * 1.0
+    target_effort_tally += res[:care_components][:common_fringe]
+    res[:care_components][:comp_common_fringe] = res[:common_fringe_words].map{|s| s[:comp_effort] }.sum.to_f / res[:common_fringe_words].length.to_f * 1.0
+    comp_effort_tally += res[:care_components][:comp_common_fringe]
 
-    target_effort_tally += 80 # placeholder value for future added calculations
-    comp_effort_tally += 80
+    target_effort_tally += 70 # placeholder value for future added calculations
+    comp_effort_tally += 70
 
+    # puts target_effort_tally
+    # puts comp_effort_tally
+    # puts (target_effort_tally - comp_effort_tally).abs
+    # puts JSON.pretty_generate(res[:care_components])
+#    raise 'arf'
 
 
-    res[:target_effort_score] = target_effort_tally
-    res[:comp_effort_score] = comp_effort_tally
+    res[:target_effort_score] = [0.0, 350.0 - target_effort_tally].max
+    res[:comp_effort_score] = [0.0, 350.0 - comp_effort_tally].max
     # puts "CONSIDER MAKING EASIER"
     res[:high_effort_words] = too_hard
     # puts too_hard.join('  ')