raymak / contextualfeaturerecommender

Mozilla Public License 2.0
4 stars 2 forks source link

better readme and docs on how to build special versions, etc #295

Open gregglind opened 8 years ago

gregglind commented 8 years ago

SOME NOTES

I want to make a new distributable build / fork

cd builds
mkdir myBuild
cd myBuild
## create files that will OVERRIDE/replace the ones in the main tree, such as `package.json`

### acutally build
make myBuild

issues:

  1. replace the live files (no temp)

    why go this way, rather then prefs.json

b/c if you reset an addon, it will blow away user prefs. the ones build into package.json are default branch prefs

choose this approach IF you want to do 'big' things, like

(poor person's git fork / tag)

Approach 2:

(Choose if you only want different thresholds)

  1. create a new / clone data/*recs.json as data/my-thresholds.json
change `recomm_list_address` to `my-thresholds.json`
change `experiment.obs1_length_tick` to 0
"trigBehavior": "tabs newtab-button -c >0",

OR 

"trigBehavior": "tabs newtab-button",  # same

-c count
-if "inverse frequency"
-f  "freq"

-c >50 -if <5

b1, ... b50... ignore
b51 maybe?
- only if at least 1 per 5 ACTIVE_TICKS on average
  so... on b51 IFF T <= 5*51 TICK UNITS
  on b52 IFF  T <= 5*52 

- ignore for a 'while' (time and/or behaviour)
- bursts?

filter() => doesn't have TST (blunt!)
trigger:
  firstOf(
    - x times in p period [ignoring first X minutes] "intense"
    - total count is > K  [iff T > t]  "total"
  )

time unit is in ACTIVE-TICKS
defined at <this pref> => 1 minute (while active)

Decyphering A ContextTrigger map

  {
    "id": "newTabShortcut",
    "priority": 1,
    "trigBehavior": "tabs newtab-button -c >50 -if <5",
    "delivContext": "tabs newtab-button",
    "featUseBehavior": "hotkey t -cmd -c >1",
    "presentationData": {
      "*": {
        "message": "You can use the <span class='key'>Ctrl</span>+<span class='key'>T</span> keyboard shortcut to open a new tab faster!",
        "rationale": "You open tabs a lot.",
        "title": "New Tab shortcut"
      },
      "doorhanger": {
        "secondaryButtonLabel": null,
        "primaryButtonLabel": "Learn more"
      }
    },
    "respCommandMap": {
      "doorhanger": {
        "primaryButton": "open url -l https://support.mozilla.org/en-US/kb/keyboard-shortcuts-perform-firefox-tasks-quickly#w_windows-tabs"
      }
    },
    "tags": ""
  },

more:

kamyar experiment.override_mode: “ec1” (sets the condition to short silence period, in-context, trigger coefficient = 1)

You are on an experimental (Beta) version of Firefox. Do you want the stable version instead?