Skip to content

Commit

Permalink
Changed blacklistEvents to blacklistIndicators
Browse files Browse the repository at this point in the history
  • Loading branch information
zebraf1 committed Mar 25, 2020
1 parent c44f0c3 commit 76b68bb
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions h_ur_advanced_tuning.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ If training and query times are not a factor these can safely be increased with
The default `blacklistIndicators` in the engine parameters is the single primary event. This means that if the user took the primary event on an item it will not be returned in recommendations. This is often the right thing to do but there are exceptions.
In some cases an item may be consumed periodically like Clothing, or Food so reminding a user that they like an item may be good. To disable the blacklist set the following `"blacklistEvents": []`, which means to return all recommendations without restriction.
In some cases an item may be consumed periodically like Clothing, or Food so reminding a user that they like an item may be good. To disable the blacklist set the following `"blacklistIndicators": []`, which means to return all recommendations without restriction.
It is possible with this setting to get only things the user is already familiar with. Disabling the blacklist may not be the best way to handle this. For instance lets say you have 10 recommendations to show; it might be better to get 9 recommendations (with the blacklist) and put in one item you already know the user prefers from your own data. Any mixing of items the user is familiar with and recommendations can be done as part of the application logic, not implemented by the recommender.
In other cases you may want to be more restrictive and use more than the primary event to filter out items from recs. Setting to `"blacklistEvents": ["buy", "view"]` is a good example, where anything the use bought or any item detail page the user viewed will will result in those items not being returned as recommendations.
In other cases you may want to be more restrictive and use more than the primary event to filter out items from recs. Setting to `"blacklistIndicators": ["buy", "view"]` is a good example, where anything the use bought or any item detail page the user viewed will will result in those items not being returned as recommendations.
## Anti Flood
Expand Down
4 changes: 2 additions & 2 deletions h_ur_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ How to read config settings:
},
...
],
"blacklistEvents": ["<list>", "<of>", "<indicator>", "<names>"],
"blacklistIndicators": ["<list>", "<of>", "<indicator>", "<names>"],
"maxEventsPerEventType": <some-int>,
"maxCorrelatorsPerEventType": "<some-int>",
"maxQueryEvents": <some-int>,
Expand Down Expand Up @@ -167,7 +167,7 @@ How to read config settings:
},
...
],
"blacklistEvents": ["primary-indicator-name"], // OPTIONAL
"blacklistIndicators": ["primary-indicator-name"], // OPTIONAL
"maxEventsPerEventType": 500, // OPTIONAL
"maxCorrelatorsPerEventType": 50, // OPTIONAL
"maxQueryEvents": 100, // OPTIONAL
Expand Down

0 comments on commit 76b68bb

Please sign in to comment.