Josix is Only Joking

在 Elasticsearch 中使用 Learning to Rank Plugin 進行 Feature Engineering

September 04, 2021

什麼是 Learning to Rank

Learning to Rank 又稱為 Machine-Learned Ranking 為機器學習的任務之一,任務內容為給定可以透過評分(例如相關與否、回饋評分高低等)以進行排序的資料集,目標產生一個排序讓高分的項目位置在列表的越前面,反之不相關、低分的項目位置則在列表的後面。相較於回歸(Regression)問題,Learning to Rank 注重的是結果的排序,訓練時期給予每個排序項目的給分數值本身並不重要,最重要的是在於排序的順位。

Learning to Rank 經常使用在資訊檢索(Information Retrieval)的情境當中,透過給定的 query 、專家建立包含各個 query 檢索結果的給分列表( Judgement List)以及有助於提高相關性的特徵,如 query 出現的詞頻(Term Frequency)、詞數(Term Count)、檔案頻率(Document Frequency)、逆向檔案頻率(Inverse Document Frequency, IDF)、詞位置(Term Position)等數值以訓練模型,並將訓練好的模型應用於未來的檢索當中,達到更好的檢索結果。

Elasticsearch Learning to Rank (LTR) Plugin 提供功能

為了在 Elasticsearch 中進行 Learning to Rank 的任務,Elasticsearch LTR Plugin 主要提供的功能的主要功能如下:

  • 協助透過 Elasticsearch 既有功能建立特徵
  • 於 Elasticsearch 既有功能上建立其他特徵工程(Feature Engineering)
  • 紀錄特徵值以利下游任務套用如 XGBoost, LightGBM, Ranklib 等不同模型訓練
  • 接受訓練完成的模型,透過 Elasticsearch LTR 自定義的 DSL primitive 使該模型可以應用於 Elasticsearch 搜尋時使用,產出較好的排序結果。

特別要提到的是,Elasticsearch LTR 不提供模型訓練的功能,由於模型種類繁多並且效能依照不同領域也會有不同的呈現,因此 Elasticsearch LTR 保留此彈性讓使用者可以自行使用自己偏好的模型。另外,Elasticsearch LTR 也不提供 Judgement List 的生成,此列表也需要各個領域的專家進行標記,因此保留讓使用者自行建立。

如何使用 Elasticsearch Learning to Rank (LTR) Plugin

安裝 Elasticsearch LTR Plugin

安裝 Elasticsearch LTR 僅需要在已安裝好的 Elasticsearch 中安裝對應的 Elasticsearch LTR Plugin 版本即可:

./bin/elasticsearch-plugin install https://github.com/o19s/elasticsearch-learning-to-rank/releases/download/v1.5.4-es7.11.2/ltr-plugin-v1.5.4-es7.11.2.zip

其他版本對應可以參考 Elasticsearch LTR Release History

若使用 Open Distro for Elasticsearch 可以參考 Open Distro for Elasticsearch Version History 找尋對應的 Elasticsearch 版本再找到對應的 Elasticsearch LTR 版本下載即可。

如何在 Elasticsearch LTR 新增特徵

在 Elasticsearch LTR 中所有特徵存放的層級為 feature store > feature sets > features

Feature Store

以 Elasticsearch 的 Index 實作, 用於儲存特徵和上傳模型的 metadata, 在使用 Elasticsearch LTR 之前,首先必須建立預設 feature store,透過 _ltr API 可以建立預設 feature store:

PUT _ltr

若需要重新建立預設的 feature store,可以透過 DELETE 刪除後再重新建立:

DELETE _ltr

一般來說只會使用到一個 feature store,而不同的特徵會以 feature set 管理,若需要多個 feature store 可以參閱 Multiple Feature Stores

Feature Set

Feature Set 是直接參與 Elasticsearch LTR 最重要的部分,是特徵值的集合,使用者可以依照模型不同、想要使用的特徵建立不同集合。

建立 Feature Set

建立一個 feature set 可以透過 POST _ltr/_featureset/<featureset_name>,payload 只需要帶入 feature set 名稱和所包含的特徵串列,範例如下:

POST _ltr/_featureset/more_movie_features
{
   "featureset": {
        "features": [
            {
                "name": "title_query",
                "params": [
                    "keywords"
                ],
                "template_language": "mustache",
                "template": {
                    "match": {
                        "title": "{{keywords}}"
                    }
                }
            },
            {
                "name": "title_query_boost",
                "params": [
                    "some_multiplier"
                ],
                "template_language": "derived_expressions",
                "template": "title_query * some_multiplier"
            },
            {
                "name": "custom_title_query_boost",
                "params": [
                    "some_multiplier"
                ],
                "template_language": "script_feature",
                "template": {
                    "lang": "painless",
                    "source": "params.feature_vector.get('title_query') * (long)params.some_multiplier",
                    "params": {
                        "some_multiplier": "some_multiplier"
                    }
                }
            }
        ]
   }
}

