xuyang1706 commented on a change in pull request #9300: [FLINK-13513][ml] Add the FlatMapper and related classes for later al… URL: https://github.com/apache/flink/pull/9300#discussion_r337473932
########## File path: flink-ml-parent/flink-ml-lib/src/main/java/org/apache/flink/ml/common/mapper/FlatModelMapper.java ########## @@ -0,0 +1,138 @@ +/* + * 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.common.mapper; + +import org.apache.flink.ml.api.misc.param.Params; +import org.apache.flink.table.api.TableSchema; +import org.apache.flink.types.Row; + +import java.util.List; + +/** + * Abstract class for flatMappers with model. + * + * <p>The general process of transform the input use machine learning model is: + * <ul> + * <li>1. load the model into memory.</li> + * <li>2. process the input using the model.</li> + * </ul> + * So, different from the {@link FlatMapper}, this class has a new abstract method + * named {@link #loadModel(List)} that load the model and transform it to the + * memory structure. + * + * <p>The model is the machine learning model that use the Table as + * its representation(serialized to Table from the memory + * or deserialized from Table to memory). + */ +public abstract class FlatModelMapper extends FlatMapper { + + /** + * schema of the model with Table type. + */ + protected TableSchema modelSchema; + + public FlatModelMapper(TableSchema modelSchema, TableSchema dataSchema, Params params) { + super(dataSchema, params); + this.modelSchema = modelSchema; + } + + /** + * Load model from the list of Row type data. + * + * @param modelRows the list of Row type data + */ + public abstract void loadModel(List<Row> modelRows); + + /** + * Generate new instance of given FlatModelMapper class without model data. + * The instance can not deal with real data, but it could be used to get the output result schema. + * + * @param flatModelMapperClassName Name of the FlatModelMapper class + * @param modelScheme The model scheme represented in Table format. + * @param dataSchema The schema of the input data represented in Table format. + * @param params The parameters for the instance construction. + * @return The object of {@link FlatModelMapper} + * @throws Exception if flatModelMapperClass is not the class of {@link FlatModelMapper} + */ + public static FlatModelMapper of( Review comment: Thanks, changed the static method. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
