com.johnsnowlabs.nlp.annotators.spell.symmetric.SymmetricDeleteParams.scala Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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.annotators.spell.symmetric
import org.apache.spark.ml.param.{IntParam, LongParam, Params}
/** @groupname anno Annotator types
* @groupdesc anno
* Required input and expected output annotator types
* @groupname Ungrouped Members
* @groupname param Parameters
* @groupname setParam Parameter setters
* @groupname getParam Parameter getters
* @groupname Ungrouped Members
* @groupprio param 1
* @groupprio anno 2
* @groupprio Ungrouped 3
* @groupprio setParam 4
* @groupprio getParam 5
* @groupdesc param
* A list of (hyper-)parameter keys this annotator can take. Users can set and get the
* parameter values through setters and getters, respectively.
*/
trait SymmetricDeleteParams extends Params {
/** Max edit distance characters to derive strings from a word (Default: `3`)
*
* @group param
*/
val maxEditDistance = new IntParam(
this,
"maxEditDistance",
"max edit distance characters to derive strings from a word")
/** Minimum frequency of words to be considered from training. Increase if training set is LARGE
* (Default: `0`).
*
* @group param
*/
val frequencyThreshold = new IntParam(
this,
"frequencyThreshold",
"minimum frequency of words to be considered from training. Increase if training set is LARGE. Defaults to 0")
/** Minimum frequency of corrections a word needs to have to be considered from training.
* Increase if training set is LARGE (Default: `0`).
*
* @group param
*/
val deletesThreshold = new IntParam(
this,
"deletesThreshold",
"minimum frequency of corrections a word needs to have to be considered from training. Increase if training set is LARGE. Defaults to 0")
/** Maximum duplicate of characters in a word to consider (Default: `2`).
*
* @group param
*/
val dupsLimit = new IntParam(
this,
"dupsLimit",
"maximum duplicate of characters in a word to consider. Defaults to 2")
/** Length of longest word in corpus
*
* @group param
*/
val longestWordLength =
new IntParam(this, "longestWordLength", "length of longest word in corpus")
/** Minimum frequency of a word in the corpus
*
* @group param
*/
val minFrequency =
new LongParam(this, "minFrequency", "minimum frequency of a word in the corpus")
/** Maximum frequency of a word in the corpus
*
* @group param
*/
val maxFrequency =
new LongParam(this, "maxFrequency", "maximum frequency of a word in the corpus")
/** Max edit distance characters to derive strings from a word
*
* @group setParam
*/
def setMaxEditDistance(value: Int): this.type = set(maxEditDistance, value)
/** Minimum frequency of words to be considered from training. Increase if training set is LARGE
* (Default: `0`)
*
* @group setParam
*/
def setFrequencyThreshold(value: Int): this.type = set(frequencyThreshold, value)
/** Minimum frequency of corrections a word needs to have to be considered from training.
* Increase if training set is LARGE (Default: `0`).
*
* @group setParam
*/
def setDeletesThreshold(value: Int): this.type = set(deletesThreshold, value)
/** Maximum duplicate of characters in a word to consider (Default: `2`)
*
* @group setParam
*/
def setDupsLimit(value: Int): this.type = set(dupsLimit, value)
/** Length of longest word in corpus
*
* @group setParam
*/
def setLongestWordLength(value: Int): this.type = set(longestWordLength, value)
/** Maximum frequency of a word in the corpus
*
* @group setParam
*/
def setMaxFrequency(value: Long): this.type = set(maxFrequency, value)
/** Minimum frequency of a word in the corpus
*
* @group setParam
*/
def setMinFrequency(value: Long): this.type = set(minFrequency, value)
/** Max edit distance characters to derive strings from a word
*
* @group getParam
*/
def getMaxEditDistance: Int = $(maxEditDistance)
/** Minimum frequency of words to be considered from training. Increase if training set is LARGE
* (Default: `0`).
*
* @group getParam
*/
def getFrequencyThreshold: Int = $(frequencyThreshold)
/** Minimum frequency of corrections a word needs to have to be considered from training.
* Increase if training set is LARGE (Default: `0`).
*
* @group getParam
*/
def getDeletesThreshold: Int = $(deletesThreshold)
/** Maximum duplicate of characters in a word to consider (Default: `2`).
*
* @group getParam
*/
def getDupsLimit: Int = $(dupsLimit)
}