/
CrCandidateGenerator.scala
350 lines (318 loc) · 12.6 KB
/
CrCandidateGenerator.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
package com.twitter.cr_mixer.candidate_generation
import com.twitter.cr_mixer.blender.SwitchBlender
import com.twitter.cr_mixer.config.TimeoutConfig
import com.twitter.cr_mixer.filter.PostRankFilterRunner
import com.twitter.cr_mixer.filter.PreRankFilterRunner
import com.twitter.cr_mixer.logging.CrMixerScribeLogger
import com.twitter.cr_mixer.model.BlendedCandidate
import com.twitter.cr_mixer.model.CrCandidateGeneratorQuery
import com.twitter.cr_mixer.model.GraphSourceInfo
import com.twitter.cr_mixer.model.InitialCandidate
import com.twitter.cr_mixer.model.RankedCandidate
import com.twitter.cr_mixer.model.SourceInfo
import com.twitter.cr_mixer.param.RankerParams
import com.twitter.cr_mixer.param.RecentNegativeSignalParams
import com.twitter.cr_mixer.ranker.SwitchRanker
import com.twitter.cr_mixer.source_signal.SourceInfoRouter
import com.twitter.cr_mixer.source_signal.UssStore.EnabledNegativeSourceTypes
import com.twitter.finagle.stats.StatsReceiver
import com.twitter.frigate.common.util.StatsUtil
import com.twitter.simclusters_v2.thriftscala.InternalId
import com.twitter.util.Future
import com.twitter.util.JavaTimer
import com.twitter.util.Timer
import javax.inject.Inject
import javax.inject.Singleton
/**
* For now it performs the main steps as follows:
* 1. Source signal (via USS, FRS) fetch
* 2. Candidate generation
* 3. Filtering
* 4. Interleave blender
* 5. Ranker
* 6. Post-ranker filter
* 7. Truncation
*/
@Singleton
class CrCandidateGenerator @Inject() (
sourceInfoRouter: SourceInfoRouter,
candidateSourceRouter: CandidateSourcesRouter,
switchBlender: SwitchBlender,
preRankFilterRunner: PreRankFilterRunner,
postRankFilterRunner: PostRankFilterRunner,
switchRanker: SwitchRanker,
crMixerScribeLogger: CrMixerScribeLogger,
timeoutConfig: TimeoutConfig,
globalStats: StatsReceiver) {
private val timer: Timer = new JavaTimer(true)
private val stats: StatsReceiver = globalStats.scope(this.getClass.getCanonicalName)
private val fetchSourcesStats = stats.scope("fetchSources")
private val fetchPositiveSourcesStats = stats.scope("fetchPositiveSources")
private val fetchNegativeSourcesStats = stats.scope("fetchNegativeSources")
private val fetchCandidatesStats = stats.scope("fetchCandidates")
private val fetchCandidatesAfterFilterStats = stats.scope("fetchCandidatesAfterFilter")
private val preRankFilterStats = stats.scope("preRankFilter")
private val interleaveStats = stats.scope("interleave")
private val rankStats = stats.scope("rank")
private val postRankFilterStats = stats.scope("postRankFilter")
private val blueVerifiedTweetStats = stats.scope("blueVerifiedTweetStats")
private val blueVerifiedTweetStatsPerSimilarityEngine =
stats.scope("blueVerifiedTweetStatsPerSimilarityEngine")
def get(query: CrCandidateGeneratorQuery): Future[Seq[RankedCandidate]] = {
val allStats = stats.scope("all")
val perProductStats = stats.scope("perProduct", query.product.toString)
val perProductBlueVerifiedStats =
blueVerifiedTweetStats.scope("perProduct", query.product.toString)
StatsUtil.trackItemsStats(allStats) {
trackResultStats(perProductStats) {
StatsUtil.trackItemsStats(perProductStats) {
val result = for {
(sourceSignals, sourceGraphsMap) <- StatsUtil.trackBlockStats(fetchSourcesStats) {
fetchSources(query)
}
initialCandidates <- StatsUtil.trackBlockStats(fetchCandidatesAfterFilterStats) {
// find the positive and negative signals
val (positiveSignals, negativeSignals) = sourceSignals.partition { signal =>
!EnabledNegativeSourceTypes.contains(signal.sourceType)
}
fetchPositiveSourcesStats.stat("size").add(positiveSignals.size)
fetchNegativeSourcesStats.stat("size").add(negativeSignals.size)
// find the positive signals to keep, removing block and muted users
val filteredSourceInfo =
if (negativeSignals.nonEmpty && query.params(
RecentNegativeSignalParams.EnableSourceParam)) {
filterSourceInfo(positiveSignals, negativeSignals)
} else {
positiveSignals
}
// fetch candidates from the positive signals
StatsUtil.trackBlockStats(fetchCandidatesStats) {
fetchCandidates(query, filteredSourceInfo, sourceGraphsMap)
}
}
filteredCandidates <- StatsUtil.trackBlockStats(preRankFilterStats) {
preRankFilter(query, initialCandidates)
}
interleavedCandidates <- StatsUtil.trackItemsStats(interleaveStats) {
interleave(query, filteredCandidates)
}
rankedCandidates <- StatsUtil.trackItemsStats(rankStats) {
val candidatesToRank =
interleavedCandidates.take(query.params(RankerParams.MaxCandidatesToRank))
rank(query, candidatesToRank)
}
postRankFilterCandidates <- StatsUtil.trackItemsStats(postRankFilterStats) {
postRankFilter(query, rankedCandidates)
}
} yield {
trackTopKStats(
800,
postRankFilterCandidates,
isQueryK = false,
perProductBlueVerifiedStats)
trackTopKStats(
400,
postRankFilterCandidates,
isQueryK = false,
perProductBlueVerifiedStats)
trackTopKStats(
query.maxNumResults,
postRankFilterCandidates,
isQueryK = true,
perProductBlueVerifiedStats)
val (blueVerifiedTweets, remainingTweets) =
postRankFilterCandidates.partition(
_.tweetInfo.hasBlueVerifiedAnnotation.contains(true))
val topKBlueVerified = blueVerifiedTweets.take(query.maxNumResults)
val topKRemaining = remainingTweets.take(query.maxNumResults - topKBlueVerified.size)
trackBlueVerifiedTweetStats(topKBlueVerified, perProductBlueVerifiedStats)
if (topKBlueVerified.nonEmpty && query.params(RankerParams.EnableBlueVerifiedTopK)) {
topKBlueVerified ++ topKRemaining
} else {
postRankFilterCandidates
}
}
result.raiseWithin(timeoutConfig.serviceTimeout)(timer)
}
}
}
}
private def fetchSources(
query: CrCandidateGeneratorQuery
): Future[(Set[SourceInfo], Map[String, Option[GraphSourceInfo]])] = {
crMixerScribeLogger.scribeSignalSources(
query,
sourceInfoRouter
.get(query.userId, query.product, query.userState, query.params))
}
private def filterSourceInfo(
positiveSignals: Set[SourceInfo],
negativeSignals: Set[SourceInfo]
): Set[SourceInfo] = {
val filterUsers: Set[Long] = negativeSignals.flatMap {
case SourceInfo(_, InternalId.UserId(userId), _) => Some(userId)
case _ => None
}
positiveSignals.filter {
case SourceInfo(_, InternalId.UserId(userId), _) => !filterUsers.contains(userId)
case _ => true
}
}
def fetchCandidates(
query: CrCandidateGeneratorQuery,
sourceSignals: Set[SourceInfo],
sourceGraphs: Map[String, Option[GraphSourceInfo]]
): Future[Seq[Seq[InitialCandidate]]] = {
val initialCandidates = candidateSourceRouter
.fetchCandidates(
query.userId,
sourceSignals,
sourceGraphs,
query.params
)
initialCandidates.map(_.flatten.map { candidate =>
if (candidate.tweetInfo.hasBlueVerifiedAnnotation.contains(true)) {
blueVerifiedTweetStatsPerSimilarityEngine
.scope(query.product.toString).scope(
candidate.candidateGenerationInfo.contributingSimilarityEngines.head.similarityEngineType.toString).counter(
candidate.tweetInfo.authorId.toString).incr()
}
})
crMixerScribeLogger.scribeInitialCandidates(
query,
initialCandidates
)
}
private def preRankFilter(
query: CrCandidateGeneratorQuery,
candidates: Seq[Seq[InitialCandidate]]
): Future[Seq[Seq[InitialCandidate]]] = {
crMixerScribeLogger.scribePreRankFilterCandidates(
query,
preRankFilterRunner
.runSequentialFilters(query, candidates))
}
private def postRankFilter(
query: CrCandidateGeneratorQuery,
candidates: Seq[RankedCandidate]
): Future[Seq[RankedCandidate]] = {
postRankFilterRunner.run(query, candidates)
}
private def interleave(
query: CrCandidateGeneratorQuery,
candidates: Seq[Seq[InitialCandidate]]
): Future[Seq[BlendedCandidate]] = {
crMixerScribeLogger.scribeInterleaveCandidates(
query,
switchBlender
.blend(query.params, query.userState, candidates))
}
private def rank(
query: CrCandidateGeneratorQuery,
candidates: Seq[BlendedCandidate],
): Future[Seq[RankedCandidate]] = {
crMixerScribeLogger.scribeRankedCandidates(
query,
switchRanker.rank(query, candidates)
)
}
private def trackResultStats(
stats: StatsReceiver
)(
fn: => Future[Seq[RankedCandidate]]
): Future[Seq[RankedCandidate]] = {
fn.onSuccess { candidates =>
trackReasonChosenSourceTypeStats(candidates, stats)
trackReasonChosenSimilarityEngineStats(candidates, stats)
trackPotentialReasonsSourceTypeStats(candidates, stats)
trackPotentialReasonsSimilarityEngineStats(candidates, stats)
}
}
private def trackReasonChosenSourceTypeStats(
candidates: Seq[RankedCandidate],
stats: StatsReceiver
): Unit = {
candidates
.groupBy(_.reasonChosen.sourceInfoOpt.map(_.sourceType))
.foreach {
case (sourceTypeOpt, rankedCands) =>
val sourceType = sourceTypeOpt.map(_.toString).getOrElse("RequesterId") // default
stats.stat("reasonChosen", "sourceType", sourceType, "size").add(rankedCands.size)
}
}
private def trackReasonChosenSimilarityEngineStats(
candidates: Seq[RankedCandidate],
stats: StatsReceiver
): Unit = {
candidates
.groupBy(_.reasonChosen.similarityEngineInfo.similarityEngineType)
.foreach {
case (seInfoType, rankedCands) =>
stats
.stat("reasonChosen", "similarityEngine", seInfoType.toString, "size").add(
rankedCands.size)
}
}
private def trackPotentialReasonsSourceTypeStats(
candidates: Seq[RankedCandidate],
stats: StatsReceiver
): Unit = {
candidates
.flatMap(_.potentialReasons.map(_.sourceInfoOpt.map(_.sourceType)))
.groupBy(source => source)
.foreach {
case (sourceInfoOpt, seq) =>
val sourceType = sourceInfoOpt.map(_.toString).getOrElse("RequesterId") // default
stats.stat("potentialReasons", "sourceType", sourceType, "size").add(seq.size)
}
}
private def trackPotentialReasonsSimilarityEngineStats(
candidates: Seq[RankedCandidate],
stats: StatsReceiver
): Unit = {
candidates
.flatMap(_.potentialReasons.map(_.similarityEngineInfo.similarityEngineType))
.groupBy(se => se)
.foreach {
case (seType, seq) =>
stats.stat("potentialReasons", "similarityEngine", seType.toString, "size").add(seq.size)
}
}
private def trackBlueVerifiedTweetStats(
candidates: Seq[RankedCandidate],
statsReceiver: StatsReceiver
): Unit = {
candidates.foreach { candidate =>
if (candidate.tweetInfo.hasBlueVerifiedAnnotation.contains(true)) {
statsReceiver.counter(candidate.tweetInfo.authorId.toString).incr()
statsReceiver
.scope(candidate.tweetInfo.authorId.toString).counter(candidate.tweetId.toString).incr()
}
}
}
private def trackTopKStats(
k: Int,
tweetCandidates: Seq[RankedCandidate],
isQueryK: Boolean,
statsReceiver: StatsReceiver
): Unit = {
val (topK, beyondK) = tweetCandidates.splitAt(k)
val blueVerifiedIds = tweetCandidates.collect {
case candidate if candidate.tweetInfo.hasBlueVerifiedAnnotation.contains(true) =>
candidate.tweetInfo.authorId
}.toSet
blueVerifiedIds.foreach { blueVerifiedId =>
val numTweetsTopK = topK.count(_.tweetInfo.authorId == blueVerifiedId)
val numTweetsBeyondK = beyondK.count(_.tweetInfo.authorId == blueVerifiedId)
if (isQueryK) {
statsReceiver.scope(blueVerifiedId.toString).stat(s"topK").add(numTweetsTopK)
statsReceiver
.scope(blueVerifiedId.toString).stat(s"beyondK").add(numTweetsBeyondK)
} else {
statsReceiver.scope(blueVerifiedId.toString).stat(s"top$k").add(numTweetsTopK)
statsReceiver
.scope(blueVerifiedId.toString).stat(s"beyond$k").add(numTweetsBeyondK)
}
}
}
}