This documentation is still in progress. We are working hard to update all our screenshots to the new Magnolia 6 style. Please bear with us.

Page tree
Skip to end of metadata
Go to start of metadata

The Periscope Result Ranker module provides neural network-based search result ranking functionality used by the Find Bar. It extends the Periscope modules.

Installing

Maven is the easiest way to install the module. Add the following dependency to your bundle. All the other necessary dependencies will be brought in automatically:

<dependency>
  <groupId>info.magnolia.periscope</groupId>
  <artifactId>magnolia-periscope-result-ranker</artifactId>
  <version>1.0</version>
</dependency>

Pre-built jars are also available for download. See Installing a module for help.

Configuration

No configuration is required.

Note that the Result Ranker module stores its "memory", essentially what it has learned so far about user preferences, under /modules/magnolia-periscope-result-ranker/persistence Search result preferences  are stored by instance, not by user.

If you delete the persistence  node, the system forgets what it has learned and must start from scratch again.

The persistence node can be exported to populate a new installation of Magnolia.

Adding support for Linux armhf or Linux ppc64le

The Result Ranker only supports Linux, Mac OS, and Windows by default.

Note that only 64-bit versions of platforms are supported.

If you use Magnolia from one of the environments below, you must add the corresponding dependencies manually:

linux-armhf

<dependency>
 <groupId>org.bytedeco.javacpp-presets</groupId>
 <artifactId>openblas</artifactId>
 <classifier>linux-armhf</classifier>
</dependency>
linux-ppc64le
<dependency>
 <groupId>org.bytedeco.javacpp-presets</groupId>
 <artifactId>openblas</artifactId>
 <classifier>linux-ppc64le</classifier>
</dependency>
<dependency>
 <groupId>org.nd4j</groupId>
 <artifactId>nd4j-native</artifactId> 
 <classifier>linux-ppc64le</classifier> 
</dependency>