lindong28 commented on code in PR #139: URL: https://github.com/apache/flink-ml/pull/139#discussion_r947463284
########## flink-ml-lib/src/main/java/org/apache/flink/ml/feature/kbinsdiscretizer/KBinsDiscretizer.java: ########## @@ -0,0 +1,341 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.flink.ml.feature.kbinsdiscretizer; + +import org.apache.flink.api.common.functions.MapFunction; +import org.apache.flink.api.common.functions.MapPartitionFunction; +import org.apache.flink.ml.api.Estimator; +import org.apache.flink.ml.common.datastream.DataStreamUtils; +import org.apache.flink.ml.feature.minmaxscaler.MinMaxScaler.MinMaxReduceFunctionOperator; +import org.apache.flink.ml.linalg.DenseVector; +import org.apache.flink.ml.linalg.Vector; +import org.apache.flink.ml.param.Param; +import org.apache.flink.ml.util.ParamUtils; +import org.apache.flink.ml.util.ReadWriteUtils; +import org.apache.flink.streaming.api.datastream.DataStream; +import org.apache.flink.table.api.Table; +import org.apache.flink.table.api.bridge.java.StreamTableEnvironment; +import org.apache.flink.table.api.internal.TableImpl; +import org.apache.flink.types.Row; +import org.apache.flink.util.Collector; +import org.apache.flink.util.Preconditions; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * An Estimator which implements discretization (also known as quantization or binning), which + * transforms continuous features into discrete ones. The output values are in [0, numBins). + * + * <p>KBinsDiscretizer implements three different binning strategies, and it can be set by {@link + * KBinsDiscretizerParams#STRATEGY}. If the strategy is set as {@link KBinsDiscretizerParams#KMEANS} + * or {@link KBinsDiscretizerParams#QUANTILE}, users should further set {@link + * KBinsDiscretizerParams#SUB_SAMPLES} for better performance. + * + * <p>There are several corner cases for different inputs as listed below: + * + * <ul> + * <li>When the input values of one column are all the same, then they should be mapped to the + * same bin (i.e., the zero-th bin). Thus the corresponding bin edges are `{Double.MIN_VALUE, + * Double.MAX_VALUE}`. + * <li>When the number of distinct values of one column is less than the specified number of bins + * and the {@link KBinsDiscretizerParams#STRATEGY} is set as {@link + * KBinsDiscretizerParams#KMEANS}, we switch to {@link KBinsDiscretizerParams#UNIFORM}. + * <li>When the width of one output bin is zero, i.e., the left edge equals to the right edge of + * the bin, we remove it. + * </ul> + */ +public class KBinsDiscretizer + implements Estimator<KBinsDiscretizer, KBinsDiscretizerModel>, + KBinsDiscretizerParams<KBinsDiscretizer> { + private static final Logger LOG = LoggerFactory.getLogger(KBinsDiscretizer.class); + private final Map<Param<?>, Object> paramMap = new HashMap<>(); + + public KBinsDiscretizer() { + ParamUtils.initializeMapWithDefaultValues(paramMap, this); + } + + @Override + public KBinsDiscretizerModel fit(Table... inputs) { + Preconditions.checkArgument(inputs.length == 1); + StreamTableEnvironment tEnv = + (StreamTableEnvironment) ((TableImpl) inputs[0]).getTableEnvironment(); + + String inputCol = getInputCol(); + String strategy = getStrategy(); + int numBins = getNumBins(); + + DataStream<DenseVector> inputData = + tEnv.toDataStream(inputs[0]) + .map( + (MapFunction<Row, DenseVector>) + value -> ((Vector) value.getField(inputCol)).toDense()); + + DataStream<DenseVector> preprocessedData; + if (strategy.equals(UNIFORM)) { + preprocessedData = + inputData + .transform( + "reduceInEachPartition", + inputData.getType(), + new MinMaxReduceFunctionOperator()) + .transform( + "reduceInFinalPartition", + inputData.getType(), + new MinMaxReduceFunctionOperator()) + .setParallelism(1); + } else { + preprocessedData = + DataStreamUtils.sample( + inputData, getSubSamples(), getClass().getName().hashCode()); + } + + DataStream<KBinsDiscretizerModelData> modelData = + DataStreamUtils.mapPartition( + preprocessedData, + new MapPartitionFunction<DenseVector, KBinsDiscretizerModelData>() { + @Override + public void mapPartition( + Iterable<DenseVector> iterable, + Collector<KBinsDiscretizerModelData> collector) { + List<DenseVector> list = new ArrayList<>(); + iterable.iterator().forEachRemaining(list::add); + + if (list.size() == 0) { + throw new RuntimeException("The training set is empty."); + } + + double[][] binEdges; + switch (strategy) { + case UNIFORM: + binEdges = findBinEdgesWithUniformStrategy(list, numBins); + break; + case QUANTILE: + binEdges = findBinEdgesWithQuantileStrategy(list, numBins); + break; + case KMEANS: + binEdges = findBinEdgesWithKMeansStrategy(list, numBins); + break; + default: + throw new UnsupportedOperationException( + "Unsupported " + + STRATEGY + + " type: " + + strategy + + "."); + } + + collector.collect(new KBinsDiscretizerModelData(binEdges)); + } + }); + modelData.getTransformation().setParallelism(1); + + KBinsDiscretizerModel model = + new KBinsDiscretizerModel().setModelData(tEnv.fromDataStream(modelData)); + ReadWriteUtils.updateExistingParams(model, getParamMap()); + return model; + } + + @Override + public Map<Param<?>, Object> getParamMap() { + return paramMap; + } + + @Override + public void save(String path) throws IOException { + ReadWriteUtils.saveMetadata(this, path); + } + + public static KBinsDiscretizer load(StreamTableEnvironment tEnv, String path) + throws IOException { + return ReadWriteUtils.loadStageParam(path); + } + + private static double[][] findBinEdgesWithUniformStrategy( + List<DenseVector> input, int numBins) { + DenseVector minVector = input.get(0); + DenseVector maxVector = input.get(1); + int numColumns = minVector.size(); + double[][] binEdges = new double[numColumns][]; + + for (int columnId = 0; columnId < numColumns; columnId++) { + double min = minVector.get(columnId); + double max = maxVector.get(columnId); + if (min == max) { + LOG.warn("Feature " + columnId + " is constant and the output will all be zero."); + binEdges[columnId] = new double[] {Double.MIN_VALUE, Double.MAX_VALUE}; + } else { + double width = (max - min) / numBins; + binEdges[columnId] = new double[numBins + 1]; + binEdges[columnId][0] = min; + for (int edgeId = 1; edgeId < numBins + 1; edgeId++) { + binEdges[columnId][edgeId] = binEdges[columnId][edgeId - 1] + width; + } + } + } + return binEdges; + } + + private static double[][] findBinEdgesWithQuantileStrategy( + List<DenseVector> input, int numBins) { + int numColumns = input.get(0).size(); + int numData = input.size(); + double[][] binEdges = new double[numColumns][]; + double[] features = new double[numData]; + + for (int columnId = 0; columnId < numColumns; columnId++) { + for (int i = 0; i < numData; i++) { + features[i] = input.get(i).get(columnId); + } + Arrays.sort(features); + + if (features[0] == features[numData - 1]) { + LOG.warn("Feature " + columnId + " is constant and the output will all be zero."); + binEdges[columnId] = new double[] {Double.MIN_VALUE, Double.MAX_VALUE}; + } else { + double width = 1.0 * features.length / numBins; + double[] tempBinEdges = new double[numBins + 1]; + + for (int binEdgeId = 0; binEdgeId < numBins; binEdgeId++) { + tempBinEdges[binEdgeId] = features[(int) (binEdgeId * width)]; + } + tempBinEdges[numBins] = features[numData - 1]; + + // Removes bins who are empty, i.e., the left edge equals to the right edge. + Set<Double> edges = new HashSet<>(numBins); + for (double edge : tempBinEdges) { + edges.add(edge); + } + + binEdges[columnId] = edges.stream().mapToDouble(Double::doubleValue).toArray(); + Arrays.sort(binEdges[columnId]); + } + } + return binEdges; + } + + private static double[][] findBinEdgesWithKMeansStrategy(List<DenseVector> input, int numBins) { + int numColumns = input.get(0).size(); + int numData = input.size(); + double[][] binEdges = new double[numColumns][numBins + 1]; + double[] features = new double[numData]; + + double[] kMeansCentroids = new double[numBins]; + double[] sumByCluster = new double[numBins]; + + for (int columnId = 0; columnId < numColumns; columnId++) { + for (int i = 0; i < numData; i++) { + features[i] = input.get(i).get(columnId); + } + Arrays.sort(features); + + if (features[0] == features[numData - 1]) { + LOG.warn("Feature " + columnId + " is constant and the output will all be zero."); + binEdges[columnId] = new double[] {Double.MIN_VALUE, Double.MAX_VALUE}; + } else { + // Checks whether there are more than {numBins} distinct feature values in each + // column. + // If the number of distinct values is less than {numBins + 1}, then we do not need + // to conduct KMeans. Instead, we switch to use {@link Review Comment: nits: `use` -> `using` ########## flink-ml-lib/src/main/java/org/apache/flink/ml/feature/kbinsdiscretizer/KBinsDiscretizer.java: ########## @@ -0,0 +1,341 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.flink.ml.feature.kbinsdiscretizer; + +import org.apache.flink.api.common.functions.MapFunction; +import org.apache.flink.api.common.functions.MapPartitionFunction; +import org.apache.flink.ml.api.Estimator; +import org.apache.flink.ml.common.datastream.DataStreamUtils; +import org.apache.flink.ml.feature.minmaxscaler.MinMaxScaler.MinMaxReduceFunctionOperator; +import org.apache.flink.ml.linalg.DenseVector; +import org.apache.flink.ml.linalg.Vector; +import org.apache.flink.ml.param.Param; +import org.apache.flink.ml.util.ParamUtils; +import org.apache.flink.ml.util.ReadWriteUtils; +import org.apache.flink.streaming.api.datastream.DataStream; +import org.apache.flink.table.api.Table; +import org.apache.flink.table.api.bridge.java.StreamTableEnvironment; +import org.apache.flink.table.api.internal.TableImpl; +import org.apache.flink.types.Row; +import org.apache.flink.util.Collector; +import org.apache.flink.util.Preconditions; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * An Estimator which implements discretization (also known as quantization or binning), which Review Comment: nits: maybe rephrase this sentence like this: ``` * An Estimator which implements discretization (also known as quantization or binning) to * transform continuous features into discrete ones. The output values are in [0, numBins). ``` ########## flink-ml-lib/src/main/java/org/apache/flink/ml/feature/kbinsdiscretizer/KBinsDiscretizer.java: ########## @@ -0,0 +1,341 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.flink.ml.feature.kbinsdiscretizer; + +import org.apache.flink.api.common.functions.MapFunction; +import org.apache.flink.api.common.functions.MapPartitionFunction; +import org.apache.flink.ml.api.Estimator; +import org.apache.flink.ml.common.datastream.DataStreamUtils; +import org.apache.flink.ml.feature.minmaxscaler.MinMaxScaler.MinMaxReduceFunctionOperator; +import org.apache.flink.ml.linalg.DenseVector; +import org.apache.flink.ml.linalg.Vector; +import org.apache.flink.ml.param.Param; +import org.apache.flink.ml.util.ParamUtils; +import org.apache.flink.ml.util.ReadWriteUtils; +import org.apache.flink.streaming.api.datastream.DataStream; +import org.apache.flink.table.api.Table; +import org.apache.flink.table.api.bridge.java.StreamTableEnvironment; +import org.apache.flink.table.api.internal.TableImpl; +import org.apache.flink.types.Row; +import org.apache.flink.util.Collector; +import org.apache.flink.util.Preconditions; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * An Estimator which implements discretization (also known as quantization or binning), which + * transforms continuous features into discrete ones. The output values are in [0, numBins). + * + * <p>KBinsDiscretizer implements three different binning strategies, and it can be set by {@link + * KBinsDiscretizerParams#STRATEGY}. If the strategy is set as {@link KBinsDiscretizerParams#KMEANS} + * or {@link KBinsDiscretizerParams#QUANTILE}, users should further set {@link + * KBinsDiscretizerParams#SUB_SAMPLES} for better performance. + * + * <p>There are several corner cases for different inputs as listed below: + * + * <ul> + * <li>When the input values of one column are all the same, then they should be mapped to the + * same bin (i.e., the zero-th bin). Thus the corresponding bin edges are `{Double.MIN_VALUE, + * Double.MAX_VALUE}`. + * <li>When the number of distinct values of one column is less than the specified number of bins + * and the {@link KBinsDiscretizerParams#STRATEGY} is set as {@link + * KBinsDiscretizerParams#KMEANS}, we switch to {@link KBinsDiscretizerParams#UNIFORM}. + * <li>When the width of one output bin is zero, i.e., the left edge equals to the right edge of + * the bin, we remove it. + * </ul> + */ +public class KBinsDiscretizer + implements Estimator<KBinsDiscretizer, KBinsDiscretizerModel>, + KBinsDiscretizerParams<KBinsDiscretizer> { + private static final Logger LOG = LoggerFactory.getLogger(KBinsDiscretizer.class); + private final Map<Param<?>, Object> paramMap = new HashMap<>(); + + public KBinsDiscretizer() { + ParamUtils.initializeMapWithDefaultValues(paramMap, this); + } + + @Override + public KBinsDiscretizerModel fit(Table... inputs) { + Preconditions.checkArgument(inputs.length == 1); + StreamTableEnvironment tEnv = + (StreamTableEnvironment) ((TableImpl) inputs[0]).getTableEnvironment(); + + String inputCol = getInputCol(); + String strategy = getStrategy(); + int numBins = getNumBins(); + + DataStream<DenseVector> inputData = + tEnv.toDataStream(inputs[0]) + .map( + (MapFunction<Row, DenseVector>) + value -> ((Vector) value.getField(inputCol)).toDense()); + + DataStream<DenseVector> preprocessedData; + if (strategy.equals(UNIFORM)) { + preprocessedData = + inputData + .transform( + "reduceInEachPartition", + inputData.getType(), + new MinMaxReduceFunctionOperator()) + .transform( + "reduceInFinalPartition", + inputData.getType(), + new MinMaxReduceFunctionOperator()) + .setParallelism(1); + } else { + preprocessedData = + DataStreamUtils.sample( + inputData, getSubSamples(), getClass().getName().hashCode()); + } + + DataStream<KBinsDiscretizerModelData> modelData = + DataStreamUtils.mapPartition( + preprocessedData, + new MapPartitionFunction<DenseVector, KBinsDiscretizerModelData>() { + @Override + public void mapPartition( + Iterable<DenseVector> iterable, + Collector<KBinsDiscretizerModelData> collector) { + List<DenseVector> list = new ArrayList<>(); + iterable.iterator().forEachRemaining(list::add); + + if (list.size() == 0) { + throw new RuntimeException("The training set is empty."); + } + + double[][] binEdges; + switch (strategy) { + case UNIFORM: + binEdges = findBinEdgesWithUniformStrategy(list, numBins); + break; + case QUANTILE: + binEdges = findBinEdgesWithQuantileStrategy(list, numBins); + break; + case KMEANS: + binEdges = findBinEdgesWithKMeansStrategy(list, numBins); + break; + default: + throw new UnsupportedOperationException( + "Unsupported " + + STRATEGY + + " type: " + + strategy + + "."); + } + + collector.collect(new KBinsDiscretizerModelData(binEdges)); + } + }); + modelData.getTransformation().setParallelism(1); + + KBinsDiscretizerModel model = + new KBinsDiscretizerModel().setModelData(tEnv.fromDataStream(modelData)); + ReadWriteUtils.updateExistingParams(model, getParamMap()); + return model; + } + + @Override + public Map<Param<?>, Object> getParamMap() { + return paramMap; + } + + @Override + public void save(String path) throws IOException { + ReadWriteUtils.saveMetadata(this, path); + } + + public static KBinsDiscretizer load(StreamTableEnvironment tEnv, String path) + throws IOException { + return ReadWriteUtils.loadStageParam(path); + } + + private static double[][] findBinEdgesWithUniformStrategy( + List<DenseVector> input, int numBins) { + DenseVector minVector = input.get(0); + DenseVector maxVector = input.get(1); + int numColumns = minVector.size(); + double[][] binEdges = new double[numColumns][]; + + for (int columnId = 0; columnId < numColumns; columnId++) { + double min = minVector.get(columnId); + double max = maxVector.get(columnId); + if (min == max) { + LOG.warn("Feature " + columnId + " is constant and the output will all be zero."); + binEdges[columnId] = new double[] {Double.MIN_VALUE, Double.MAX_VALUE}; + } else { + double width = (max - min) / numBins; + binEdges[columnId] = new double[numBins + 1]; + binEdges[columnId][0] = min; + for (int edgeId = 1; edgeId < numBins + 1; edgeId++) { + binEdges[columnId][edgeId] = binEdges[columnId][edgeId - 1] + width; + } + } + } + return binEdges; + } + + private static double[][] findBinEdgesWithQuantileStrategy( + List<DenseVector> input, int numBins) { + int numColumns = input.get(0).size(); + int numData = input.size(); + double[][] binEdges = new double[numColumns][]; + double[] features = new double[numData]; + + for (int columnId = 0; columnId < numColumns; columnId++) { + for (int i = 0; i < numData; i++) { + features[i] = input.get(i).get(columnId); + } + Arrays.sort(features); + + if (features[0] == features[numData - 1]) { + LOG.warn("Feature " + columnId + " is constant and the output will all be zero."); + binEdges[columnId] = new double[] {Double.MIN_VALUE, Double.MAX_VALUE}; + } else { + double width = 1.0 * features.length / numBins; + double[] tempBinEdges = new double[numBins + 1]; + + for (int binEdgeId = 0; binEdgeId < numBins; binEdgeId++) { + tempBinEdges[binEdgeId] = features[(int) (binEdgeId * width)]; + } + tempBinEdges[numBins] = features[numData - 1]; + + // Removes bins who are empty, i.e., the left edge equals to the right edge. Review Comment: nits: `who` -> `that` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
