mirror of
https://github.com/twitter/the-algorithm.git
synced 2024-06-01 08:48:46 +02:00
ef4c5eb65e
Please note we have force-pushed a new initial commit in order to remove some publicly-available Twitter user information. Note that this process may be required in the future.
44 lines
1.9 KiB
Scala
44 lines
1.9 KiB
Scala
package com.twitter.product_mixer.component_library.scorer.param_gated
|
|
|
|
import com.twitter.product_mixer.component_library.scorer.param_gated.ParamGatedScorer.IdentifierPrefix
|
|
import com.twitter.product_mixer.core.feature.Feature
|
|
import com.twitter.product_mixer.core.feature.featuremap.FeatureMap
|
|
import com.twitter.product_mixer.core.functional_component.common.alert.Alert
|
|
import com.twitter.product_mixer.core.functional_component.scorer.Scorer
|
|
import com.twitter.product_mixer.core.model.common.CandidateWithFeatures
|
|
import com.twitter.product_mixer.core.model.common.Conditionally
|
|
import com.twitter.product_mixer.core.model.common.UniversalNoun
|
|
import com.twitter.product_mixer.core.model.common.identifier.ScorerIdentifier
|
|
import com.twitter.product_mixer.core.pipeline.PipelineQuery
|
|
import com.twitter.stitch.Stitch
|
|
import com.twitter.timelines.configapi.Param
|
|
|
|
/**
|
|
* A [[scorer]] with [[Conditionally]] based on a [[Param]]
|
|
*
|
|
* @param enabledParam the param to turn this [[scorer]] on and off
|
|
* @param scorer the underlying [[scorer]] to run when `enabledParam` is true
|
|
* @tparam Query The domain model for the query or request
|
|
* @tparam Result The type of the candidates
|
|
*/
|
|
case class ParamGatedScorer[-Query <: PipelineQuery, Result <: UniversalNoun[Any]](
|
|
enabledParam: Param[Boolean],
|
|
scorer: Scorer[Query, Result])
|
|
extends Scorer[Query, Result]
|
|
with Conditionally[Query] {
|
|
override val identifier: ScorerIdentifier = ScorerIdentifier(
|
|
IdentifierPrefix + scorer.identifier.name)
|
|
override val alerts: Seq[Alert] = scorer.alerts
|
|
override val features: Set[Feature[_, _]] = scorer.features
|
|
override def onlyIf(query: Query): Boolean =
|
|
Conditionally.and(query, scorer, query.params(enabledParam))
|
|
override def apply(
|
|
query: Query,
|
|
candidates: Seq[CandidateWithFeatures[Result]]
|
|
): Stitch[Seq[FeatureMap]] = scorer(query, candidates)
|
|
}
|
|
|
|
object ParamGatedScorer {
|
|
val IdentifierPrefix = "ParamGated"
|
|
}
|