com.alibaba.alink.params.evaluation.EvalClusterParams Maven / Gradle / Ivy

package com.alibaba.alink.params.evaluation;

import com.alibaba.alink.params.shared.clustering.HasDistanceType;
import com.alibaba.alink.params.shared.colname.HasPredictionCol;

import org.apache.flink.ml.api.misc.param.ParamInfo;
import org.apache.flink.ml.api.misc.param.ParamInfoFactory;

/**
 * Params for EvalCluster.
 */
public interface EvalClusterParams extends
	HasPredictionCol ,
	HasDistanceType {

	ParamInfo  LABEL_COL = ParamInfoFactory
		.createParamInfo("labelCol", String.class)
		.setDescription("Name of the label column in the input table")
		.setAlias(new String[] {"labelColName"})
		.setHasDefaultValue(null)
		.build();

	default String getLabelCol() {
		return get(LABEL_COL);
	}

	default T setLabelCol(String value) {
		return set(LABEL_COL, value);
	}

	ParamInfo  VECTOR_COL = ParamInfoFactory
		.createParamInfo("vectorCol", String.class)
		.setDescription("Name of a vector column")
		.setHasDefaultValue(null)
		.setAlias(new String[] {"vectorColName", "tensorColName", "vecColName"})
		.build();

	default String getVectorCol() {
		return get(VECTOR_COL);
	}

	default T setVectorCol(String value) {
		return set(VECTOR_COL, value);
	}
}