worker.go 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415
  1. // Copyright 2020 gorse Project Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package worker
  15. import (
  16. "context"
  17. "encoding/json"
  18. "fmt"
  19. "math"
  20. "math/rand"
  21. "net/http"
  22. "reflect"
  23. "strings"
  24. "time"
  25. mapset "github.com/deckarep/golang-set/v2"
  26. "github.com/juju/errors"
  27. "github.com/lafikl/consistent"
  28. cmap "github.com/orcaman/concurrent-map"
  29. "github.com/prometheus/client_golang/prometheus/promhttp"
  30. "github.com/samber/lo"
  31. "github.com/thoas/go-funk"
  32. "github.com/zhenghaoz/gorse/base"
  33. "github.com/zhenghaoz/gorse/base/encoding"
  34. "github.com/zhenghaoz/gorse/base/heap"
  35. "github.com/zhenghaoz/gorse/base/log"
  36. "github.com/zhenghaoz/gorse/base/parallel"
  37. "github.com/zhenghaoz/gorse/base/progress"
  38. "github.com/zhenghaoz/gorse/base/search"
  39. "github.com/zhenghaoz/gorse/base/sizeof"
  40. "github.com/zhenghaoz/gorse/cmd/version"
  41. "github.com/zhenghaoz/gorse/config"
  42. "github.com/zhenghaoz/gorse/model/click"
  43. "github.com/zhenghaoz/gorse/model/ranking"
  44. "github.com/zhenghaoz/gorse/protocol"
  45. "github.com/zhenghaoz/gorse/storage/cache"
  46. "github.com/zhenghaoz/gorse/storage/data"
  47. "go.uber.org/atomic"
  48. "go.uber.org/zap"
  49. "google.golang.org/grpc"
  50. "google.golang.org/grpc/credentials/insecure"
  51. "google.golang.org/protobuf/proto"
  52. )
  53. const (
  54. batchSize = 10000
  55. recommendComplexityFactor = 100
  56. )
  57. type ScheduleState struct {
  58. IsRunning bool `json:"is_running"`
  59. StartTime time.Time `json:"start_time"`
  60. }
  61. // Worker manages states of a worker node.
  62. type Worker struct {
  63. tracer *progress.Tracer
  64. oneMode bool
  65. testMode bool
  66. managedMode bool
  67. *config.Settings
  68. // spawned rankers
  69. rankers []click.FactorizationMachine
  70. // worker config
  71. jobs int
  72. workerName string
  73. httpHost string
  74. httpPort int
  75. masterHost string
  76. masterPort int
  77. cacheFile string
  78. // database connection path
  79. cachePath string
  80. cachePrefix string
  81. dataPath string
  82. dataPrefix string
  83. // master connection
  84. masterClient protocol.MasterClient
  85. latestRankingModelVersion int64
  86. latestClickModelVersion int64
  87. rankingIndex *search.HNSW
  88. randGenerator *rand.Rand
  89. // peers
  90. peers []string
  91. me string
  92. // scheduler state
  93. scheduleState ScheduleState
  94. // events
  95. tickDuration time.Duration
  96. ticker *time.Ticker
  97. syncedChan *parallel.ConditionChannel // meta synced events
  98. pulledChan *parallel.ConditionChannel // model pulled events
  99. triggerChan *parallel.ConditionChannel // manually triggered events
  100. }
  101. // NewWorker creates a new worker node.
  102. func NewWorker(masterHost string, masterPort int, httpHost string, httpPort, jobs int, cacheFile string, managedMode bool) *Worker {
  103. return &Worker{
  104. rankers: make([]click.FactorizationMachine, jobs),
  105. managedMode: managedMode,
  106. Settings: config.NewSettings(),
  107. randGenerator: base.NewRand(time.Now().UTC().UnixNano()),
  108. // config
  109. cacheFile: cacheFile,
  110. masterHost: masterHost,
  111. masterPort: masterPort,
  112. httpHost: httpHost,
  113. httpPort: httpPort,
  114. jobs: jobs,
  115. // events
  116. tickDuration: time.Minute,
  117. ticker: time.NewTicker(time.Minute),
  118. syncedChan: parallel.NewConditionChannel(),
  119. pulledChan: parallel.NewConditionChannel(),
  120. triggerChan: parallel.NewConditionChannel(),
  121. }
  122. }
  123. func (w *Worker) SetOneMode(settings *config.Settings) {
  124. w.oneMode = true
  125. w.Settings = settings
  126. }
  127. // Sync this worker to the master.
  128. func (w *Worker) Sync() {
  129. defer base.CheckPanic()
  130. log.Logger().Info("start meta sync", zap.Duration("meta_timeout", w.Config.Master.MetaTimeout))
  131. for {
  132. var meta *protocol.Meta
  133. var err error
  134. if meta, err = w.masterClient.GetMeta(context.Background(),
  135. &protocol.NodeInfo{
  136. NodeType: protocol.NodeType_WorkerNode,
  137. NodeName: w.workerName,
  138. HttpPort: int64(w.httpPort),
  139. BinaryVersion: version.Version,
  140. }); err != nil {
  141. log.Logger().Error("failed to get meta", zap.Error(err))
  142. goto sleep
  143. }
  144. // load master config
  145. w.Config.Recommend.Offline.Lock()
  146. err = json.Unmarshal([]byte(meta.Config), &w.Config)
  147. if err != nil {
  148. w.Config.Recommend.Offline.UnLock()
  149. log.Logger().Error("failed to parse master config", zap.Error(err))
  150. goto sleep
  151. }
  152. w.Config.Recommend.Offline.UnLock()
  153. // reset ticker
  154. if w.tickDuration != w.Config.Recommend.Offline.CheckRecommendPeriod {
  155. w.tickDuration = w.Config.Recommend.Offline.CheckRecommendPeriod
  156. w.ticker.Reset(w.Config.Recommend.Offline.CheckRecommendPeriod)
  157. }
  158. // connect to data store
  159. if w.dataPath != w.Config.Database.DataStore || w.dataPrefix != w.Config.Database.DataTablePrefix {
  160. log.Logger().Info("connect data store",
  161. zap.String("database", log.RedactDBURL(w.Config.Database.DataStore)))
  162. if w.DataClient, err = data.Open(w.Config.Database.DataStore, w.Config.Database.DataTablePrefix); err != nil {
  163. log.Logger().Error("failed to connect data store", zap.Error(err))
  164. goto sleep
  165. }
  166. w.dataPath = w.Config.Database.DataStore
  167. w.dataPrefix = w.Config.Database.DataTablePrefix
  168. }
  169. // connect to cache store
  170. if w.cachePath != w.Config.Database.CacheStore || w.cachePrefix != w.Config.Database.CacheTablePrefix {
  171. log.Logger().Info("connect cache store",
  172. zap.String("database", log.RedactDBURL(w.Config.Database.CacheStore)))
  173. if w.CacheClient, err = cache.Open(w.Config.Database.CacheStore, w.Config.Database.CacheTablePrefix); err != nil {
  174. log.Logger().Error("failed to connect cache store", zap.Error(err))
  175. goto sleep
  176. }
  177. w.cachePath = w.Config.Database.CacheStore
  178. w.cachePrefix = w.Config.Database.CacheTablePrefix
  179. }
  180. // check ranking model version
  181. w.latestRankingModelVersion = meta.RankingModelVersion
  182. if w.latestRankingModelVersion != w.RankingModelVersion {
  183. log.Logger().Info("new ranking model found",
  184. zap.String("old_version", encoding.Hex(w.RankingModelVersion)),
  185. zap.String("new_version", encoding.Hex(w.latestRankingModelVersion)))
  186. w.syncedChan.Signal()
  187. }
  188. // check click model version
  189. w.latestClickModelVersion = meta.ClickModelVersion
  190. if w.latestClickModelVersion != w.ClickModelVersion {
  191. log.Logger().Info("new click model found",
  192. zap.String("old_version", encoding.Hex(w.ClickModelVersion)),
  193. zap.String("new_version", encoding.Hex(w.latestClickModelVersion)))
  194. w.syncedChan.Signal()
  195. }
  196. w.peers = meta.Workers
  197. w.me = meta.Me
  198. sleep:
  199. if w.testMode {
  200. return
  201. }
  202. time.Sleep(w.Config.Master.MetaTimeout)
  203. }
  204. }
  205. // Pull user index and ranking model from master.
  206. func (w *Worker) Pull() {
  207. defer base.CheckPanic()
  208. for range w.syncedChan.C {
  209. pulled := false
  210. // pull ranking model
  211. if w.latestRankingModelVersion != w.RankingModelVersion {
  212. log.Logger().Info("start pull ranking model")
  213. if rankingModelReceiver, err := w.masterClient.GetRankingModel(context.Background(),
  214. &protocol.VersionInfo{Version: w.latestRankingModelVersion},
  215. grpc.MaxCallRecvMsgSize(math.MaxInt)); err != nil {
  216. log.Logger().Error("failed to pull ranking model", zap.Error(err))
  217. } else {
  218. var rankingModel ranking.MatrixFactorization
  219. rankingModel, err = protocol.UnmarshalRankingModel(rankingModelReceiver)
  220. if err != nil {
  221. log.Logger().Error("failed to unmarshal ranking model", zap.Error(err))
  222. } else {
  223. w.RankingModel = rankingModel
  224. w.rankingIndex = nil
  225. w.RankingModelVersion = w.latestRankingModelVersion
  226. log.Logger().Info("synced ranking model",
  227. zap.String("version", encoding.Hex(w.RankingModelVersion)))
  228. MemoryInuseBytesVec.WithLabelValues("collaborative_filtering_model").Set(float64(w.RankingModel.Bytes()))
  229. pulled = true
  230. }
  231. }
  232. }
  233. // pull click model
  234. if w.latestClickModelVersion != w.ClickModelVersion {
  235. log.Logger().Info("start pull click model")
  236. if clickModelReceiver, err := w.masterClient.GetClickModel(context.Background(),
  237. &protocol.VersionInfo{Version: w.latestClickModelVersion},
  238. grpc.MaxCallRecvMsgSize(math.MaxInt)); err != nil {
  239. log.Logger().Error("failed to pull click model", zap.Error(err))
  240. } else {
  241. var clickModel click.FactorizationMachine
  242. clickModel, err = protocol.UnmarshalClickModel(clickModelReceiver)
  243. if err != nil {
  244. log.Logger().Error("failed to unmarshal click model", zap.Error(err))
  245. } else {
  246. w.ClickModel = clickModel
  247. w.ClickModelVersion = w.latestClickModelVersion
  248. log.Logger().Info("synced click model",
  249. zap.String("version", encoding.Hex(w.ClickModelVersion)))
  250. MemoryInuseBytesVec.WithLabelValues("ranking_model").Set(float64(sizeof.DeepSize(w.ClickModel)))
  251. // spawn rankers
  252. for i := 0; i < w.jobs; i++ {
  253. if i == 0 {
  254. w.rankers[i] = w.ClickModel
  255. } else {
  256. w.rankers[i] = click.Spawn(w.ClickModel)
  257. }
  258. }
  259. pulled = true
  260. }
  261. }
  262. }
  263. if w.testMode {
  264. return
  265. }
  266. if pulled {
  267. w.pulledChan.Signal()
  268. }
  269. }
  270. }
  271. // ServeHTTP serves Prometheus metrics and API.
  272. func (w *Worker) ServeHTTP() {
  273. http.Handle("/metrics", promhttp.Handler())
  274. http.HandleFunc("/api/health/live", w.checkLive)
  275. http.HandleFunc("/api/admin/schedule", w.ScheduleAPIHandler)
  276. err := http.ListenAndServe(fmt.Sprintf("%s:%d", w.httpHost, w.httpPort), nil)
  277. if err != nil {
  278. log.Logger().Fatal("failed to start http server", zap.Error(err))
  279. }
  280. }
  281. func (w *Worker) ScheduleAPIHandler(writer http.ResponseWriter, request *http.Request) {
  282. if !w.checkAdmin(request) {
  283. writeError(writer, "unauthorized", http.StatusMethodNotAllowed)
  284. return
  285. }
  286. switch request.Method {
  287. case http.MethodGet:
  288. writer.WriteHeader(http.StatusOK)
  289. bytes, err := json.Marshal(w.scheduleState)
  290. if err != nil {
  291. writeError(writer, err.Error(), http.StatusInternalServerError)
  292. }
  293. if _, err = writer.Write(bytes); err != nil {
  294. writeError(writer, err.Error(), http.StatusInternalServerError)
  295. }
  296. case http.MethodPost:
  297. w.triggerChan.Signal()
  298. default:
  299. writeError(writer, "method not allowed", http.StatusMethodNotAllowed)
  300. }
  301. }
  302. func (w *Worker) checkAdmin(request *http.Request) bool {
  303. if w.Config.Master.AdminAPIKey == "" {
  304. return true
  305. }
  306. if request.FormValue("X-API-Key") == w.Config.Master.AdminAPIKey {
  307. return true
  308. }
  309. return false
  310. }
  311. func writeJSON(w http.ResponseWriter, content any) {
  312. w.WriteHeader(http.StatusOK)
  313. bytes, err := json.Marshal(content)
  314. if err != nil {
  315. writeError(w, err.Error(), http.StatusInternalServerError)
  316. }
  317. if _, err = w.Write(bytes); err != nil {
  318. writeError(w, err.Error(), http.StatusInternalServerError)
  319. }
  320. }
  321. func writeError(w http.ResponseWriter, error string, code int) {
  322. log.Logger().Error(strings.ToLower(http.StatusText(code)), zap.String("error", error))
  323. http.Error(w, error, code)
  324. }
  325. // Serve as a worker node.
  326. func (w *Worker) Serve() {
  327. // open local store
  328. if !w.oneMode {
  329. state, err := LoadLocalCache(w.cacheFile)
  330. if err != nil {
  331. if errors.Is(err, errors.NotFound) {
  332. log.Logger().Info("no cache file found, create a new one", zap.String("path", state.path))
  333. } else {
  334. log.Logger().Error("failed to load persist state", zap.Error(err),
  335. zap.String("path", w.cacheFile))
  336. }
  337. }
  338. if state.WorkerName == "" {
  339. state.WorkerName = base.GetRandomName(0)
  340. err = state.WriteLocalCache()
  341. if err != nil {
  342. log.Logger().Fatal("failed to write meta", zap.Error(err))
  343. }
  344. }
  345. w.workerName = state.WorkerName
  346. log.Logger().Info("start worker",
  347. zap.Bool("managed", w.managedMode),
  348. zap.Int("n_jobs", w.jobs),
  349. zap.String("worker_name", w.workerName))
  350. }
  351. // create progress tracer
  352. w.tracer = progress.NewTracer(w.workerName)
  353. // connect to master
  354. conn, err := grpc.Dial(fmt.Sprintf("%v:%v", w.masterHost, w.masterPort), grpc.WithTransportCredentials(insecure.NewCredentials()))
  355. if err != nil {
  356. log.Logger().Fatal("failed to connect master", zap.Error(err))
  357. }
  358. w.masterClient = protocol.NewMasterClient(conn)
  359. if w.oneMode {
  360. w.peers = []string{w.workerName}
  361. w.me = w.workerName
  362. } else {
  363. go w.Sync()
  364. go w.Pull()
  365. go w.ServeHTTP()
  366. }
  367. loop := func() {
  368. w.scheduleState.IsRunning = true
  369. w.scheduleState.StartTime = time.Now()
  370. defer func() {
  371. w.scheduleState.IsRunning = false
  372. w.scheduleState.StartTime = time.Time{}
  373. }()
  374. // pull users
  375. workingUsers, err := w.pullUsers(w.peers, w.me)
  376. if err != nil {
  377. log.Logger().Error("failed to split users", zap.Error(err),
  378. zap.String("me", w.me),
  379. zap.Strings("workers", w.peers))
  380. return
  381. }
  382. // recommendation
  383. w.Recommend(workingUsers)
  384. }
  385. if w.managedMode {
  386. for range w.triggerChan.C {
  387. loop()
  388. }
  389. } else {
  390. for {
  391. select {
  392. case tick := <-w.ticker.C:
  393. if time.Since(tick) < w.Config.Recommend.Offline.CheckRecommendPeriod {
  394. loop()
  395. }
  396. case <-w.pulledChan.C:
  397. loop()
  398. }
  399. }
  400. }
  401. }
  402. // Recommend items to users. The workflow of recommendation is:
  403. // 1. Skip inactive users.
  404. // 2. Load historical items.
  405. // 3. Load positive items if KNN used.
  406. // 4. Generate recommendation.
  407. // 5. Save result.
  408. // 6. Insert cold-start items into results.
  409. // 7. Rank items in results by click-through-rate.
  410. // 8. Refresh cache.
  411. func (w *Worker) Recommend(users []data.User) {
  412. ctx := context.Background()
  413. startRecommendTime := time.Now()
  414. log.Logger().Info("ranking recommendation",
  415. zap.Int("n_working_users", len(users)),
  416. zap.Int("n_jobs", w.jobs),
  417. zap.Int("cache_size", w.Config.Recommend.CacheSize))
  418. // pull items from database
  419. itemCache, itemCategories, err := w.pullItems(ctx)
  420. if err != nil {
  421. log.Logger().Error("failed to pull items", zap.Error(err))
  422. return
  423. }
  424. MemoryInuseBytesVec.WithLabelValues("item_cache").Set(float64(itemCache.Bytes()))
  425. defer MemoryInuseBytesVec.WithLabelValues("item_cache").Set(0)
  426. // progress tracker
  427. completed := make(chan struct{}, 1000)
  428. _, span := w.tracer.Start(context.Background(), "Recommend", len(users))
  429. defer span.End()
  430. go func() {
  431. defer base.CheckPanic()
  432. completedCount, previousCount := 0, 0
  433. ticker := time.NewTicker(10 * time.Second)
  434. for {
  435. select {
  436. case _, ok := <-completed:
  437. if !ok {
  438. return
  439. }
  440. completedCount++
  441. case <-ticker.C:
  442. throughput := completedCount - previousCount
  443. previousCount = completedCount
  444. if throughput > 0 {
  445. if w.masterClient != nil {
  446. span.Add(throughput)
  447. }
  448. log.Logger().Info("ranking recommendation",
  449. zap.Int("n_complete_users", completedCount),
  450. zap.Int("n_working_users", len(users)),
  451. zap.Int("throughput", throughput))
  452. }
  453. if _, err := w.masterClient.PushProgress(context.Background(), protocol.EncodeProgress(w.tracer.List())); err != nil {
  454. log.Logger().Error("failed to report update task", zap.Error(err))
  455. }
  456. }
  457. }
  458. }()
  459. // build ranking index
  460. if w.RankingModel != nil && !w.RankingModel.Invalid() && w.rankingIndex == nil {
  461. if w.Config.Recommend.Collaborative.EnableIndex {
  462. startTime := time.Now()
  463. log.Logger().Info("start building ranking index")
  464. itemIndex := w.RankingModel.GetItemIndex()
  465. vectors := make([]search.Vector, itemIndex.Len())
  466. for i := int32(0); i < itemIndex.Len(); i++ {
  467. itemId := itemIndex.ToName(i)
  468. if itemCache.IsAvailable(itemId) {
  469. vectors[i] = search.NewDenseVector(w.RankingModel.GetItemFactor(i), itemCache.GetCategory(itemId), false)
  470. } else {
  471. vectors[i] = search.NewDenseVector(w.RankingModel.GetItemFactor(i), nil, true)
  472. }
  473. }
  474. builder := search.NewHNSWBuilder(vectors, w.Config.Recommend.CacheSize, w.jobs)
  475. var recall float32
  476. w.rankingIndex, recall = builder.Build(ctx, w.Config.Recommend.Collaborative.IndexRecall,
  477. w.Config.Recommend.Collaborative.IndexFitEpoch, false)
  478. CollaborativeFilteringIndexRecall.Set(float64(recall))
  479. if err = w.CacheClient.Set(ctx, cache.String(cache.Key(cache.GlobalMeta, cache.MatchingIndexRecall), encoding.FormatFloat32(recall))); err != nil {
  480. log.Logger().Error("failed to write meta", zap.Error(err))
  481. }
  482. log.Logger().Info("complete building ranking index",
  483. zap.Duration("build_time", time.Since(startTime)))
  484. } else {
  485. CollaborativeFilteringIndexRecall.Set(1)
  486. }
  487. }
  488. // recommendation
  489. startTime := time.Now()
  490. var (
  491. updateUserCount atomic.Float64
  492. collaborativeRecommendSeconds atomic.Float64
  493. userBasedRecommendSeconds atomic.Float64
  494. itemBasedRecommendSeconds atomic.Float64
  495. latestRecommendSeconds atomic.Float64
  496. popularRecommendSeconds atomic.Float64
  497. )
  498. userFeedbackCache := NewFeedbackCache(w, w.Config.Recommend.DataSource.PositiveFeedbackTypes...)
  499. defer MemoryInuseBytesVec.WithLabelValues("user_feedback_cache").Set(0)
  500. err = parallel.Parallel(len(users), w.jobs, func(workerId, jobId int) error {
  501. defer func() {
  502. completed <- struct{}{}
  503. }()
  504. user := users[jobId]
  505. userId := user.UserId
  506. // skip inactive users before max recommend period
  507. if !w.checkUserActiveTime(ctx, userId) || !w.checkRecommendCacheTimeout(ctx, userId, itemCategories) {
  508. return nil
  509. }
  510. updateUserCount.Add(1)
  511. // load historical items
  512. historyItems, feedbacks, err := w.loadUserHistoricalItems(w.DataClient, userId)
  513. excludeSet := mapset.NewSet(historyItems...)
  514. if err != nil {
  515. log.Logger().Error("failed to pull user feedback",
  516. zap.String("user_id", userId), zap.Error(err))
  517. return errors.Trace(err)
  518. }
  519. // load positive items
  520. var positiveItems []string
  521. if w.Config.Recommend.Offline.EnableItemBasedRecommend {
  522. positiveItems, err = userFeedbackCache.GetUserFeedback(ctx, userId)
  523. if err != nil {
  524. log.Logger().Error("failed to pull user feedback",
  525. zap.String("user_id", userId), zap.Error(err))
  526. return errors.Trace(err)
  527. }
  528. MemoryInuseBytesVec.WithLabelValues("user_feedback_cache").Set(float64(userFeedbackCache.Bytes()))
  529. }
  530. // create candidates container
  531. candidates := make(map[string][][]string)
  532. candidates[""] = make([][]string, 0)
  533. for _, category := range itemCategories {
  534. candidates[category] = make([][]string, 0)
  535. }
  536. // Recommender #1: collaborative filtering.
  537. collaborativeUsed := false
  538. if w.Config.Recommend.Offline.EnableColRecommend && w.RankingModel != nil && !w.RankingModel.Invalid() {
  539. if userIndex := w.RankingModel.GetUserIndex().ToNumber(userId); w.RankingModel.IsUserPredictable(userIndex) {
  540. var recommend map[string][]string
  541. var usedTime time.Duration
  542. if w.Config.Recommend.Collaborative.EnableIndex && w.rankingIndex != nil {
  543. recommend, usedTime, err = w.collaborativeRecommendHNSW(w.rankingIndex, userId, itemCategories, excludeSet, itemCache)
  544. } else {
  545. recommend, usedTime, err = w.collaborativeRecommendBruteForce(userId, itemCategories, excludeSet, itemCache)
  546. }
  547. if err != nil {
  548. log.Logger().Error("failed to recommend by collaborative filtering",
  549. zap.String("user_id", userId), zap.Error(err))
  550. return errors.Trace(err)
  551. }
  552. for category, items := range recommend {
  553. candidates[category] = append(candidates[category], items)
  554. }
  555. collaborativeUsed = true
  556. collaborativeRecommendSeconds.Add(usedTime.Seconds())
  557. } else if !w.RankingModel.IsUserPredictable(userIndex) {
  558. log.Logger().Debug("user is unpredictable", zap.String("user_id", userId))
  559. }
  560. } else if w.RankingModel == nil || w.RankingModel.Invalid() {
  561. log.Logger().Debug("no collaborative filtering model")
  562. }
  563. // Recommender #2: item-based.
  564. itemNeighborDigests := mapset.NewSet[string]()
  565. if w.Config.Recommend.Offline.EnableItemBasedRecommend {
  566. localStartTime := time.Now()
  567. for _, category := range append([]string{""}, itemCategories...) {
  568. // collect candidates
  569. scores := make(map[string]float64)
  570. for _, itemId := range positiveItems {
  571. // load similar items
  572. similarItems, err := w.CacheClient.SearchDocuments(ctx, cache.ItemNeighbors, itemId, []string{category}, 0, w.Config.Recommend.CacheSize)
  573. if err != nil {
  574. log.Logger().Error("failed to load similar items", zap.Error(err))
  575. return errors.Trace(err)
  576. }
  577. // add unseen items
  578. for _, item := range similarItems {
  579. if !excludeSet.Contains(item.Id) && itemCache.IsAvailable(item.Id) {
  580. scores[item.Id] += item.Score
  581. }
  582. }
  583. // load item neighbors digest
  584. digest, err := w.CacheClient.Get(ctx, cache.Key(cache.ItemNeighborsDigest, itemId)).String()
  585. if err != nil {
  586. if !errors.Is(err, errors.NotFound) {
  587. log.Logger().Error("failed to load item neighbors digest", zap.Error(err))
  588. return errors.Trace(err)
  589. }
  590. }
  591. itemNeighborDigests.Add(digest)
  592. }
  593. // collect top k
  594. filter := heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
  595. for id, score := range scores {
  596. filter.Push(id, score)
  597. }
  598. ids, _ := filter.PopAll()
  599. candidates[category] = append(candidates[category], ids)
  600. }
  601. itemBasedRecommendSeconds.Add(time.Since(localStartTime).Seconds())
  602. }
  603. // Recommender #3: insert user-based items
  604. userNeighborDigests := mapset.NewSet[string]()
  605. if w.Config.Recommend.Offline.EnableUserBasedRecommend {
  606. localStartTime := time.Now()
  607. scores := make(map[string]float64)
  608. // load similar users
  609. similarUsers, err := w.CacheClient.SearchDocuments(ctx, cache.UserNeighbors, userId, []string{""}, 0, w.Config.Recommend.CacheSize)
  610. if err != nil {
  611. log.Logger().Error("failed to load similar users", zap.Error(err))
  612. return errors.Trace(err)
  613. }
  614. for _, user := range similarUsers {
  615. // load historical feedback
  616. similarUserPositiveItems, err := userFeedbackCache.GetUserFeedback(ctx, user.Id)
  617. if err != nil {
  618. log.Logger().Error("failed to pull user feedback",
  619. zap.String("user_id", userId), zap.Error(err))
  620. return errors.Trace(err)
  621. }
  622. MemoryInuseBytesVec.WithLabelValues("user_feedback_cache").Set(float64(userFeedbackCache.Bytes()))
  623. // add unseen items
  624. for _, itemId := range similarUserPositiveItems {
  625. if !excludeSet.Contains(itemId) && itemCache.IsAvailable(itemId) {
  626. scores[itemId] += user.Score
  627. }
  628. }
  629. // load user neighbors digest
  630. digest, err := w.CacheClient.Get(ctx, cache.Key(cache.UserNeighborsDigest, user.Id)).String()
  631. if err != nil {
  632. if !errors.Is(err, errors.NotFound) {
  633. log.Logger().Error("failed to load user neighbors digest", zap.Error(err))
  634. return errors.Trace(err)
  635. }
  636. }
  637. userNeighborDigests.Add(digest)
  638. }
  639. // collect top k
  640. filters := make(map[string]*heap.TopKFilter[string, float64])
  641. filters[""] = heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
  642. for _, category := range itemCategories {
  643. filters[category] = heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
  644. }
  645. for id, score := range scores {
  646. filters[""].Push(id, score)
  647. for _, category := range itemCache.GetCategory(id) {
  648. filters[category].Push(id, score)
  649. }
  650. }
  651. for category, filter := range filters {
  652. ids, _ := filter.PopAll()
  653. candidates[category] = append(candidates[category], ids)
  654. }
  655. userBasedRecommendSeconds.Add(time.Since(localStartTime).Seconds())
  656. }
  657. // Recommender #4: latest items.
  658. if w.Config.Recommend.Offline.EnableLatestRecommend {
  659. localStartTime := time.Now()
  660. for _, category := range append([]string{""}, itemCategories...) {
  661. latestItems, err := w.CacheClient.SearchDocuments(ctx, cache.LatestItems, "", []string{category}, 0, w.Config.Recommend.CacheSize)
  662. if err != nil {
  663. log.Logger().Error("failed to load latest items", zap.Error(err))
  664. return errors.Trace(err)
  665. }
  666. var recommend []string
  667. for _, latestItem := range latestItems {
  668. if !excludeSet.Contains(latestItem.Id) && itemCache.IsAvailable(latestItem.Id) {
  669. recommend = append(recommend, latestItem.Id)
  670. }
  671. }
  672. candidates[category] = append(candidates[category], recommend)
  673. }
  674. latestRecommendSeconds.Add(time.Since(localStartTime).Seconds())
  675. }
  676. // Recommender #5: popular items.
  677. if w.Config.Recommend.Offline.EnablePopularRecommend {
  678. localStartTime := time.Now()
  679. for _, category := range append([]string{""}, itemCategories...) {
  680. popularItems, err := w.CacheClient.SearchDocuments(ctx, cache.PopularItems, "", []string{category}, 0, w.Config.Recommend.CacheSize)
  681. if err != nil {
  682. log.Logger().Error("failed to load popular items", zap.Error(err))
  683. return errors.Trace(err)
  684. }
  685. var recommend []string
  686. for _, popularItem := range popularItems {
  687. if !excludeSet.Contains(popularItem.Id) && itemCache.IsAvailable(popularItem.Id) {
  688. recommend = append(recommend, popularItem.Id)
  689. }
  690. }
  691. candidates[category] = append(candidates[category], recommend)
  692. }
  693. popularRecommendSeconds.Add(time.Since(localStartTime).Seconds())
  694. }
  695. // rank items from different recommenders
  696. // 1. If click-through rate prediction model is available, use it to rank items.
  697. // 2. If collaborative filtering model is available, use it to rank items.
  698. // 3. Otherwise, merge all recommenders' results randomly.
  699. ctrUsed := false
  700. results := make(map[string][]cache.Document)
  701. for category, catCandidates := range candidates {
  702. if w.Config.Recommend.Offline.EnableClickThroughPrediction && w.rankers[workerId] != nil && !w.rankers[workerId].Invalid() {
  703. results[category], err = w.rankByClickTroughRate(&user, catCandidates, itemCache, w.rankers[workerId])
  704. if err != nil {
  705. log.Logger().Error("failed to rank items", zap.Error(err))
  706. return errors.Trace(err)
  707. }
  708. ctrUsed = true
  709. } else if w.RankingModel != nil && !w.RankingModel.Invalid() &&
  710. w.RankingModel.IsUserPredictable(w.RankingModel.GetUserIndex().ToNumber(userId)) {
  711. results[category], err = w.rankByCollaborativeFiltering(userId, catCandidates)
  712. if err != nil {
  713. log.Logger().Error("failed to rank items", zap.Error(err))
  714. return errors.Trace(err)
  715. }
  716. } else {
  717. results[category] = w.mergeAndShuffle(catCandidates)
  718. }
  719. }
  720. // replacement
  721. if w.Config.Recommend.Replacement.EnableReplacement {
  722. if results, err = w.replacement(results, &user, feedbacks, itemCache); err != nil {
  723. log.Logger().Error("failed to replace items", zap.Error(err))
  724. return errors.Trace(err)
  725. }
  726. }
  727. // explore latest and popular
  728. recommendTime := time.Now()
  729. aggregator := cache.NewDocumentAggregator(recommendTime)
  730. for category, result := range results {
  731. scores, err := w.exploreRecommend(result, excludeSet, category)
  732. if err != nil {
  733. log.Logger().Error("failed to explore latest and popular items", zap.Error(err))
  734. return errors.Trace(err)
  735. }
  736. aggregator.Add(category, lo.Map(scores, func(document cache.Document, _ int) string {
  737. return document.Id
  738. }), lo.Map(scores, func(document cache.Document, _ int) float64 {
  739. return document.Score
  740. }))
  741. }
  742. if err = w.CacheClient.AddDocuments(ctx, cache.OfflineRecommend, userId, aggregator.ToSlice()); err != nil {
  743. log.Logger().Error("failed to cache recommendation", zap.Error(err))
  744. return errors.Trace(err)
  745. }
  746. if err = w.CacheClient.Set(
  747. ctx,
  748. cache.Time(cache.Key(cache.LastUpdateUserRecommendTime, userId), recommendTime),
  749. cache.String(cache.Key(cache.OfflineRecommendDigest, userId), w.Config.OfflineRecommendDigest(
  750. config.WithCollaborative(collaborativeUsed),
  751. config.WithRanking(ctrUsed),
  752. config.WithItemNeighborDigest(strings.Join(itemNeighborDigests.ToSlice(), "-")),
  753. config.WithUserNeighborDigest(strings.Join(userNeighborDigests.ToSlice(), "-")),
  754. ))); err != nil {
  755. log.Logger().Error("failed to cache recommendation time", zap.Error(err))
  756. }
  757. return nil
  758. })
  759. close(completed)
  760. if err != nil {
  761. log.Logger().Error("failed to continue offline recommendation", zap.Error(err))
  762. return
  763. }
  764. log.Logger().Info("complete ranking recommendation",
  765. zap.String("used_time", time.Since(startTime).String()))
  766. UpdateUserRecommendTotal.Set(updateUserCount.Load())
  767. OfflineRecommendTotalSeconds.Set(time.Since(startRecommendTime).Seconds())
  768. OfflineRecommendStepSecondsVec.WithLabelValues("collaborative_recommend").Set(collaborativeRecommendSeconds.Load())
  769. OfflineRecommendStepSecondsVec.WithLabelValues("item_based_recommend").Set(itemBasedRecommendSeconds.Load())
  770. OfflineRecommendStepSecondsVec.WithLabelValues("user_based_recommend").Set(userBasedRecommendSeconds.Load())
  771. OfflineRecommendStepSecondsVec.WithLabelValues("latest_recommend").Set(latestRecommendSeconds.Load())
  772. OfflineRecommendStepSecondsVec.WithLabelValues("popular_recommend").Set(popularRecommendSeconds.Load())
  773. }
  774. func (w *Worker) collaborativeRecommendBruteForce(userId string, itemCategories []string, excludeSet mapset.Set[string], itemCache *ItemCache) (map[string][]string, time.Duration, error) {
  775. ctx := context.Background()
  776. userIndex := w.RankingModel.GetUserIndex().ToNumber(userId)
  777. itemIds := w.RankingModel.GetItemIndex().GetNames()
  778. localStartTime := time.Now()
  779. recItemsFilters := make(map[string]*heap.TopKFilter[string, float64])
  780. recItemsFilters[""] = heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
  781. for _, category := range itemCategories {
  782. recItemsFilters[category] = heap.NewTopKFilter[string, float64](w.Config.Recommend.CacheSize)
  783. }
  784. for itemIndex, itemId := range itemIds {
  785. if !excludeSet.Contains(itemId) && itemCache.IsAvailable(itemId) && w.RankingModel.IsItemPredictable(int32(itemIndex)) {
  786. prediction := w.RankingModel.InternalPredict(userIndex, int32(itemIndex))
  787. recItemsFilters[""].Push(itemId, float64(prediction))
  788. for _, category := range itemCache.GetCategory(itemId) {
  789. recItemsFilters[category].Push(itemId, float64(prediction))
  790. }
  791. }
  792. }
  793. // save result
  794. recommend := make(map[string][]string)
  795. aggregator := cache.NewDocumentAggregator(localStartTime)
  796. for category, recItemsFilter := range recItemsFilters {
  797. recommendItems, recommendScores := recItemsFilter.PopAll()
  798. recommend[category] = recommendItems
  799. aggregator.Add(category, recommendItems, recommendScores)
  800. }
  801. if err := w.CacheClient.AddDocuments(ctx, cache.CollaborativeRecommend, userId, aggregator.ToSlice()); err != nil {
  802. log.Logger().Error("failed to cache collaborative filtering recommendation result", zap.String("user_id", userId), zap.Error(err))
  803. return nil, 0, errors.Trace(err)
  804. }
  805. if err := w.CacheClient.DeleteDocuments(ctx, []string{cache.CollaborativeRecommend}, cache.DocumentCondition{Before: &localStartTime}); err != nil {
  806. log.Logger().Error("failed to delete stale collaborative filtering recommendation result", zap.String("user_id", userId), zap.Error(err))
  807. return nil, 0, errors.Trace(err)
  808. }
  809. return recommend, time.Since(localStartTime), nil
  810. }
  811. func (w *Worker) collaborativeRecommendHNSW(rankingIndex *search.HNSW, userId string, itemCategories []string, excludeSet mapset.Set[string], itemCache *ItemCache) (map[string][]string, time.Duration, error) {
  812. ctx := context.Background()
  813. userIndex := w.RankingModel.GetUserIndex().ToNumber(userId)
  814. localStartTime := time.Now()
  815. values, scores := rankingIndex.MultiSearch(search.NewDenseVector(w.RankingModel.GetUserFactor(userIndex), nil, false),
  816. itemCategories, w.Config.Recommend.CacheSize+excludeSet.Cardinality(), false)
  817. // save result
  818. recommend := make(map[string][]string)
  819. aggregator := cache.NewDocumentAggregator(localStartTime)
  820. for category, catValues := range values {
  821. recommendItems := make([]string, 0, len(catValues))
  822. recommendScores := make([]float64, 0, len(catValues))
  823. for i := range catValues {
  824. itemId := w.RankingModel.GetItemIndex().ToName(catValues[i])
  825. if !excludeSet.Contains(itemId) && itemCache.IsAvailable(itemId) {
  826. recommendItems = append(recommendItems, itemId)
  827. recommendScores = append(recommendScores, float64(scores[category][i]))
  828. }
  829. }
  830. recommend[category] = recommendItems
  831. aggregator.Add(category, recommendItems, recommendScores)
  832. }
  833. if err := w.CacheClient.AddDocuments(ctx, cache.CollaborativeRecommend, userId, aggregator.ToSlice()); err != nil {
  834. log.Logger().Error("failed to cache collaborative filtering recommendation result", zap.String("user_id", userId), zap.Error(err))
  835. return nil, 0, errors.Trace(err)
  836. }
  837. if err := w.CacheClient.DeleteDocuments(ctx, []string{cache.CollaborativeRecommend}, cache.DocumentCondition{Before: &localStartTime}); err != nil {
  838. log.Logger().Error("failed to delete stale collaborative filtering recommendation result", zap.String("user_id", userId), zap.Error(err))
  839. return nil, 0, errors.Trace(err)
  840. }
  841. return recommend, time.Since(localStartTime), nil
  842. }
  843. func (w *Worker) rankByCollaborativeFiltering(userId string, candidates [][]string) ([]cache.Document, error) {
  844. // concat candidates
  845. memo := mapset.NewSet[string]()
  846. var itemIds []string
  847. for _, v := range candidates {
  848. for _, itemId := range v {
  849. if !memo.Contains(itemId) {
  850. memo.Add(itemId)
  851. itemIds = append(itemIds, itemId)
  852. }
  853. }
  854. }
  855. // rank by collaborative filtering
  856. topItems := make([]cache.Document, 0, len(candidates))
  857. for _, itemId := range itemIds {
  858. topItems = append(topItems, cache.Document{
  859. Id: itemId,
  860. Score: float64(w.RankingModel.Predict(userId, itemId)),
  861. })
  862. }
  863. cache.SortDocuments(topItems)
  864. return topItems, nil
  865. }
  866. // rankByClickTroughRate ranks items by predicted click-through-rate.
  867. func (w *Worker) rankByClickTroughRate(user *data.User, candidates [][]string, itemCache *ItemCache, predictor click.FactorizationMachine) ([]cache.Document, error) {
  868. // concat candidates
  869. memo := mapset.NewSet[string]()
  870. var itemIds []string
  871. for _, v := range candidates {
  872. for _, itemId := range v {
  873. if !memo.Contains(itemId) {
  874. memo.Add(itemId)
  875. itemIds = append(itemIds, itemId)
  876. }
  877. }
  878. }
  879. // download items
  880. items := make([]*data.Item, 0, len(itemIds))
  881. for _, itemId := range itemIds {
  882. if item, exist := itemCache.Get(itemId); exist {
  883. items = append(items, item)
  884. } else {
  885. log.Logger().Warn("item doesn't exists in database", zap.String("item_id", itemId))
  886. }
  887. }
  888. // rank by CTR
  889. topItems := make([]cache.Document, 0, len(items))
  890. if batchPredictor, ok := predictor.(click.BatchInference); ok {
  891. inputs := make([]lo.Tuple4[string, string, []click.Feature, []click.Feature], len(items))
  892. for i, item := range items {
  893. inputs[i].A = user.UserId
  894. inputs[i].B = item.ItemId
  895. inputs[i].C = click.ConvertLabelsToFeatures(user.Labels)
  896. inputs[i].D = click.ConvertLabelsToFeatures(item.Labels)
  897. }
  898. output := batchPredictor.BatchPredict(inputs)
  899. for i, score := range output {
  900. topItems = append(topItems, cache.Document{
  901. Id: items[i].ItemId,
  902. Score: float64(score),
  903. })
  904. }
  905. } else {
  906. for _, item := range items {
  907. topItems = append(topItems, cache.Document{
  908. Id: item.ItemId,
  909. Score: float64(predictor.Predict(user.UserId, item.ItemId, click.ConvertLabelsToFeatures(user.Labels), click.ConvertLabelsToFeatures(item.Labels))),
  910. })
  911. }
  912. }
  913. cache.SortDocuments(topItems)
  914. return topItems, nil
  915. }
  916. func (w *Worker) mergeAndShuffle(candidates [][]string) []cache.Document {
  917. memo := mapset.NewSet[string]()
  918. pos := make([]int, len(candidates))
  919. var recommend []cache.Document
  920. for {
  921. // filter out ended slice
  922. var src []int
  923. for i := range candidates {
  924. if pos[i] < len(candidates[i]) {
  925. src = append(src, i)
  926. }
  927. }
  928. if len(src) == 0 {
  929. break
  930. }
  931. // select a slice randomly
  932. j := src[w.randGenerator.Intn(len(src))]
  933. candidateId := candidates[j][pos[j]]
  934. pos[j]++
  935. if !memo.Contains(candidateId) {
  936. memo.Add(candidateId)
  937. recommend = append(recommend, cache.Document{Score: math.Exp(float64(-len(recommend))), Id: candidateId})
  938. }
  939. }
  940. return recommend
  941. }
  942. func (w *Worker) exploreRecommend(exploitRecommend []cache.Document, excludeSet mapset.Set[string], category string) ([]cache.Document, error) {
  943. var localExcludeSet mapset.Set[string]
  944. ctx := context.Background()
  945. if w.Config.Recommend.Replacement.EnableReplacement {
  946. localExcludeSet = mapset.NewSet[string]()
  947. } else {
  948. localExcludeSet = excludeSet.Clone()
  949. }
  950. // create thresholds
  951. explorePopularThreshold := 0.0
  952. if threshold, exist := w.Config.Recommend.Offline.GetExploreRecommend("popular"); exist {
  953. explorePopularThreshold = threshold
  954. }
  955. exploreLatestThreshold := explorePopularThreshold
  956. if threshold, exist := w.Config.Recommend.Offline.GetExploreRecommend("latest"); exist {
  957. exploreLatestThreshold += threshold
  958. }
  959. // load popular items
  960. popularItems, err := w.CacheClient.SearchDocuments(ctx, cache.PopularItems, "", []string{category}, 0, w.Config.Recommend.CacheSize)
  961. if err != nil {
  962. return nil, errors.Trace(err)
  963. }
  964. // load the latest items
  965. latestItems, err := w.CacheClient.SearchDocuments(ctx, cache.LatestItems, "", []string{category}, 0, w.Config.Recommend.CacheSize)
  966. if err != nil {
  967. return nil, errors.Trace(err)
  968. }
  969. // explore recommendation
  970. var exploreRecommend []cache.Document
  971. score := 1.0
  972. if len(exploitRecommend) > 0 {
  973. score += exploitRecommend[0].Score
  974. }
  975. for range exploitRecommend {
  976. dice := w.randGenerator.Float64()
  977. var recommendItem cache.Document
  978. if dice < explorePopularThreshold && len(popularItems) > 0 {
  979. score -= 1e-5
  980. recommendItem.Id = popularItems[0].Id
  981. recommendItem.Score = score
  982. popularItems = popularItems[1:]
  983. } else if dice < exploreLatestThreshold && len(latestItems) > 0 {
  984. score -= 1e-5
  985. recommendItem.Id = latestItems[0].Id
  986. recommendItem.Score = score
  987. latestItems = latestItems[1:]
  988. } else if len(exploitRecommend) > 0 {
  989. recommendItem = exploitRecommend[0]
  990. exploitRecommend = exploitRecommend[1:]
  991. score = recommendItem.Score
  992. } else {
  993. break
  994. }
  995. if !localExcludeSet.Contains(recommendItem.Id) {
  996. localExcludeSet.Add(recommendItem.Id)
  997. exploreRecommend = append(exploreRecommend, recommendItem)
  998. }
  999. }
  1000. return exploreRecommend, nil
  1001. }
  1002. func (w *Worker) checkUserActiveTime(ctx context.Context, userId string) bool {
  1003. if w.Config.Recommend.ActiveUserTTL == 0 {
  1004. return true
  1005. }
  1006. // read active time
  1007. activeTime, err := w.CacheClient.Get(ctx, cache.Key(cache.LastModifyUserTime, userId)).Time()
  1008. if err != nil {
  1009. if !errors.Is(err, errors.NotFound) {
  1010. log.Logger().Error("failed to read last modify user time", zap.Error(err))
  1011. }
  1012. return true
  1013. }
  1014. // check active time
  1015. if time.Since(activeTime) < time.Duration(w.Config.Recommend.ActiveUserTTL*24)*time.Hour {
  1016. return true
  1017. }
  1018. // remove recommend cache for inactive users
  1019. if err := w.CacheClient.DeleteDocuments(ctx, []string{cache.OfflineRecommend, cache.CollaborativeRecommend},
  1020. cache.DocumentCondition{Subset: proto.String(userId)}); err != nil {
  1021. log.Logger().Error("failed to delete recommend cache", zap.String("user_id", userId), zap.Error(err))
  1022. }
  1023. return false
  1024. }
  1025. // checkRecommendCacheTimeout checks if recommend cache stale.
  1026. // 1. if cache is empty, stale.
  1027. // 2. if active time > recommend time, stale.
  1028. // 3. if recommend time + timeout < now, stale.
  1029. func (w *Worker) checkRecommendCacheTimeout(ctx context.Context, userId string, categories []string) bool {
  1030. var (
  1031. activeTime time.Time
  1032. recommendTime time.Time
  1033. cacheDigest string
  1034. err error
  1035. )
  1036. // check cache
  1037. for _, category := range append([]string{""}, categories...) {
  1038. items, err := w.CacheClient.SearchDocuments(ctx, cache.OfflineRecommend, userId, []string{category}, 0, -1)
  1039. if err != nil {
  1040. log.Logger().Error("failed to load offline recommendation", zap.String("user_id", userId), zap.Error(err))
  1041. return true
  1042. } else if len(items) == 0 {
  1043. return true
  1044. }
  1045. }
  1046. // read digest
  1047. cacheDigest, err = w.CacheClient.Get(ctx, cache.Key(cache.OfflineRecommendDigest, userId)).String()
  1048. if err != nil {
  1049. if !errors.Is(err, errors.NotFound) {
  1050. log.Logger().Error("failed to load offline recommendation digest", zap.String("user_id", userId), zap.Error(err))
  1051. }
  1052. return true
  1053. }
  1054. if cacheDigest != w.Config.OfflineRecommendDigest() {
  1055. return true
  1056. }
  1057. // read active time
  1058. activeTime, err = w.CacheClient.Get(ctx, cache.Key(cache.LastModifyUserTime, userId)).Time()
  1059. if err != nil {
  1060. if !errors.Is(err, errors.NotFound) {
  1061. log.Logger().Error("failed to read last modify user time", zap.Error(err))
  1062. }
  1063. return true
  1064. }
  1065. // read recommend time
  1066. recommendTime, err = w.CacheClient.Get(ctx, cache.Key(cache.LastUpdateUserRecommendTime, userId)).Time()
  1067. if err != nil {
  1068. if !errors.Is(err, errors.NotFound) {
  1069. log.Logger().Error("failed to read last update user recommend time", zap.Error(err))
  1070. }
  1071. return true
  1072. }
  1073. // check cache expire
  1074. if recommendTime.Before(time.Now().Add(-w.Config.Recommend.CacheExpire)) {
  1075. return true
  1076. }
  1077. // check time
  1078. if activeTime.Before(recommendTime) {
  1079. timeoutTime := recommendTime.Add(w.Config.Recommend.Offline.RefreshRecommendPeriod)
  1080. return timeoutTime.Before(time.Now())
  1081. }
  1082. return true
  1083. }
  1084. func (w *Worker) loadUserHistoricalItems(database data.Database, userId string) ([]string, []data.Feedback, error) {
  1085. items := make([]string, 0)
  1086. ctx := context.Background()
  1087. feedbacks, err := database.GetUserFeedback(ctx, userId, w.Config.Now())
  1088. if err != nil {
  1089. return nil, nil, err
  1090. }
  1091. for _, feedback := range feedbacks {
  1092. items = append(items, feedback.ItemId)
  1093. }
  1094. return items, feedbacks, nil
  1095. }
  1096. func (w *Worker) pullItems(ctx context.Context) (*ItemCache, []string, error) {
  1097. // pull items from database
  1098. itemCache := NewItemCache()
  1099. itemCategories := mapset.NewSet[string]()
  1100. itemChan, errChan := w.DataClient.GetItemStream(ctx, batchSize, nil)
  1101. for batchItems := range itemChan {
  1102. for _, item := range batchItems {
  1103. itemCache.Set(item.ItemId, item)
  1104. itemCategories.Append(item.Categories...)
  1105. }
  1106. }
  1107. if err := <-errChan; err != nil {
  1108. return nil, nil, errors.Trace(err)
  1109. }
  1110. return itemCache, itemCategories.ToSlice(), nil
  1111. }
  1112. func (w *Worker) pullUsers(peers []string, me string) ([]data.User, error) {
  1113. ctx := context.Background()
  1114. // locate me
  1115. if !funk.ContainsString(peers, me) {
  1116. return nil, errors.New("current node isn't in worker nodes")
  1117. }
  1118. // create consistent hash ring
  1119. c := consistent.New()
  1120. for _, peer := range peers {
  1121. c.Add(peer)
  1122. }
  1123. // pull users from database
  1124. var users []data.User
  1125. userChan, errChan := w.DataClient.GetUserStream(ctx, batchSize)
  1126. for batchUsers := range userChan {
  1127. for _, user := range batchUsers {
  1128. p, err := c.Get(user.UserId)
  1129. if err != nil {
  1130. return nil, errors.Trace(err)
  1131. }
  1132. if p == me {
  1133. users = append(users, user)
  1134. }
  1135. }
  1136. }
  1137. if err := <-errChan; err != nil {
  1138. return nil, errors.Trace(err)
  1139. }
  1140. return users, nil
  1141. }
  1142. // replacement inserts historical items back to recommendation.
  1143. func (w *Worker) replacement(recommend map[string][]cache.Document, user *data.User, feedbacks []data.Feedback, itemCache *ItemCache) (map[string][]cache.Document, error) {
  1144. upperBounds := make(map[string]float64)
  1145. lowerBounds := make(map[string]float64)
  1146. newRecommend := make(map[string][]cache.Document)
  1147. for category, scores := range recommend {
  1148. // find minimal score
  1149. if len(scores) > 0 {
  1150. s := lo.Map(scores, func(score cache.Document, _ int) float64 {
  1151. return score.Score
  1152. })
  1153. upperBounds[category] = funk.MaxFloat64(s)
  1154. lowerBounds[category] = funk.MinFloat64(s)
  1155. } else {
  1156. upperBounds[category] = math.Inf(1)
  1157. lowerBounds[category] = math.Inf(-1)
  1158. }
  1159. // add scores to filters
  1160. newRecommend[category] = append(newRecommend[category], scores...)
  1161. }
  1162. // remove duplicates
  1163. positiveItems := mapset.NewSet[string]()
  1164. distinctItems := mapset.NewSet[string]()
  1165. for _, feedback := range feedbacks {
  1166. if funk.ContainsString(w.Config.Recommend.DataSource.PositiveFeedbackTypes, feedback.FeedbackType) {
  1167. positiveItems.Add(feedback.ItemId)
  1168. distinctItems.Add(feedback.ItemId)
  1169. } else if funk.ContainsString(w.Config.Recommend.DataSource.ReadFeedbackTypes, feedback.FeedbackType) {
  1170. distinctItems.Add(feedback.ItemId)
  1171. }
  1172. }
  1173. for _, itemId := range distinctItems.ToSlice() {
  1174. if item, exist := itemCache.Get(itemId); exist {
  1175. // scoring item
  1176. // 1. If click-through rate prediction model is available, use it.
  1177. // 2. If collaborative filtering model is available, use it.
  1178. // 3. Otherwise, give a random score.
  1179. var score float64
  1180. if w.Config.Recommend.Offline.EnableClickThroughPrediction && w.ClickModel != nil {
  1181. score = float64(w.ClickModel.Predict(user.UserId, itemId, click.ConvertLabelsToFeatures(user.Labels), click.ConvertLabelsToFeatures(item.Labels)))
  1182. } else if w.RankingModel != nil && !w.RankingModel.Invalid() && w.RankingModel.IsUserPredictable(w.RankingModel.GetUserIndex().ToNumber(user.UserId)) {
  1183. score = float64(w.RankingModel.Predict(user.UserId, itemId))
  1184. } else {
  1185. upper := upperBounds[""]
  1186. lower := lowerBounds[""]
  1187. if !math.IsInf(upper, 1) && !math.IsInf(lower, -1) {
  1188. score = lower + w.randGenerator.Float64()*(upper-lower)
  1189. } else {
  1190. score = w.randGenerator.Float64()
  1191. }
  1192. }
  1193. // replace item
  1194. for _, category := range append([]string{""}, item.Categories...) {
  1195. upperBound := upperBounds[category]
  1196. lowerBound := lowerBounds[category]
  1197. if !math.IsInf(upperBound, 1) && !math.IsInf(lowerBound, -1) {
  1198. // decay item
  1199. score -= lowerBound
  1200. if score < 0 {
  1201. continue
  1202. } else if positiveItems.Contains(itemId) {
  1203. score *= w.Config.Recommend.Replacement.PositiveReplacementDecay
  1204. } else {
  1205. score *= w.Config.Recommend.Replacement.ReadReplacementDecay
  1206. }
  1207. score += lowerBound
  1208. }
  1209. newRecommend[category] = append(newRecommend[category], cache.Document{Id: itemId, Score: score})
  1210. }
  1211. } else {
  1212. log.Logger().Warn("item doesn't exists in database", zap.String("item_id", itemId))
  1213. }
  1214. }
  1215. // rank items
  1216. for _, r := range newRecommend {
  1217. cache.SortDocuments(r)
  1218. }
  1219. return newRecommend, nil
  1220. }
  1221. type HealthStatus struct {
  1222. DataStoreError error
  1223. CacheStoreError error
  1224. DataStoreConnected bool
  1225. CacheStoreConnected bool
  1226. }
  1227. func (w *Worker) checkHealth() HealthStatus {
  1228. healthStatus := HealthStatus{}
  1229. healthStatus.DataStoreError = w.DataClient.Ping()
  1230. healthStatus.CacheStoreError = w.CacheClient.Ping()
  1231. healthStatus.DataStoreConnected = healthStatus.DataStoreError == nil
  1232. healthStatus.CacheStoreConnected = healthStatus.CacheStoreError == nil
  1233. return healthStatus
  1234. }
  1235. func (w *Worker) checkLive(writer http.ResponseWriter, _ *http.Request) {
  1236. healthStatus := w.checkHealth()
  1237. writeJSON(writer, healthStatus)
  1238. }
  1239. // ItemCache is alias of map[string]data.Item.
  1240. type ItemCache struct {
  1241. Data map[string]*data.Item
  1242. ByteCount uintptr
  1243. }
  1244. func NewItemCache() *ItemCache {
  1245. return &ItemCache{Data: make(map[string]*data.Item)}
  1246. }
  1247. func (c *ItemCache) Len() int {
  1248. return len(c.Data)
  1249. }
  1250. func (c *ItemCache) Set(itemId string, item data.Item) {
  1251. if _, exist := c.Data[itemId]; !exist {
  1252. c.Data[itemId] = &item
  1253. c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(itemId))
  1254. c.ByteCount += reflect.TypeOf(item.ItemId).Size() * uintptr(len(itemId))
  1255. c.ByteCount += reflect.TypeOf(item.Comment).Size() * uintptr(len(itemId))
  1256. c.ByteCount += encoding.StringsBytes(item.Categories)
  1257. c.ByteCount += reflect.TypeOf(item).Size()
  1258. }
  1259. }
  1260. func (c *ItemCache) Get(itemId string) (*data.Item, bool) {
  1261. item, exist := c.Data[itemId]
  1262. return item, exist
  1263. }
  1264. func (c *ItemCache) GetCategory(itemId string) []string {
  1265. if item, exist := c.Data[itemId]; exist {
  1266. return item.Categories
  1267. } else {
  1268. return nil
  1269. }
  1270. }
  1271. // IsAvailable means the item exists in database and is not hidden.
  1272. func (c *ItemCache) IsAvailable(itemId string) bool {
  1273. if item, exist := c.Data[itemId]; exist {
  1274. return !item.IsHidden
  1275. } else {
  1276. return false
  1277. }
  1278. }
  1279. func (c *ItemCache) Bytes() int {
  1280. return int(c.ByteCount)
  1281. }
  1282. // FeedbackCache is the cache for user feedbacks.
  1283. type FeedbackCache struct {
  1284. *config.Config
  1285. Client data.Database
  1286. Types []string
  1287. Cache cmap.ConcurrentMap
  1288. ByteCount uintptr
  1289. }
  1290. // NewFeedbackCache creates a new FeedbackCache.
  1291. func NewFeedbackCache(worker *Worker, feedbackTypes ...string) *FeedbackCache {
  1292. return &FeedbackCache{
  1293. Config: worker.Config,
  1294. Client: worker.DataClient,
  1295. Types: feedbackTypes,
  1296. Cache: cmap.New(),
  1297. }
  1298. }
  1299. // GetUserFeedback gets user feedback from cache or database.
  1300. func (c *FeedbackCache) GetUserFeedback(ctx context.Context, userId string) ([]string, error) {
  1301. if tmp, ok := c.Cache.Get(userId); ok {
  1302. return tmp.([]string), nil
  1303. } else {
  1304. items := make([]string, 0)
  1305. feedbacks, err := c.Client.GetUserFeedback(ctx, userId, c.Config.Now(), c.Types...)
  1306. if err != nil {
  1307. return nil, err
  1308. }
  1309. for _, feedback := range feedbacks {
  1310. items = append(items, feedback.ItemId)
  1311. c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(feedback.FeedbackType))
  1312. c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(feedback.UserId))
  1313. c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(feedback.ItemId))
  1314. c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(feedback.Comment))
  1315. }
  1316. c.Cache.Set(userId, items)
  1317. c.ByteCount += reflect.TypeOf(feedbacks).Elem().Size() * uintptr(len(feedbacks))
  1318. c.ByteCount += reflect.TypeOf(rune(0)).Size() * uintptr(len(userId))
  1319. return items, nil
  1320. }
  1321. }
  1322. func (c *FeedbackCache) Bytes() int {
  1323. return int(c.ByteCount)
  1324. }