12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415 |
- // Copyright 2020 gorse Project Authors
- //
- // Licensed under the Apache License, Version 2.0 (the "License");
- // you may not use this file except in compliance with the License.
- // You may obtain a copy of the License at
- //
- // http://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing, software
- // distributed under the License is distributed on an "AS IS" BASIS,
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- // See the License for the specific language governing permissions and
- // limitations under the License.
- package worker
- import (
- "context"
- "encoding/json"
- "fmt"
- "math"
- "math/rand"
- "net/http"
- "reflect"
- "strings"
- "time"
- mapset "github.com/deckarep/golang-set/v2"
- "github.com/juju/errors"
- "github.com/lafikl/consistent"
- cmap "github.com/orcaman/concurrent-map"
- "github.com/prometheus/client_golang/prometheus/promhttp"
- "github.com/samber/lo"
- "github.com/thoas/go-funk"
- "github.com/zhenghaoz/gorse/base"
- "github.com/zhenghaoz/gorse/base/encoding"
- "github.com/zhenghaoz/gorse/base/heap"
- "github.com/zhenghaoz/gorse/base/log"
- "github.com/zhenghaoz/gorse/base/parallel"
- "github.com/zhenghaoz/gorse/base/progress"
- "github.com/zhenghaoz/gorse/base/search"
- "github.com/zhenghaoz/gorse/base/sizeof"
- "github.com/zhenghaoz/gorse/cmd/version"
- "github.com/zhenghaoz/gorse/config"
- "github.com/zhenghaoz/gorse/model/click"
- "github.com/zhenghaoz/gorse/model/ranking"
- "github.com/zhenghaoz/gorse/protocol"
- "github.com/zhenghaoz/gorse/storage/cache"
- "github.com/zhenghaoz/gorse/storage/data"
- "go.uber.org/atomic"
- "go.uber.org/zap"
- "google.golang.org/grpc"
- "google.golang.org/grpc/credentials/insecure"
- "google.golang.org/protobuf/proto"
- )
- const (
- batchSize = 10000
- recommendComplexityFactor = 100
- )
- type ScheduleState struct {
- IsRunning bool `json:"is_running"`
- StartTime time.Time `json:"start_time"`
- }
- // Worker manages states of a worker node.
- type Worker struct {
- tracer *progress.Tracer
- oneMode bool
- testMode bool
- managedMode bool
- *config.Settings
- // spawned rankers
- rankers []click.FactorizationMachine
- // worker config
- jobs int
- workerName string
- httpHost string
- httpPort int
- masterHost string
- masterPort int
- cacheFile string
- // database connection path
- cachePath string
- cachePrefix string
- dataPath string
- dataPrefix string
- // master connection
- masterClient protocol.MasterClient
- latestRankingModelVersion int64
- latestClickModelVersion int64
- rankingIndex *search.HNSW
- randGenerator *rand.Rand
- // peers
- peers []string
- me string
- // scheduler state
- scheduleState ScheduleState
- // events
- tickDuration time.Duration
- ticker *time.Ticker
- syncedChan *parallel.ConditionChannel // meta synced events
- pulledChan *parallel.ConditionChannel // model pulled events
- triggerChan *parallel.ConditionChannel // manually triggered events
- }
- // NewWorker creates a new worker node.
- func NewWorker(masterHost string, masterPort int, httpHost string, httpPort, jobs int, cacheFile string, managedMode bool) *Worker {
- return &Worker{
- rankers: make([]click.FactorizationMachine, jobs),
- managedMode: managedMode,
- Settings: config.NewSettings(),
- randGenerator: base.NewRand(time.Now().UTC().UnixNano()),
- // config
- cacheFile: cacheFile,
- masterHost: masterHost,
- masterPort: masterPort,
- httpHost: httpHost,
- httpPort: httpPort,
- jobs: jobs,
- // events
- tickDuration: time.Minute,
- ticker: time.NewTicker(time.Minute),
- syncedChan: parallel.NewConditionChannel(),
- pulledChan: parallel.NewConditionChannel(),
- triggerChan: parallel.NewConditionChannel(),
- }
- }
- func (w *Worker) SetOneMode(settings *config.Settings) {
- w.oneMode = true
- w.Settings = settings
- }
- // Sync this worker to the master.
- func (w *Worker) Sync() {
- defer base.CheckPanic()
- log.Logger().Info("start meta sync", zap.Duration("meta_timeout", w.Config.Master.MetaTimeout))
- for {
- var meta *protocol.Meta
- var err error
- if meta, err = w.masterClient.GetMeta(context.Background(),
- &protocol.NodeInfo{
- NodeType: protocol.NodeType_WorkerNode,
- NodeName: w.workerName,
- HttpPort: int64(w.httpPort),
- BinaryVersion: version.Version,
- }); err != nil {
- log.Logger().Error("failed to get meta", zap.Error(err))
- goto sleep
- }
- // load master config
- w.Config.Recommend.Offline.Lock()
- err = json.Unmarshal([]byte(meta.Config), &w.Config)
- if err != nil {
- w.Config.Recommend.Offline.UnLock()
- log.Logger().Error("failed to parse master config", zap.Error(err))
- goto sleep
- }
- w.Config.Recommend.Offline.UnLock()
- // reset ticker
- if w.tickDuration != w.Config.Recommend.Offline.CheckRecommendPeriod {
- w.tickDuration = w.Config.Recommend.Offline.CheckRecommendPeriod
- w.ticker.Reset(w.Config.Recommend.Offline.CheckRecommendPeriod)
- }
- // connect to data store
- if w.dataPath != w.Config.Database.DataStore || w.dataPrefix != w.Config.Database.DataTablePrefix {
- log.Logger().Info("connect data store",
- zap.String("database", log.RedactDBURL(w.Config.Database.DataStore)))
- if w.DataClient, err = data.Open(w.Config.Database.DataStore, w.Config.Database.DataTablePrefix); err != nil {
- log.Logger().Error("failed to connect data store", zap.Error(err))
- goto sleep
- }
- w.dataPath = w.Config.Database.DataStore
- w.dataPrefix = w.Config.Database.DataTablePrefix
- }
- // connect to cache store
- if w.cachePath != w.Config.Database.CacheStore || w.cachePrefix != w.Config.Database.CacheTablePrefix {
- log.Logger().Info("connect cache store",
- zap.String("database", log.RedactDBURL(w.Config.Database.CacheStore)))
- if w.CacheClient, err = cache.Open(w.Config.Database.CacheStore, w.Config.Database.CacheTablePrefix); err != nil {
- log.Logger().Error("failed to connect cache store", zap.Error(err))
- goto sleep
- }
- w.cachePath = w.Config.Database.CacheStore
- w.cachePrefix = w.Config.Database.CacheTablePrefix
- }
- // check ranking model version
- w.latestRankingModelVersion = meta.RankingModelVersion
- if w.latestRankingModelVersion != w.RankingModelVersion {
- log.Logger().Info("new ranking model found",
- zap.String("old_version", encoding.Hex(w.RankingModelVersion)),
- zap.String("new_version", encoding.Hex(w.latestRankingModelVersion)))
- w.syncedChan.Signal()
- }
- // check click model version
- w.latestClickModelVersion = meta.ClickModelVersion
- if w.latestClickModelVersion != w.ClickModelVersion {
- log.Logger().Info("new click model found",
- zap.String("old_version", encoding.Hex(w.ClickModelVersion)),
- zap.String("new_version", encoding.Hex(w.latestClickModelVersion)))
- w.syncedChan.Signal()
- }
- w.peers = meta.Workers
- w.me = meta.Me
- sleep:
- if w.testMode {
- return
- }
- time.Sleep(w.Config.Master.MetaTimeout)
- }
- }
- // Pull user index and ranking model from master.
- func (w *Worker) Pull() {
- defer base.CheckPanic()
- for range w.syncedChan.C {
- pulled := false
- // pull ranking model
- if w.latestRankingModelVersion != w.RankingModelVersion {
- log.Logger().Info("start pull ranking model")
- if rankingModelReceiver, err := w.masterClient.GetRankingModel(context.Background(),
- &protocol.VersionInfo{Version: w.latestRankingModelVersion},
- grpc.MaxCallRecvMsgSize(math.MaxInt)); err != nil {
- log.Logger().Error("failed to pull ranking model", zap.Error(err))
- } else {
- var rankingModel ranking.MatrixFactorization
- rankingModel, err = protocol.UnmarshalRankingModel(rankingModelReceiver)
- if err != nil {
- log.Logger().Error("failed to unmarshal ranking model", zap.Error(err))
- } else {
- w.RankingModel = rankingModel
- w.rankingIndex = nil
- w.RankingModelVersion = w.latestRankingModelVersion
- log.Logger().Info("synced ranking model",
- zap.String("version", encoding.Hex(w.RankingModelVersion)))
- MemoryInuseBytesVec.WithLabelValues("collaborative_filtering_model").Set(float64(w.RankingModel.Bytes()))
- pulled = true
- }
- }
- }
- // pull click model
- if w.latestClickModelVersion != w.ClickModelVersion {
- log.Logger().Info("start pull click model")
- if clickModelReceiver, err := w.masterClient.GetClickModel(context.Background(),
- &protocol.VersionInfo{Version: w.latestClickModelVersion},
- grpc.MaxCallRecvMsgSize(math.MaxInt)); err != nil {
- log.Logger().Error("failed to pull click model", zap.Error(err))
- } else {
- var clickModel click.FactorizationMachine
- clickModel, err = protocol.UnmarshalClickModel(clickModelReceiver)
- if err != nil {
- log.Logger().Error("failed to unmarshal click model", zap.Error(err))
- } else {
- w.ClickModel = clickModel
- w.ClickModelVersion = w.latestClickModelVersion
- log.Logger().Info("synced click model",
- zap.String("version", encoding.Hex(w.ClickModelVersion)))
- MemoryInuseBytesVec.WithLabelValues("ranking_model").Set(float64(sizeof.DeepSize(w.ClickModel)))
- // spawn rankers
- for i := 0; i < w.jobs; i++ {
- if i == 0 {
- w.rankers[i] = w.ClickModel
- } else {
- w.rankers[i] = click.Spawn(w.ClickModel)
- }
- }
- pulled = true
- }
- }
- }
- if w.testMode {
- return
- }
- if pulled {
- w.pulledChan.Signal()
- }
- }
- }
- // ServeHTTP serves Prometheus metrics and API.
- func (w *Worker) ServeHTTP() {
- http.Handle("/metrics", promhttp.Handler())
- http.HandleFunc("/api/health/live", w.checkLive)
- http.HandleFunc("/api/admin/schedule", w.ScheduleAPIHandler)
- err := http.ListenAndServe(fmt.Sprintf("%s:%d", w.httpHost, w.httpPort), nil)
- if err != nil {
- log.Logger().Fatal("failed to start http server", zap.Error(err))
- }
- }
- func (w *Worker) ScheduleAPIHandler(writer http.ResponseWriter, request *http.Request) {
- if !w.checkAdmin(request) {
- writeError(writer, "unauthorized", http.StatusMethodNotAllowed)
- return
- }
- switch request.Method {
- case http.MethodGet:
- writer.WriteHeader(http.StatusOK)
- bytes, err := json.Marshal(w.scheduleState)
- if err != nil {
- writeError(writer, err.Error(), http.StatusInternalServerError)
- }
- if _, err = writer.Write(bytes); err != nil {
- writeError(writer, err.Error(), http.StatusInternalServerError)
- }
- case http.MethodPost:
- w.triggerChan.Signal()
- default:
- writeError(writer, "method not allowed", http.StatusMethodNotAllowed)
- }
- }
- func (w *Worker) checkAdmin(request *http.Request) bool {
- if w.Config.Master.AdminAPIKey == "" {
- return true
- }
- if request.FormValue("X-API-Key") == w.Config.Master.AdminAPIKey {
- return true
- }
- return false
- }
- func writeJSON(w http.ResponseWriter, content any) {
- w.WriteHeader(http.StatusOK)
- bytes, err := json.Marshal(content)
- if err != nil {
- writeError(w, err.Error(), http.StatusInternalServerError)
- }
- if _, err = w.Write(bytes); err != nil {
- writeError(w, err.Error(), http.StatusInternalServerError)
- }
- }
- func writeError(w http.ResponseWriter, error string, code int) {
- log.Logger().Error(strings.ToLower(http.StatusText(code)), zap.String("error", error))
- http.Error(w, error, code)
- }
- // Serve as a worker node.
- func (w *Worker) Serve() {
- // open local store
- if !w.oneMode {
- state, err := LoadLocalCache(w.cacheFile)
- if err != nil {
- if errors.Is(err, errors.NotFound) {
- log.Logger().Info("no cache file found, create a new one", zap.String("path", state.path))
- } else {
- log.Logger().Error("failed to load persist state", zap.Error(err),
- zap.String("path", w.cacheFile))
- }
- }
- if state.WorkerName == "" {
- state.WorkerName = base.GetRandomName(0)
- err = state.WriteLocalCache()
- if err != nil {
- log.Logger().Fatal("failed to write meta", zap.Error(err))
- }
- }
- w.workerName = state.WorkerName
- log.Logger().Info("start worker",
- zap.Bool("managed", w.managedMode),
- zap.Int("n_jobs", w.jobs),
- zap.String("worker_name", w.workerName))
- }
- // create progress tracer
- w.tracer = progress.NewTracer(w.workerName)
- // connect to master
- conn, err := grpc.Dial(fmt.Sprintf("%v:%v", w.masterHost, w.masterPort), grpc.WithTransportCredentials(insecure.NewCredentials()))
- if err != nil {
- log.Logger().Fatal("failed to connect master", zap.Error(err))
- }
- w.masterClient = protocol.NewMasterClient(conn)
- if w.oneMode {
- w.peers = []string{w.workerName}
- w.me = w.workerName
- } else {
- go w.Sync()
- go w.Pull()
- go w.ServeHTTP()
- }
- loop := func() {
- w.scheduleState.IsRunning = true
- w.scheduleState.StartTime = time.Now()
- defer func() {
- w.scheduleState.IsRunning = false
- w.scheduleState.StartTime = time.Time{}
- }()
- // pull users
- workingUsers, err := w.pullUsers(w.peers, w.me)
- if err != nil {
- log.Logger().Error("failed to split users", zap.Error(err),
- zap.String("me", w.me),
- zap.Strings("workers", w.peers))
- return
- }
- // recommendation
- w.Recommend(workingUsers)
- }
- if w.managedMode {
- for range w.triggerChan.C {
- loop()
- }
- } else {
- for {
- select {
- case tick := <-w.ticker.C:
- if time.Since(tick) < w.Config.Recommend.Offline.CheckRecommendPeriod {
- loop()
- }
- case <-w.pulledChan.C:
- loop()
- }
- }
- }
- }
- // Recommend items to users. The workflow of recommendation is:
- // 1. Skip inactive users.
- // 2. Load historical items.
- // 3. Load positive items if KNN used.
- // 4. Generate recommendation.
- // 5. Save result.
- // 6. Insert cold-start items into results.
- // 7. Rank items in results by click-through-rate.
- // 8. Refresh cache.
- func (w *Worker) Recommend(users []data.User) {
- ctx := context.Background()
- startRecommendTime := time.Now()
- log.Logger().Info("ranking recommendation",
- zap.Int("n_working_users", len(users)),
- zap.Int("n_jobs", w.jobs),
- zap.Int("cache_size", w.Config.Recommend.CacheSize))
- // pull items from database
- itemCache, itemCategories, err := w.pullItems(ctx)
- if err != nil {
- log.Logger().Error("failed to pull items", zap.Error(err))
- return
- }
- MemoryInuseBytesVec.WithLabelValues("item_cache").Set(float64(itemCache.Bytes()))
- defer MemoryInuseBytesVec.WithLabelValues("item_cache").Set(0)
- // progress tracker
- completed := make(chan struct{}, 1000)
- _, span := w.tracer.Start(context.Background(), "Recommend", len(users))
- defer span.End()
- go func() {
- defer base.CheckPanic()
- completedCount, previousCount := 0, 0
- ticker := time.NewTicker(10 * time.Second)
- for {
- select {
- case _, ok := <-completed:
- if !ok {
- return
- }
- completedCount++
- case <-ticker.C:
- throughput := completedCount - previousCount
- previousCount = completedCount
- if throughput > 0 {
- if w.masterClient != nil {
- span.Add(throughput)
- }
- log.Logger().Info("ranking recommendation",
- zap.Int("n_complete_users", completedCount),
- zap.Int("n_working_users", len(users)),
- zap.Int("throughput", throughput))
- }
- if _, err := w.masterClient.PushProgress(context.Background(), protocol.EncodeProgress(w.tracer.List())); err != nil {
- log.Logger().Error("failed to report update task", zap.Error(err))
- }
- }
- }
- }()
- // build ranking index
- if w.RankingModel != nil && !w.RankingModel.Invalid() && w.rankingIndex == nil {
- if w.Config.Recommend.Collaborative.EnableIndex {
- startTime := time.Now()
- log.Logger().Info("start building ranking index")
- itemIndex := w.RankingModel.GetItemIndex()
- vectors := make([]search.Vector, itemIndex.Len())
- for i := int32(0); i < itemIndex.Len(); i++ {
- itemId := itemIndex.ToName(i)
- if itemCache.IsAvailable(itemId) {
- vectors[i] = search.NewDenseVector(w.RankingModel.GetItemFactor(i), itemCache.GetCategory(itemId), false)
- } else {
- vectors[i] = search.NewDenseVector(w.RankingModel.GetItemFactor(i), nil, true)
- }
- }
- builder := search.NewHNSWBuilder(vectors, w.Config.Recommend.CacheSize, w.jobs)
- var recall float32
- w.rankingIndex, recall = builder.Build(ctx, w.Config.Recommend.Collaborative.IndexRecall,
- w.Config.Recommend.Collaborative.IndexFitEpoch, false)
- CollaborativeFilteringIndexRecall.Set(float64(recall))
- if err = w.CacheClient.Set(ctx, cache.String(cache.Key(cache.GlobalMeta, cache.MatchingIndexRecall), encoding.FormatFloat32(recall))); err != nil {
- log.Logger().Error("failed to write meta", zap.Error(err))
- }
- log.Logger().Info("complete building ranking index",
- zap.Duration("build_time", time.Since(startTime)))
- } else {
- CollaborativeFilteringIndexRecall.Set(1)
- }
- }
- // recommendation
- startTime := time.Now()
- var (
- updateUserCount atomic.Float64
- collaborativeRecommendSeconds atomic.Float64
- userBasedRecommendSeconds atomic.Float64
- itemBasedRecommendSeconds atomic.Float64
- latestRecommendSeconds atomic.Float64
- popularRecommendSeconds atomic.Float64
- )
- userFeedbackCache := NewFeedbackCache(w, w.Config.Recommend.DataSource.PositiveFeedbackTypes...)
- defer MemoryInuseBytesVec.WithLabelValues("user_feedback_cache").Set(0)
- err = parallel.Parallel(len(users), w.jobs, func(workerId, jobId int) error {
- defer func() {
- completed <- struct{}{}
- }()
- user := users[jobId]
- userId := user.UserId
- // skip inactive users before max recommend period
- if !w.checkUserActiveTime(ctx, userId) || !w.checkRecommendCacheTimeout(ctx, userId, itemCategories) {
- return nil
- }
- updateUserCount.Add(1)
- // load historical items
- historyItems, feedbacks, err := w.loadUserHistoricalItems(w.DataClient, userId)
- excludeSet := mapset.NewSet(historyItems...)
- if err != nil {
- log.Logger().Error("failed to pull user feedback",
- zap.String("user_id", userId), zap.Error(err))
- return errors.Trace(err)
- }
- // load positive items
- var positiveItems []string
- if w.Config.Recommend.Offline.EnableItemBasedRecommend {
- positiveItems, err = userFeedbackCache.GetUserFeedback(ctx, userId)
- if err != nil {
- log.Logger().Error("failed to pull user feedback",
- zap.String("user_id", userId), zap.Error(err))
- return errors.Trace(err)
- }
- MemoryInuseBytesVec.WithLabelValues("user_feedback_cache").Set(float64(userFeedbackCache.Bytes()))
- }
- // create candidates container
- candidates := make(map[string][][]string)
- candidates[""] = make([][]string, 0)
- for _, category := range itemCategories {
- candidates[category] = make([][]string, 0)
- }
- // Recommender #1: collaborative filtering.
- collaborativeUsed := false
- if w.Config.Recommend.Offline.EnableColRecommend && w.RankingModel != nil && !w.RankingModel.Invalid() {
- if userIndex := w.RankingModel.GetUserIndex().ToNumber(userId); w.RankingModel.IsUserPredictable(userIndex) {
- var recommend map[string][]string
- var usedTime time.Duration
- if w.Config.Recommend.Collaborative.EnableIndex && w.rankingIndex != nil {
- recommend, usedTime, err = w.collaborativeRecommendHNSW(w.rankingIndex, userId, itemCategories, excludeSet, itemCache)
- } else {
- recommend, usedTime, err = w.collaborativeRecommendBruteForce(userId, itemCategories, excludeSet, itemCache)
- }
- if err != nil {
- log.Logger().Error("failed to recommend by collaborative filtering",
- zap.String("user_id", userId), zap.Error(err))
- return errors.Trace(err)
- }
- for category, items := range recommend {
- candidates[category] = append(candidates[category], items)
- }
- collaborativeUsed = true
- collaborativeRecommendSeconds.Add(usedTime.Seconds())
- } else if !w.RankingModel.IsUserPredictable(userIndex) {
- log.Logger().Debug("user is unpredictable", zap.String("user_id", userId))
- }
- } else if w.RankingModel == nil || w.RankingModel.Invalid() {
- log.Logger().Debug("no collaborative filtering model")
- }
- // Recommender #2: item-based.
- itemNeighborDigests := mapset.NewSet[string]()
- if w.Config.Recommend.Offline.EnableItemBasedRecommend {
- localStartTime := time.Now()
- for _, category := range append([]string{""}, itemCategories...) {
- // collect candidates
- scores := make(map[string]float64)
- for _, itemId := range positiveItems {
- // load similar items
- similarItems, err := w.CacheClient.SearchDocuments(ctx, cache.ItemNeighbors, itemId, []string{category}, 0, w.Config.Recommend.CacheSize)
- if err != nil {
- log.Logger().Error("failed to load similar items", zap.Error(err))
- return errors.Trace(err)
- }
- // add unseen items
- for _, item := range similarItems {
- if !excludeSet.Contains(item.Id) && itemCache.IsAvailable(item.Id) {
- scores[item.Id] += item.Score
- }
- }
- // load item neighbors digest
- digest, err := w.CacheClient.Get(ctx, cache.Key(cache.ItemNeighborsDigest, itemId)).String()
- if err != nil {
- if !errors.Is(err, errors.NotFound) {
- log.Logger().Error("failed to load item neighbors digest", zap.Error(err))
- return errors.Trace(err)
- }
- }
- itemNeighborDigests.Add(digest)
- }
- // collect top k
- filter := heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
- for id, score := range scores {
- filter.Push(id, score)
- }
- ids, _ := filter.PopAll()
- candidates[category] = append(candidates[category], ids)
- }
- itemBasedRecommendSeconds.Add(time.Since(localStartTime).Seconds())
- }
- // Recommender #3: insert user-based items
- userNeighborDigests := mapset.NewSet[string]()
- if w.Config.Recommend.Offline.EnableUserBasedRecommend {
- localStartTime := time.Now()
- scores := make(map[string]float64)
- // load similar users
- similarUsers, err := w.CacheClient.SearchDocuments(ctx, cache.UserNeighbors, userId, []string{""}, 0, w.Config.Recommend.CacheSize)
- if err != nil {
- log.Logger().Error("failed to load similar users", zap.Error(err))
- return errors.Trace(err)
- }
- for _, user := range similarUsers {
- // load historical feedback
- similarUserPositiveItems, err := userFeedbackCache.GetUserFeedback(ctx, user.Id)
- if err != nil {
- log.Logger().Error("failed to pull user feedback",
- zap.String("user_id", userId), zap.Error(err))
- return errors.Trace(err)
- }
- MemoryInuseBytesVec.WithLabelValues("user_feedback_cache").Set(float64(userFeedbackCache.Bytes()))
- // add unseen items
- for _, itemId := range similarUserPositiveItems {
- if !excludeSet.Contains(itemId) && itemCache.IsAvailable(itemId) {
- scores[itemId] += user.Score
- }
- }
- // load user neighbors digest
- digest, err := w.CacheClient.Get(ctx, cache.Key(cache.UserNeighborsDigest, user.Id)).String()
- if err != nil {
- if !errors.Is(err, errors.NotFound) {
- log.Logger().Error("failed to load user neighbors digest", zap.Error(err))
- return errors.Trace(err)
- }
- }
- userNeighborDigests.Add(digest)
- }
- // collect top k
- filters := make(map[string]*heap.TopKFilter[string, float64])
- filters[""] = heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
- for _, category := range itemCategories {
- filters[category] = heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
- }
- for id, score := range scores {
- filters[""].Push(id, score)
- for _, category := range itemCache.GetCategory(id) {
- filters[category].Push(id, score)
- }
- }
- for category, filter := range filters {
- ids, _ := filter.PopAll()
- candidates[category] = append(candidates[category], ids)
- }
- userBasedRecommendSeconds.Add(time.Since(localStartTime).Seconds())
- }
- // Recommender #4: latest items.
- if w.Config.Recommend.Offline.EnableLatestRecommend {
- localStartTime := time.Now()
- for _, category := range append([]string{""}, itemCategories...) {
- latestItems, err := w.CacheClient.SearchDocuments(ctx, cache.LatestItems, "", []string{category}, 0, w.Config.Recommend.CacheSize)
- if err != nil {
- log.Logger().Error("failed to load latest items", zap.Error(err))
- return errors.Trace(err)
- }
- var recommend []string
- for _, latestItem := range latestItems {
- if !excludeSet.Contains(latestItem.Id) && itemCache.IsAvailable(latestItem.Id) {
- recommend = append(recommend, latestItem.Id)
- }
- }
- candidates[category] = append(candidates[category], recommend)
- }
- latestRecommendSeconds.Add(time.Since(localStartTime).Seconds())
- }
- // Recommender #5: popular items.
- if w.Config.Recommend.Offline.EnablePopularRecommend {
- localStartTime := time.Now()
- for _, category := range append([]string{""}, itemCategories...) {
- popularItems, err := w.CacheClient.SearchDocuments(ctx, cache.PopularItems, "", []string{category}, 0, w.Config.Recommend.CacheSize)
- if err != nil {
- log.Logger().Error("failed to load popular items", zap.Error(err))
- return errors.Trace(err)
- }
- var recommend []string
- for _, popularItem := range popularItems {
- if !excludeSet.Contains(popularItem.Id) && itemCache.IsAvailable(popularItem.Id) {
- recommend = append(recommend, popularItem.Id)
- }
- }
- candidates[category] = append(candidates[category], recommend)
- }
- popularRecommendSeconds.Add(time.Since(localStartTime).Seconds())
- }
- // rank items from different recommenders
- // 1. If click-through rate prediction model is available, use it to rank items.
- // 2. If collaborative filtering model is available, use it to rank items.
- // 3. Otherwise, merge all recommenders' results randomly.
- ctrUsed := false
- results := make(map[string][]cache.Document)
- for category, catCandidates := range candidates {
- if w.Config.Recommend.Offline.EnableClickThroughPrediction && w.rankers[workerId] != nil && !w.rankers[workerId].Invalid() {
- results[category], err = w.rankByClickTroughRate(&user, catCandidates, itemCache, w.rankers[workerId])
- if err != nil {
- log.Logger().Error("failed to rank items", zap.Error(err))
- return errors.Trace(err)
- }
- ctrUsed = true
- } else if w.RankingModel != nil && !w.RankingModel.Invalid() &&
- w.RankingModel.IsUserPredictable(w.RankingModel.GetUserIndex().ToNumber(userId)) {
- results[category], err = w.rankByCollaborativeFiltering(userId, catCandidates)
- if err != nil {
- log.Logger().Error("failed to rank items", zap.Error(err))
- return errors.Trace(err)
- }
- } else {
- results[category] = w.mergeAndShuffle(catCandidates)
- }
- }
- // replacement
- if w.Config.Recommend.Replacement.EnableReplacement {
- if results, err = w.replacement(results, &user, feedbacks, itemCache); err != nil {
- log.Logger().Error("failed to replace items", zap.Error(err))
- return errors.Trace(err)
- }
- }
- // explore latest and popular
- recommendTime := time.Now()
- aggregator := cache.NewDocumentAggregator(recommendTime)
- for category, result := range results {
- scores, err := w.exploreRecommend(result, excludeSet, category)
- if err != nil {
- log.Logger().Error("failed to explore latest and popular items", zap.Error(err))
- return errors.Trace(err)
- }
- aggregator.Add(category, lo.Map(scores, func(document cache.Document, _ int) string {
- return document.Id
- }), lo.Map(scores, func(document cache.Document, _ int) float64 {
- return document.Score
- }))
- }
- if err = w.CacheClient.AddDocuments(ctx, cache.OfflineRecommend, userId, aggregator.ToSlice()); err != nil {
- log.Logger().Error("failed to cache recommendation", zap.Error(err))
- return errors.Trace(err)
- }
- if err = w.CacheClient.Set(
- ctx,
- cache.Time(cache.Key(cache.LastUpdateUserRecommendTime, userId), recommendTime),
- cache.String(cache.Key(cache.OfflineRecommendDigest, userId), w.Config.OfflineRecommendDigest(
- config.WithCollaborative(collaborativeUsed),
- config.WithRanking(ctrUsed),
- config.WithItemNeighborDigest(strings.Join(itemNeighborDigests.ToSlice(), "-")),
- config.WithUserNeighborDigest(strings.Join(userNeighborDigests.ToSlice(), "-")),
- ))); err != nil {
- log.Logger().Error("failed to cache recommendation time", zap.Error(err))
- }
- return nil
- })
- close(completed)
- if err != nil {
- log.Logger().Error("failed to continue offline recommendation", zap.Error(err))
- return
- }
- log.Logger().Info("complete ranking recommendation",
- zap.String("used_time", time.Since(startTime).String()))
- UpdateUserRecommendTotal.Set(updateUserCount.Load())
- OfflineRecommendTotalSeconds.Set(time.Since(startRecommendTime).Seconds())
- OfflineRecommendStepSecondsVec.WithLabelValues("collaborative_recommend").Set(collaborativeRecommendSeconds.Load())
- OfflineRecommendStepSecondsVec.WithLabelValues("item_based_recommend").Set(itemBasedRecommendSeconds.Load())
- OfflineRecommendStepSecondsVec.WithLabelValues("user_based_recommend").Set(userBasedRecommendSeconds.Load())
- OfflineRecommendStepSecondsVec.WithLabelValues("latest_recommend").Set(latestRecommendSeconds.Load())
- OfflineRecommendStepSecondsVec.WithLabelValues("popular_recommend").Set(popularRecommendSeconds.Load())
- }
- func (w *Worker) collaborativeRecommendBruteForce(userId string, itemCategories []string, excludeSet mapset.Set[string], itemCache *ItemCache) (map[string][]string, time.Duration, error) {
- ctx := context.Background()
- userIndex := w.RankingModel.GetUserIndex().ToNumber(userId)
- itemIds := w.RankingModel.GetItemIndex().GetNames()
- localStartTime := time.Now()
- recItemsFilters := make(map[string]*heap.TopKFilter[string, float64])
- recItemsFilters[""] = heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
- for _, category := range itemCategories {
- recItemsFilters[category] = heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
- }
- for itemIndex, itemId := range itemIds {
- if !excludeSet.Contains(itemId) && itemCache.IsAvailable(itemId) && w.RankingModel.IsItemPredictable(int32(itemIndex)) {
- prediction := w.RankingModel.InternalPredict(userIndex, int32(itemIndex))
- recItemsFilters[""].Push(itemId, float64(prediction))
- for _, category := range itemCache.GetCategory(itemId) {
- recItemsFilters[category].Push(itemId, float64(prediction))
- }
- }
- }
- // save result
- recommend := make(map[string][]string)
- aggregator := cache.NewDocumentAggregator(localStartTime)
- for category, recItemsFilter := range recItemsFilters {
- recommendItems, recommendScores := recItemsFilter.PopAll()
- recommend[category] = recommendItems
- aggregator.Add(category, recommendItems, recommendScores)
- }
- if err := w.CacheClient.AddDocuments(ctx, cache.CollaborativeRecommend, userId, aggregator.ToSlice()); err != nil {
- log.Logger().Error("failed to cache collaborative filtering recommendation result", zap.String("user_id", userId), zap.Error(err))
- return nil, 0, errors.Trace(err)
- }
- if err := w.CacheClient.DeleteDocuments(ctx, []string{cache.CollaborativeRecommend}, cache.DocumentCondition{Before: &localStartTime}); err != nil {
- log.Logger().Error("failed to delete stale collaborative filtering recommendation result", zap.String("user_id", userId), zap.Error(err))
- return nil, 0, errors.Trace(err)
- }
- return recommend, time.Since(localStartTime), nil
- }
- func (w *Worker) collaborativeRecommendHNSW(rankingIndex *search.HNSW, userId string, itemCategories []string, excludeSet mapset.Set[string], itemCache *ItemCache) (map[string][]string, time.Duration, error) {
- ctx := context.Background()
- userIndex := w.RankingModel.GetUserIndex().ToNumber(userId)
- localStartTime := time.Now()
- values, scores := rankingIndex.MultiSearch(search.NewDenseVector(w.RankingModel.GetUserFactor(userIndex), nil, false),
- itemCategories, w.Config.Recommend.CacheSize+excludeSet.Cardinality(), false)
- // save result
- recommend := make(map[string][]string)
- aggregator := cache.NewDocumentAggregator(localStartTime)
- for category, catValues := range values {
- recommendItems := make([]string, 0, len(catValues))
- recommendScores := make([]float64, 0, len(catValues))
- for i := range catValues {
- itemId := w.RankingModel.GetItemIndex().ToName(catValues[i])
- if !excludeSet.Contains(itemId) && itemCache.IsAvailable(itemId) {
- recommendItems = append(recommendItems, itemId)
- recommendScores = append(recommendScores, float64(scores[category][i]))
- }
- }
- recommend[category] = recommendItems
- aggregator.Add(category, recommendItems, recommendScores)
- }
- if err := w.CacheClient.AddDocuments(ctx, cache.CollaborativeRecommend, userId, aggregator.ToSlice()); err != nil {
- log.Logger().Error("failed to cache collaborative filtering recommendation result", zap.String("user_id", userId), zap.Error(err))
- return nil, 0, errors.Trace(err)
- }
- if err := w.CacheClient.DeleteDocuments(ctx, []string{cache.CollaborativeRecommend}, cache.DocumentCondition{Before: &localStartTime}); err != nil {
- log.Logger().Error("failed to delete stale collaborative filtering recommendation result", zap.String("user_id", userId), zap.Error(err))
- return nil, 0, errors.Trace(err)
- }
- return recommend, time.Since(localStartTime), nil
- }
- func (w *Worker) rankByCollaborativeFiltering(userId string, candidates [][]string) ([]cache.Document, error) {
- // concat candidates
- memo := mapset.NewSet[string]()
- var itemIds []string
- for _, v := range candidates {
- for _, itemId := range v {
- if !memo.Contains(itemId) {
- memo.Add(itemId)
- itemIds = append(itemIds, itemId)
- }
- }
- }
- // rank by collaborative filtering
- topItems := make([]cache.Document, 0, len(candidates))
- for _, itemId := range itemIds {
- topItems = append(topItems, cache.Document{
- Id: itemId,
- Score: float64(w.RankingModel.Predict(userId, itemId)),
- })
- }
- cache.SortDocuments(topItems)
- return topItems, nil
- }
- // rankByClickTroughRate ranks items by predicted click-through-rate.
- func (w *Worker) rankByClickTroughRate(user *data.User, candidates [][]string, itemCache *ItemCache, predictor click.FactorizationMachine) ([]cache.Document, error) {
- // concat candidates
- memo := mapset.NewSet[string]()
- var itemIds []string
- for _, v := range candidates {
- for _, itemId := range v {
- if !memo.Contains(itemId) {
- memo.Add(itemId)
- itemIds = append(itemIds, itemId)
- }
- }
- }
- // download items
- items := make([]*data.Item, 0, len(itemIds))
- for _, itemId := range itemIds {
- if item, exist := itemCache.Get(itemId); exist {
- items = append(items, item)
- } else {
- log.Logger().Warn("item doesn't exists in database", zap.String("item_id", itemId))
- }
- }
- // rank by CTR
- topItems := make([]cache.Document, 0, len(items))
- if batchPredictor, ok := predictor.(click.BatchInference); ok {
- inputs := make([]lo.Tuple4[string, string, []click.Feature, []click.Feature], len(items))
- for i, item := range items {
- inputs[i].A = user.UserId
- inputs[i].B = item.ItemId
- inputs[i].C = click.ConvertLabelsToFeatures(user.Labels)
- inputs[i].D = click.ConvertLabelsToFeatures(item.Labels)
- }
- output := batchPredictor.BatchPredict(inputs)
- for i, score := range output {
- topItems = append(topItems, cache.Document{
- Id: items[i].ItemId,
- Score: float64(score),
- })
- }
- } else {
- for _, item := range items {
- topItems = append(topItems, cache.Document{
- Id: item.ItemId,
- Score: float64(predictor.Predict(user.UserId, item.ItemId, click.ConvertLabelsToFeatures(user.Labels), click.ConvertLabelsToFeatures(item.Labels))),
- })
- }
- }
- cache.SortDocuments(topItems)
- return topItems, nil
- }
- func (w *Worker) mergeAndShuffle(candidates [][]string) []cache.Document {
- memo := mapset.NewSet[string]()
- pos := make([]int, len(candidates))
- var recommend []cache.Document
- for {
- // filter out ended slice
- var src []int
- for i := range candidates {
- if pos[i] < len(candidates[i]) {
- src = append(src, i)
- }
- }
- if len(src) == 0 {
- break
- }
- // select a slice randomly
- j := src[w.randGenerator.Intn(len(src))]
- candidateId := candidates[j][pos[j]]
- pos[j]++
- if !memo.Contains(candidateId) {
- memo.Add(candidateId)
- recommend = append(recommend, cache.Document{Score: math.Exp(float64(-len(recommend))), Id: candidateId})
- }
- }
- return recommend
- }
- func (w *Worker) exploreRecommend(exploitRecommend []cache.Document, excludeSet mapset.Set[string], category string) ([]cache.Document, error) {
- var localExcludeSet mapset.Set[string]
- ctx := context.Background()
- if w.Config.Recommend.Replacement.EnableReplacement {
- localExcludeSet = mapset.NewSet[string]()
- } else {
- localExcludeSet = excludeSet.Clone()
- }
- // create thresholds
- explorePopularThreshold := 0.0
- if threshold, exist := w.Config.Recommend.Offline.GetExploreRecommend("popular"); exist {
- explorePopularThreshold = threshold
- }
- exploreLatestThreshold := explorePopularThreshold
- if threshold, exist := w.Config.Recommend.Offline.GetExploreRecommend("latest"); exist {
- exploreLatestThreshold += threshold
- }
- // load popular items
- popularItems, err := w.CacheClient.SearchDocuments(ctx, cache.PopularItems, "", []string{category}, 0, w.Config.Recommend.CacheSize)
- if err != nil {
- return nil, errors.Trace(err)
- }
- // load the latest items
- latestItems, err := w.CacheClient.SearchDocuments(ctx, cache.LatestItems, "", []string{category}, 0, w.Config.Recommend.CacheSize)
- if err != nil {
- return nil, errors.Trace(err)
- }
- // explore recommendation
- var exploreRecommend []cache.Document
- score := 1.0
- if len(exploitRecommend) > 0 {
- score += exploitRecommend[0].Score
- }
- for range exploitRecommend {
- dice := w.randGenerator.Float64()
- var recommendItem cache.Document
- if dice < explorePopularThreshold && len(popularItems) > 0 {
- score -= 1e-5
- recommendItem.Id = popularItems[0].Id
- recommendItem.Score = score
- popularItems = popularItems[1:]
- } else if dice < exploreLatestThreshold && len(latestItems) > 0 {
- score -= 1e-5
- recommendItem.Id = latestItems[0].Id
- recommendItem.Score = score
- latestItems = latestItems[1:]
- } else if len(exploitRecommend) > 0 {
- recommendItem = exploitRecommend[0]
- exploitRecommend = exploitRecommend[1:]
- score = recommendItem.Score
- } else {
- break
- }
- if !localExcludeSet.Contains(recommendItem.Id) {
- localExcludeSet.Add(recommendItem.Id)
- exploreRecommend = append(exploreRecommend, recommendItem)
- }
- }
- return exploreRecommend, nil
- }
- func (w *Worker) checkUserActiveTime(ctx context.Context, userId string) bool {
- if w.Config.Recommend.ActiveUserTTL == 0 {
- return true
- }
- // read active time
- activeTime, err := w.CacheClient.Get(ctx, cache.Key(cache.LastModifyUserTime, userId)).Time()
- if err != nil {
- if !errors.Is(err, errors.NotFound) {
- log.Logger().Error("failed to read last modify user time", zap.Error(err))
- }
- return true
- }
- // check active time
- if time.Since(activeTime) < time.Duration(w.Config.Recommend.ActiveUserTTL*24)*time.Hour {
- return true
- }
- // remove recommend cache for inactive users
- if err := w.CacheClient.DeleteDocuments(ctx, []string{cache.OfflineRecommend, cache.CollaborativeRecommend},
- cache.DocumentCondition{Subset: proto.String(userId)}); err != nil {
- log.Logger().Error("failed to delete recommend cache", zap.String("user_id", userId), zap.Error(err))
- }
- return false
- }
- // checkRecommendCacheTimeout checks if recommend cache stale.
- // 1. if cache is empty, stale.
- // 2. if active time > recommend time, stale.
- // 3. if recommend time + timeout < now, stale.
- func (w *Worker) checkRecommendCacheTimeout(ctx context.Context, userId string, categories []string) bool {
- var (
- activeTime time.Time
- recommendTime time.Time
- cacheDigest string
- err error
- )
- // check cache
- for _, category := range append([]string{""}, categories...) {
- items, err := w.CacheClient.SearchDocuments(ctx, cache.OfflineRecommend, userId, []string{category}, 0, -1)
- if err != nil {
- log.Logger().Error("failed to load offline recommendation", zap.String("user_id", userId), zap.Error(err))
- return true
- } else if len(items) == 0 {
- return true
- }
- }
- // read digest
- cacheDigest, err = w.CacheClient.Get(ctx, cache.Key(cache.OfflineRecommendDigest, userId)).String()
- if err != nil {
- if !errors.Is(err, errors.NotFound) {
- log.Logger().Error("failed to load offline recommendation digest", zap.String("user_id", userId), zap.Error(err))
- }
- return true
- }
- if cacheDigest != w.Config.OfflineRecommendDigest() {
- return true
- }
- // read active time
- activeTime, err = w.CacheClient.Get(ctx, cache.Key(cache.LastModifyUserTime, userId)).Time()
- if err != nil {
- if !errors.Is(err, errors.NotFound) {
- log.Logger().Error("failed to read last modify user time", zap.Error(err))
- }
- return true
- }
- // read recommend time
- recommendTime, err = w.CacheClient.Get(ctx, cache.Key(cache.LastUpdateUserRecommendTime, userId)).Time()
- if err != nil {
- if !errors.Is(err, errors.NotFound) {
- log.Logger().Error("failed to read last update user recommend time", zap.Error(err))
- }
- return true
- }
- // check cache expire
- if recommendTime.Before(time.Now().Add(-w.Config.Recommend.CacheExpire)) {
- return true
- }
- // check time
- if activeTime.Before(recommendTime) {
- timeoutTime := recommendTime.Add(w.Config.Recommend.Offline.RefreshRecommendPeriod)
- return timeoutTime.Before(time.Now())
- }
- return true
- }
- func (w *Worker) loadUserHistoricalItems(database data.Database, userId string) ([]string, []data.Feedback, error) {
- items := make([]string, 0)
- ctx := context.Background()
- feedbacks, err := database.GetUserFeedback(ctx, userId, w.Config.Now())
- if err != nil {
- return nil, nil, err
- }
- for _, feedback := range feedbacks {
- items = append(items, feedback.ItemId)
- }
- return items, feedbacks, nil
- }
- func (w *Worker) pullItems(ctx context.Context) (*ItemCache, []string, error) {
- // pull items from database
- itemCache := NewItemCache()
- itemCategories := mapset.NewSet[string]()
- itemChan, errChan := w.DataClient.GetItemStream(ctx, batchSize, nil)
- for batchItems := range itemChan {
- for _, item := range batchItems {
- itemCache.Set(item.ItemId, item)
- itemCategories.Append(item.Categories...)
- }
- }
- if err := <-errChan; err != nil {
- return nil, nil, errors.Trace(err)
- }
- return itemCache, itemCategories.ToSlice(), nil
- }
- func (w *Worker) pullUsers(peers []string, me string) ([]data.User, error) {
- ctx := context.Background()
- // locate me
- if !funk.ContainsString(peers, me) {
- return nil, errors.New("current node isn't in worker nodes")
- }
- // create consistent hash ring
- c := consistent.New()
- for _, peer := range peers {
- c.Add(peer)
- }
- // pull users from database
- var users []data.User
- userChan, errChan := w.DataClient.GetUserStream(ctx, batchSize)
- for batchUsers := range userChan {
- for _, user := range batchUsers {
- p, err := c.Get(user.UserId)
- if err != nil {
- return nil, errors.Trace(err)
- }
- if p == me {
- users = append(users, user)
- }
- }
- }
- if err := <-errChan; err != nil {
- return nil, errors.Trace(err)
- }
- return users, nil
- }
- // replacement inserts historical items back to recommendation.
- func (w *Worker) replacement(recommend map[string][]cache.Document, user *data.User, feedbacks []data.Feedback, itemCache *ItemCache) (map[string][]cache.Document, error) {
- upperBounds := make(map[string]float64)
- lowerBounds := make(map[string]float64)
- newRecommend := make(map[string][]cache.Document)
- for category, scores := range recommend {
- // find minimal score
- if len(scores) > 0 {
- s := lo.Map(scores, func(score cache.Document, _ int) float64 {
- return score.Score
- })
- upperBounds[category] = funk.MaxFloat64(s)
- lowerBounds[category] = funk.MinFloat64(s)
- } else {
- upperBounds[category] = math.Inf(1)
- lowerBounds[category] = math.Inf(-1)
- }
- // add scores to filters
- newRecommend[category] = append(newRecommend[category], scores...)
- }
- // remove duplicates
- positiveItems := mapset.NewSet[string]()
- distinctItems := mapset.NewSet[string]()
- for _, feedback := range feedbacks {
- if funk.ContainsString(w.Config.Recommend.DataSource.PositiveFeedbackTypes, feedback.FeedbackType) {
- positiveItems.Add(feedback.ItemId)
- distinctItems.Add(feedback.ItemId)
- } else if funk.ContainsString(w.Config.Recommend.DataSource.ReadFeedbackTypes, feedback.FeedbackType) {
- distinctItems.Add(feedback.ItemId)
- }
- }
- for _, itemId := range distinctItems.ToSlice() {
- if item, exist := itemCache.Get(itemId); exist {
- // scoring item
- // 1. If click-through rate prediction model is available, use it.
- // 2. If collaborative filtering model is available, use it.
- // 3. Otherwise, give a random score.
- var score float64
- if w.Config.Recommend.Offline.EnableClickThroughPrediction && w.ClickModel != nil {
- score = float64(w.ClickModel.Predict(user.UserId, itemId, click.ConvertLabelsToFeatures(user.Labels), click.ConvertLabelsToFeatures(item.Labels)))
- } else if w.RankingModel != nil && !w.RankingModel.Invalid() && w.RankingModel.IsUserPredictable(w.RankingModel.GetUserIndex().ToNumber(user.UserId)) {
- score = float64(w.RankingModel.Predict(user.UserId, itemId))
- } else {
- upper := upperBounds[""]
- lower := lowerBounds[""]
- if !math.IsInf(upper, 1) && !math.IsInf(lower, -1) {
- score = lower + w.randGenerator.Float64()*(upper-lower)
- } else {
- score = w.randGenerator.Float64()
- }
- }
- // replace item
- for _, category := range append([]string{""}, item.Categories...) {
- upperBound := upperBounds[category]
- lowerBound := lowerBounds[category]
- if !math.IsInf(upperBound, 1) && !math.IsInf(lowerBound, -1) {
- // decay item
- score -= lowerBound
- if score < 0 {
- continue
- } else if positiveItems.Contains(itemId) {
- score *= w.Config.Recommend.Replacement.PositiveReplacementDecay
- } else {
- score *= w.Config.Recommend.Replacement.ReadReplacementDecay
- }
- score += lowerBound
- }
- newRecommend[category] = append(newRecommend[category], cache.Document{Id: itemId, Score: score})
- }
- } else {
- log.Logger().Warn("item doesn't exists in database", zap.String("item_id", itemId))
- }
- }
- // rank items
- for _, r := range newRecommend {
- cache.SortDocuments(r)
- }
- return newRecommend, nil
- }
- type HealthStatus struct {
- DataStoreError error
- CacheStoreError error
- DataStoreConnected bool
- CacheStoreConnected bool
- }
- func (w *Worker) checkHealth() HealthStatus {
- healthStatus := HealthStatus{}
- healthStatus.DataStoreError = w.DataClient.Ping()
- healthStatus.CacheStoreError = w.CacheClient.Ping()
- healthStatus.DataStoreConnected = healthStatus.DataStoreError == nil
- healthStatus.CacheStoreConnected = healthStatus.CacheStoreError == nil
- return healthStatus
- }
- func (w *Worker) checkLive(writer http.ResponseWriter, _ *http.Request) {
- healthStatus := w.checkHealth()
- writeJSON(writer, healthStatus)
- }
- // ItemCache is alias of map[string]data.Item.
- type ItemCache struct {
- Data map[string]*data.Item
- ByteCount uintptr
- }
- func NewItemCache() *ItemCache {
- return &ItemCache{Data: make(map[string]*data.Item)}
- }
- func (c *ItemCache) Len() int {
- return len(c.Data)
- }
- func (c *ItemCache) Set(itemId string, item data.Item) {
- if _, exist := c.Data[itemId]; !exist {
- c.Data[itemId] = &item
- c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(itemId))
- c.ByteCount += reflect.TypeOf(item.ItemId).Size() * uintptr(len(itemId))
- c.ByteCount += reflect.TypeOf(item.Comment).Size() * uintptr(len(itemId))
- c.ByteCount += encoding.StringsBytes(item.Categories)
- c.ByteCount += reflect.TypeOf(item).Size()
- }
- }
- func (c *ItemCache) Get(itemId string) (*data.Item, bool) {
- item, exist := c.Data[itemId]
- return item, exist
- }
- func (c *ItemCache) GetCategory(itemId string) []string {
- if item, exist := c.Data[itemId]; exist {
- return item.Categories
- } else {
- return nil
- }
- }
- // IsAvailable means the item exists in database and is not hidden.
- func (c *ItemCache) IsAvailable(itemId string) bool {
- if item, exist := c.Data[itemId]; exist {
- return !item.IsHidden
- } else {
- return false
- }
- }
- func (c *ItemCache) Bytes() int {
- return int(c.ByteCount)
- }
- // FeedbackCache is the cache for user feedbacks.
- type FeedbackCache struct {
- *config.Config
- Client data.Database
- Types []string
- Cache cmap.ConcurrentMap
- ByteCount uintptr
- }
- // NewFeedbackCache creates a new FeedbackCache.
- func NewFeedbackCache(worker *Worker, feedbackTypes ...string) *FeedbackCache {
- return &FeedbackCache{
- Config: worker.Config,
- Client: worker.DataClient,
- Types: feedbackTypes,
- Cache: cmap.New(),
- }
- }
- // GetUserFeedback gets user feedback from cache or database.
- func (c *FeedbackCache) GetUserFeedback(ctx context.Context, userId string) ([]string, error) {
- if tmp, ok := c.Cache.Get(userId); ok {
- return tmp.([]string), nil
- } else {
- items := make([]string, 0)
- feedbacks, err := c.Client.GetUserFeedback(ctx, userId, c.Config.Now(), c.Types...)
- if err != nil {
- return nil, err
- }
- for _, feedback := range feedbacks {
- items = append(items, feedback.ItemId)
- c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(feedback.FeedbackType))
- c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(feedback.UserId))
- c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(feedback.ItemId))
- c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(feedback.Comment))
- }
- c.Cache.Set(userId, items)
- c.ByteCount += reflect.TypeOf(feedbacks).Elem().Size() * uintptr(len(feedbacks))
- c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(userId))
- return items, nil
- }
- }
- func (c *FeedbackCache) Bytes() int {
- return int(c.ByteCount)
- }
|