其中,feature 需要帶入的欄位如下:

  • name: 特徵的名稱,用於後續 logging 使用,所有的名稱必須是唯一的不可重複的。

  • template: 該 feature 所要執行的 query。由於所有的特徵都是基於 Elasticsearch query 執行後取得的,檢索結果中的分數便是訓練資料,因此所有 Elasticsearch query 都是可以作為特徵的,如 matchmulti_matchmatch_all 等都是合法可以使用的,特別是針對 document 屬性的 query 也可以透過 function_score 來獲得該計分:

    {
        "query": {
            "function_score": {
                "functions": {
                    "field": "rate_score"
                },
                "query": {
                    "match_all": {}
                }
            }
        }
    }

    也可以取得根據使用者距離計算與 query 相關性的分數:

    {
        "query": {
            "bool" : {
                "must" : {
                    "match_all" : {}
                },
                "filter" : {
                    "geo_distance" : {
                        "distance" : "200km",
                        "pin.location" : {
                            "lat" : {{users_lat}},
                            "lon" : {{users_lon}}
                        }
                    }
                }
            }
        }
    }
  • params: 可以見到如 {{keywords}}{{users_lat}}{{users_lon}} 等語法,這些為 Elasticsearch Search TemplateMustache 語法,透過 Search Template 可以將 params 中使用者加入的參數帶入至 search query 中。

  • template_language: 為 template 渲染的方式,共有 mustachederived_expressionscript_feature 三種,derived_expressionscript_feature 使用方式可參考 Derived Features

若需要加入 feature 至現有的 feature set 可以透過 POST /_ltr/_featureset/<feature_set_name>/_addfeatures

POST /_ltr/_featureset/my_featureset/_addfeatures
{
    "features": [{
        "name": "user_rating",
        "params": [],
        "template_language": "mustache",
        "template" : {
            "function_score": {
                "functions": {
                    "field": "vote_average"
                },
                "query": {
                    "match_all": {}
                }
            }
        }
    }]
}
取得 Feature Set 資訊

取得 feature set 的資訊可以透過 _ltr/_featureset API

GET _ltr/_featureset/<feature_set_name>

或取得所有 feature set 資訊

GET _ltr/_featureset

若需要針對字首過濾 feature set 可以透過帶入 prefix 參數

GET _ltr/_featureset?prefix=

刪除 feature set:

DELETE _ltr/_featureset/<feature_set_name>

Elasticsearch LTR 中的 Feature Enginnering

Elasticsearch LTR 提供了針對詞彙的基本特徵工程(Feature Engineering),並可以在這些特徵值上再計算統計數值。

使用方式為在 search query 中加入 Elasticsearch LTR 的 query primitive match_explorer,便可以替搜尋的 query 進行特定 term 相關統計,例如下方 query 會計算 ramborocky 的最高 document frequency:

POST tmdb/_search
{
    "query": {
        "match_explorer": {
            "type": "max_raw_df",
            "query": {
                "match": {
                    "title": "rambo rocky"
                }
            }
        }
    }
}

可以接受基本的統計數值如下:

  • raw_df: 計算給定 term 的 document frequency
  • classic_idf: 計算給定 term 的 IDF 值,其公式為 log((NUM_DOCS+1)/(raw_df+1) + 1)
  • raw_ttf: 計算給定 term 在所有文件中的總詞頻(total term frequency)
  • raw_tf: 計算給定 term 在單一文件中的詞頻(term frequency)
  • unique_terms_count: 計算給定 term 的數量。
  • raw_tp: 計算給定 term 位於文本的位置

而隨著下的 query term 越多,Elasticsearch LTR match_explorer 接受結合 maxminsumstddev 運算在取得的數值上,只需要在 type 中加入這些運算名稱當做 prefix 即可,如 max_raw_dfsum_classic_idfstddev_raw_tf 等。

raw_tp 只提供 minmaxavg 三種 prefix,分別針對在多個 query term 的情況下取得匹配到的 term 最小出現位置、匹配到的 term 最大出現位置以及所有匹配到的 term 平均位置,例如: query dance monkey 在 type min_raw_tp 分別在文本中 dance 匹配到的位置為 [2, 5, 9]monkey 匹配到的位置為 [1, 4] 因此取最小位置為 1 即 min_raw_tp 的值。

