How to customize the ViSH Metrics

ViSH uses various metrics for different purposes such as calculating popularity scores, calculating quality scores and sorting search results by relevance to the search query. Different parameters of these metrics can be customized by a ViSH instance in order to give more importance to some criteria to the detriment of other criteria. This section describes the ViSH Metrics, the different parameters of these metrics that can be customized in a ViSH instance, and how to do this customization.

All customizable parameters of the ViSH metrics can be changed by using the application_config.yml file. Please, read the section "Setting up a ViSH instance: The application_config.yml file" before continuing.

All settings related to metrics should be included inside the metrics key of the application_config.yml file. In the following table, all the possible parameters that can be customized inside this key are described:

Key	Description	Default value
popularity (metrics[popularity])	Parameters of the metrics used by ViSH to calculate popularity scores. These are the scores used, among other things, to sort objects according to popularity.
popularity[resources]	Parameters of the metrics used to calculate popularity of resources that can be downloaded. All weights should sum to 1.
popularity[resources][w_fVisits]	Weight of the frequency of visits	0.6
popularity[resources][w_fLikes]	Weight of the frequency of likes	0.3
popularity[resources][w_fDownloads]	Weight of the frequency of downloads	0.1
popularity[non_downloadable_resources]	Parameters of the metrics used to calculate popularity of resources that cannot be downloaded (e.g. links). All weights should sum to 1.
popularity[non_downloadable_resources][w_fVisits]	Weight of the frequency of visits	0.7
popularity[non_downloadable_resources][w_fLikes]	Weight of the frequency of likes	0.3
popularity[users]	Parameters of the metrics used to calculate popularity of users. All weights should sum to 1.
popularity[users][w_followers]	Weight of the follower count	0.4
popularity[users][w_resources]	Weight of the popularity of the user's resources	0.6
popularity[events]	Parameters of the metrics used to calculate popularity of events. All weights should sum to 1.
popularity[events][w_fVisits]	Weight of the frequency of visits	0.7
popularity[events][w_fLikes]	Weight of the frequency of likes	0.3
popularity[timeWindowLength]	Length in months of the time window used to calculate the popularity scores of the objects	2
popularity[coefficients]	Coefficients to modify popularity scores based on object type. Coefficients should be within the range [0,1]
popularity[coefficients][resource]	Coefficient to modify resources popularity	1
popularity[coefficients][excursion]	Coefficient to modify excursions popularity	1
popularity[coefficients][user]	Coefficient to modify users popularity	1
popularity[coefficients][event]	Coefficient to modify events popularity	1
popularity[coefficients][category]	Coefficient to modify categories popularity	1
qscore (metrics[qscore])	Parameters of the metrics used by ViSH to calculate quality scores of the resources. These are the scores used, among other things, to sort objects according to quality. All weights should sum to 1.
qscore[w_reviewers]	Weight of the evaluations conducted by reviewers	0.6
qscore[w_users]	Weight of the evaluations conducted by end users	0.3
qscore[w_teachers]	Weight of the evaluations conducted by end users who are teachers	0.1
default_ranking (metrics[default_ranking])	Parameters of the metrics used by ViSH to sort objects by default. All weights should sum to 1.
default_ranking[w_popularity]	Weight of popularity scores	0.7
default_ranking[w_qscore]	Weight of quality scores	0.3
default_ranking[coefficients]	Coefficients to modify default ranking scores based on object type. Coefficients should be within the range [0,1]
default_ranking[coefficients][resource]	Coefficient to modify default ranking scores of resources	1
default_ranking[coefficients][excursion]	Coefficient to modify default ranking scores of excursions	1
default_ranking[coefficients][user]	Coefficient to modify default ranking scores of users	1
default_ranking[coefficients][event]	Coefficient to modify default ranking scores of events	1
default_ranking[coefficients][category]	Coefficient to modify default ranking scores of categories	1
relevance_ranking (metrics[relevance_ranking])	Parameters of the metrics used by ViSH to sort objects in the search services taking into account the relevance to the search query. Weights should sum to 1.
relevance_ranking[w_rquery]	Weight of the relevance to the search query	0.8
relevance_ranking[w_popularity]	Weight of popularity scores	0.1
relevance_ranking[w_qscore]	Weight of quality scores	0.1
relevance_ranking[rquery]	Parameters of the metrics used by ViSH to calculate the relevance to the search queries. These weights do not need to sum to 1.
relevance_ranking[rquery][w_title]	Weight of the 'title' metadata field. For users the 'name' metadata field is used instead of 'title'.	50
relevance_ranking[rquery][w_description]	Weight of the 'description' metadata field	1
relevance_ranking[rquery][w_tags]	Weight of the 'tags' metadata field (i.e. keywords)	40