[MLEARN-12] DOC: YAML based periscope ranker system configuration Created: 21/Mar/19  Updated: 25/Apr/19  Resolved: 25/Apr/19

Status: Closed
Project: Machine Learning
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLPER-107 DOC: Lang. review of Periscope Result... Closed
relation
is related to MLEARN-10 Provide user-friendly way to configur... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: Foundation 8, Foundation 9
Story Points: 3

 Description   

Overview

Document how the Periscope ranking system can be configured now with a YAML file (as implemented on MLEARN-10).

The periscope ranker configuration has already been started on the page Periscope Result Ranker module (section Configuration).

Required content

The YAML configuration

  • Show how the YAML based configuration looks like
  • how the and where the default (coming with the module in the JAR file) can be overridden

Ranking strategies

Explain the different ranking strategies - This has already been started (in the context of MGNLPER-91).

 


 How to configure the size of networks (for findbar ml-based result ranking) will be tackled by the related ticket MGNLPER-92

 

 



 Comments   
Comment by Christoph Meier [ 03/Apr/19 ]

Possibilities to adjust the configuration:

The default config resides in periscope-result-ranker/src/main/resources/periscope-result-ranker/config.yaml (see http://tinyurl.com/yxaw73vu).

People can create:

  1. a file like this ${magnolia-resources.dir}/periscope-result-ranker/config.yaml (in a light-module named periscope-result-ranker).
  2. a hotfix with the resources app
Comment by Christoph Meier [ 25/Apr/19 ]

All done and fine.

We still miss one screenshot, but we will tackle this in the context of MGNLUI-5164. (It requires the integration of MGNLUI-5120).

Closing this ticket now.

Generated at Mon Feb 12 02:29:03 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.