針對 Document 特定的特徵如 popularityrecency,可以透過 Elasticsearch function_score 來取得各個文件的分數,例如:

{
    "query": {
        "function_score": {
            "functions": [{
                "field_value_factor": {
                    "field": "vote_average",
                    "missing": 0
                }
            }],
            "query": {
                "match_all": {}
            }
        }
    }
}

透過 logging 取得特徵分數(Feature Score)

在上傳了 feature set 並選定好需要紀錄的特徵後,為了建立下游 Ranking 模型,我們需要在使用 Elasticsearch 搜尋的同時將想要紀錄的特徵值也丟紀錄起來,只需要透過 Elasticsearch LTR Plugin 提供的 sltr query 來達成:

sltr query 可用於指定要紀錄的 feature set 及要使用的 ranking model。針對要紀錄的 feature set 只需要在 Elasticsearch 的 search payload 中,加入 sltr query:

{
    "sltr": {
        "_name": "logged_featureset",
        "featureset": "more_movie_features",
        "params": {
            "keywords": "rambo"
        }
    }
}

其中須包含下列欄位:

  • _name: sltr query 的名稱,可參照 named query
  • featureset: LTR 要紀錄的 feature set 特徵值
  • params: feature 中 search template 使用到的參數要帶入的值

為了不影響 Elasticsearch scoring 效能,需要將 sltr query 加入至 filter 中,但實際上並沒有過濾任何文件,完整 query 如下:

{"query": {
      "bool": {
              "filter": [
              {
                  "terms": {
                      "_id": ["7555", "1370", "1369"]

                  }
              },
              {
                  "sltr": {
                      "_name": "logged_featureset",
                      "featureset": "more_movie_features",
                      "params": {
                          "keywords": "rambo"
                      }
              }}

          ]
  }
}}

最後需要啟動 LTR logging 功能以針對 sltr 中的 feature set 進行 logging。只需要透過 Elasticsearch LTR 提供的 logging extension,LTR 會依照提供的 named query 找到 sltr query 並執行該 feature set 的 template 為每份文件評分,並記錄下來至每份文件中:

"ext": {
    "ltr_log": {
        "log_specs": {
            "name": "log_entry1",
            "named_query": "logged_featureset"
        }
    }
}

ltr_log 會需要包含下列欄位:

  • name: log 的名稱
  • named_query: 對應 sltr query 的 named query 名稱

除此以外亦可以包涵以欄位:

  • rescore_index: sltr query 在 rescore 階段時會使用作為 record list query 的 index
  • missing_as_zero: 用 0 代表 missing featuer 的值(預設為 False)

rescore_indexnamed_query 須擇一設定,如此 logging 才可以確定 sltr query 的位置以達到 query 階段或 rescore 階段進行 logging。

完整的 payload 如下:

POST tmdb/_search
{
    "query": {
        "bool": {
            "filter": [
                {
                    "terms": {
                        "_id": ["7555", "1370", "1369"]
                    }
                },
                {
                    "sltr": {
                        "_name": "logged_featureset",
                        "featureset": "more_movie_features",
                        "params": {
                            "keywords": "rambo"
                        }
                }}
            ]
        }
    },
    "ext": {
        "ltr_log": {
            "log_specs": {
                "name": "log_entry1",
                "named_query": "logged_featureset"
            }
        }
    }
}

並會取得如下格式的 response:

{
    "_index": "tmdb",
    "_type": "movie",
    "_id": "1370",
    "_score": 20.291,
    "_source": {
        ...
    },
    "fields": {
        "_ltrlog": [
            {
                "log_entry1": [
                    {"name": "title_query"
                     "value": 9.510193},
                    {"name": "body_query
                     "value": 10.7808075}
                ]
            }
        ]
    },
    "matched_queries": [
        "logged_featureset"
    ]
}

最後便可以將這些取得的 featuer score 放入訓練集中。

其他功能

除了 feature enginnering 以外,Elasticsearch LTR 也提供模型上傳功能和結合 Elasticsearch 和模型使用。但由於實務上自己會選擇使用 Elasticsearch 作為輸出候選項目,再結合其他模型 ensemble 決定最終排序,因此比較不常使用便沒有列入筆記,有興趣的讀者可以參考 Uplading A Trained ModelSearch with LTR

Reference


Hi, I'm Josix 興趣是沒事把玩各式各樣的 FOSS ,喜愛專研技術、參與社群交流,有著各種天馬行空的 Idea 想去實現

Josix Wang © 2021