com.johnsnowlabs.nlp.HasClsTokenProperties.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spark-nlp_2.12 Show documentation

spark-nlp

There is a newer version: 6.0.3

/*
 * Copyright 2017-2025 John Snow Labs
 *
 * 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 com.johnsnowlabs.nlp

import org.apache.spark.ml.param.BooleanParam

trait HasClsTokenProperties extends ParamsAndFeaturesWritable {

  val useCLSToken = new BooleanParam(
    this,
    "useCLSToken",
    "Whether to use CLS token for pooling (true) or attention-based average pooling (false)")

  /** @group setParam */
  def setUseCLSToken(value: Boolean): this.type = set(useCLSToken, value)

  /** @group getParam */
  def getUseCLSToken: Boolean = $(useCLSToken)

  // Set default to false for backwards compatibility
  setDefault(useCLSToken -> true)

}