Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The configuration data is read on startup and after it has been changed. The actual data is stored in the module’s configuration registry. You can look it up using the Definitions app in modules > periscope-result-ranker.

image


Note

If you change the outputUnits value, you must delete all existing network data (see Clearing Result Ranker memory).

Changing configuration with resources hotfix

  1. Open the Resource Files app.

  2. Browse to and select periscope-result-ranker > config.yaml.

  3. In the action bar, click Edit file. The Resource Files app creates a copy of the currently used configuration and stores it in the JCR resources workspace.

  4. Edit the file as necessary.
    imageImage Added

  5. Click Save changes.

Changing configuration using decoration

With decoration, you can adapt the currently used configuration (whether it is from a light module, hotfix or JAR file). To learn more about decoration, see Definition decoration concept.

A decorator file can reside in any Magnolia Maven module or any light module (see Definition decorator file location). In the example below, we will create a decorator file in a light module named test-module.

Within the light module, create the file decorations/periscope-result-ranker/config.yaml.

Code Block
title<magnolia.resources.dir>/test-module/decorations/periscope-result-ranker/config.yaml
outputUnits: 1000 rankingNetworkStorageStrategy: class: info.magnolia.periscope.rank.ml.jcr.JcrUserRoleNetworkStorageStrategy

Disabling result ranking

info.magnolia.periscope.ResultRankerConfiguration allows you to entirely disable the ranking of Find Bar search results. To do so, set disabled to true via decoration.

Code Block
title<your-light-module>/decorations/periscope-core/config.yaml
resultRankerConfiguration:
  disabled: true
Note

Alternatively, to minimize configuration actions, the same can be achieved if you download the following zip file and extract its contents into your resources directory:

disableRanker.zip

This can help you reduce memory usage or resolve potential compatibility issues with DL4J libraries.


Clearing Result Ranker memory

The Periscope Result Ranker module stores all user-based, role-based, and custom rankings in the JCR rankings workspace. The module creates one node for each memory unit.

Nodes for local (per-user) rankings are named after user names. Nodes for global (per-instance) rankings are named default-neural-network-rankings.

To clear the Result Ranker memory:

  1. Open the JCR app.

  2. Switch to the rankings workspace.

  3. Select the nodes you want to delete.

  4. In the action bar, click Delete item.