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.

Sign up for GitHub

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

IBX-9124: Dynamic attribute submodels described in User Documentation #318

Merged
merged 4 commits into from
Oct 30, 2024
Merged

IBX-9124: Dynamic attribute submodels described in User Documentation #318

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
730f356
Dynamic attribute submodels
julitafalcondusza Oct 23, 2024
6baec1d
fix
julitafalcondusza Oct 23, 2024
bab2175
fix
julitafalcondusza Oct 29, 2024
5ec0d41
fix after doc review
julitafalcondusza Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/personalization/recommendation_models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,36 @@
Recommendation are fetched from all the submodels and merged based on the weight (relevance).
If one of the submodels delivers recommendations with better relevance, the results of other models can disappear from the list.

### Dynamic attributes

Dynamic attribute submodels eliminate the need for manual grouping and simplify configuration.
They allow for simpler, faster, and less demanding recommendation models building using different attributes, because all you need to do is make one request and rebuild the model.

Check warning on line 220 in docs/personalization/recommendation_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/recommendation_models.md#L220 

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output 
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/personalization/recommendation_models.md", "range": {"start": {"line": 220, "column": 1}}}, "severity": "WARNING"}

They work best in straightforward cases when you filter by the value of the attribute.

Dynamic attribute submodels:

- operate only on [nominal attributes](recommendation_models#nominal-attributes) (numeric attributes are not supported)
- can be used for [popularity](recommendation_models#popularity-models) and [collaborative](recommendation_models#collaborative-models) types of models (as they support submodels)
- have limitation of max. 50 attribute values (if more, you need to follow the procedure of manual configuration by [[= product_name_base =]] Team)
- operate on scenarios with the selected `Submodels` data type option
- require sending a request and building a model
- are calculated for all new attribute values after import
- are always up-to-date with the imported items
- still add new values ​​when attributes are only partially grouped manually
- aren't added if all attributes are manually grouped (full manual intervention)
- cannot be calculated if there is any submodel manually configured for provided attribute
- don't operate on the values which are no longer present

!!! note "Enable dynamic attribute"

Dynamic attribute must be enabled by [[= product_name_base =]] Team.
To start using this functionality, contact customer support ([email protected]).

!!! caution "Unused attributes"

If an attribute is not used for at least 5 days, all related submodels are removed.

## Time-slot based models

Time-slot based models consider only a particular range of time rather than the full day when calculating recommendations.
Expand Down
Loading