| Magnolia Compatibility | |
|---|---|
| 6.1 |  |
| 6.2 |  |
The Periscope Result Ranker module uses neural networks to store Find Bar search results and rank them by relevance. It extends the Periscope modules.
The module learns user preferences to offer better result ranking for subsequent searches. By default, search result rankings are stored per user. You can change the configuration as necessary. For example, you can enable an individual ranking for each user or for selected users only. Additionally, you can configure the memory size of networks to mitigate possible memory consumption issues in large setups.
Installing with Maven
Maven is the easiest way to install the module. Add the following to your bundle:
<dependency> <groupId>info.magnolia.periscope</groupId> <artifactId>magnolia-periscope-result-ranker</artifactId> <version>1.2.4</version> </dependency>
Source Code
The source for this module can be found here:
Configuration
The module comes with the following default configuration:
periscope-result-ranker/src/main/resources/periscope-result-ranker/config.yaml
outputUnits: 10000 rankingNetworkStorageStrategy: class: info.magnolia.periscope.rank.ml.jcr.JcrUsernameNetworkStorageStrategy
Properties
| Property | Description |
|---|---|
| outputUnits | required, default is The memory size of neural networks. The result-ranking system requires memory (heap space) and disk space per unit for each user (local ranking) or instance (global ranking). You can adjust the size of the memory used per unit to mitigate possible memory consumption issues (see Result Ranker memory size). |
| rankingNetworkStorageStrategy | required The result-ranking memory strategy. The default strategy stores result rankings per user. Other strategies are possible (see Result Ranker strategy). To adjust the strategy, set the |
| class | required, default is Other possible values must be a subtype of |