zhipeng93 commented on code in PR #214: URL: https://github.com/apache/flink-ml/pull/214#discussion_r1115277590
########## flink-ml-servable-core/src/main/java/org/apache/flink/ml/servable/api/DataFrame.java: ########## @@ -0,0 +1,132 @@ +/* + * 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.servable.api; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.ml.servable.types.DataType; + +import java.util.Iterator; +import java.util.List; + +/** + * A DataFrame consists of some number of rows, each of which has the same list of column names and + * data types. + * + * <p>All values in a column must have the same data type: integer, float, string etc. + */ +@PublicEvolving +public class DataFrame { + + private final List<String> columnNames; + private final List<DataType> dataTypes; + private final List<Row> rows; + + /** + * The given columnNames and dataTypes should be mutable in order for TransformerServable + * classes to update DataFrame with the serving results. + */ + public DataFrame(List<String> columnNames, List<DataType> dataTypes, List<Row> rows) { + int numColumns = columnNames.size(); + if (dataTypes.size() != numColumns) { + throw new IllegalArgumentException( + String.format( + "The number of data types %d is different from the number of column names %d.", + dataTypes.size(), numColumns)); + } + for (Row row : rows) { + if (row.size() != numColumns) { + throw new IllegalArgumentException( + String.format( + "The row size %d is different from the number of column names %d.", + row.size(), numColumns)); + } + } + + this.columnNames = columnNames; + this.dataTypes = dataTypes; + this.rows = rows; + } + + /** Returns a list of the names of all the columns in this DataFrame. */ + public List<String> getColumnNames() { + return columnNames; + } + + /** + * Returns the index of the column with the given name. + * + * @throws IllegalArgumentException if the column is not present in this table + */ + public int getIndex(String name) { + int index = columnNames.indexOf(name); + if (index == -1) { + throw new IllegalArgumentException("Failed to find the column with the given name."); + } + return index; + } + + /** + * Returns the data type of the column with the given name. + * + * @throws IllegalArgumentException if the column is not present in this table + */ + public DataType getDataType(String name) { + int index = getIndex(name); + return dataTypes.get(index); + } + + /** + * Adds to this DataFrame a column with the given name, data type, and values. + * + * @throws IllegalArgumentException if the number of values is different from the number of + * rows. + */ + public DataFrame addColumn(String columnName, DataType dataType, List<Object> values) { + if (values.size() != rows.size()) { + throw new RuntimeException( + String.format( + "The number of values %d is different from the number of rows %d.", + values.size(), rows.size())); + } + columnNames.add(columnName); + dataTypes.add(dataType); + + int rowSize = -1; + Iterator<Object> iter = values.iterator(); + for (Row row : rows) { + if (rowSize < 0) { Review Comment: The check for row size here seems uncessary since we already checked them in the constructor. ########## flink-ml-servable-core/src/main/java/org/apache/flink/ml/servable/api/DataFrame.java: ########## @@ -0,0 +1,132 @@ +/* + * 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.servable.api; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.ml.servable.types.DataType; + +import java.util.Iterator; +import java.util.List; + +/** + * A DataFrame consists of some number of rows, each of which has the same list of column names and Review Comment: nit: `A DataFrame consists of several rows, each of which has the same column names and data types.` `Values in the same column must have the same data type: integer, float, string etc.` ########## flink-ml-servable-core/src/main/java/org/apache/flink/ml/servable/types/MatrixType.java: ########## @@ -0,0 +1,39 @@ +/* + * 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.servable.types; + +import org.apache.flink.annotation.PublicEvolving; + +/** + * A DataType representing a map where all keys have the same BasicType and all values have the same Review Comment: The java doc seems wrong here. ########## flink-ml-servable-core/src/main/java/org/apache/flink/ml/servable/types/MatrixType.java: ########## @@ -0,0 +1,39 @@ +/* + * 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.servable.types; + +import org.apache.flink.annotation.PublicEvolving; + +/** + * A DataType representing a map where all keys have the same BasicType and all values have the same + * BasicType. + */ +@PublicEvolving +public final class MatrixType extends DataType { Review Comment: Should we distinguish DataType for SparseMatrix/DenseMatrix and SparseVector/DenseVector? ########## flink-ml-servable-core/src/main/java/org/apache/flink/ml/servable/api/DataFrame.java: ########## @@ -0,0 +1,132 @@ +/* + * 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.servable.api; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.ml.servable.types.DataType; + +import java.util.Iterator; +import java.util.List; + +/** + * A DataFrame consists of some number of rows, each of which has the same list of column names and + * data types. + * + * <p>All values in a column must have the same data type: integer, float, string etc. + */ +@PublicEvolving +public class DataFrame { + + private final List<String> columnNames; + private final List<DataType> dataTypes; + private final List<Row> rows; + + /** + * The given columnNames and dataTypes should be mutable in order for TransformerServable + * classes to update DataFrame with the serving results. + */ + public DataFrame(List<String> columnNames, List<DataType> dataTypes, List<Row> rows) { + int numColumns = columnNames.size(); + if (dataTypes.size() != numColumns) { + throw new IllegalArgumentException( + String.format( + "The number of data types %d is different from the number of column names %d.", + dataTypes.size(), numColumns)); + } + for (Row row : rows) { + if (row.size() != numColumns) { + throw new IllegalArgumentException( + String.format( + "The row size %d is different from the number of column names %d.", + row.size(), numColumns)); + } + } + + this.columnNames = columnNames; + this.dataTypes = dataTypes; + this.rows = rows; + } + + /** Returns a list of the names of all the columns in this DataFrame. */ + public List<String> getColumnNames() { + return columnNames; + } + + /** + * Returns the index of the column with the given name. + * + * @throws IllegalArgumentException if the column is not present in this table + */ + public int getIndex(String name) { + int index = columnNames.indexOf(name); + if (index == -1) { + throw new IllegalArgumentException("Failed to find the column with the given name."); Review Comment: nit: Shall we also print the given name for better debuging? ########## flink-ml-servable-core/src/main/java/org/apache/flink/ml/servable/api/TransformerServable.java: ########## @@ -0,0 +1,47 @@ +/* + * 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.servable.api; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.ml.param.WithParams; + +/** + * A TransformerServable takes a DataFrame as input and produces a DataFrame as the result. It can + * be used to encode online inference computation logic. + * + * <p>NOTE: Every TransformerServable subclass should have a no-arg constructor. + * + * <p>NOTE: Every TransformerServable subclass should implement a static method with signature + * {@code static T load(String path) throws IOException;}, where {@code T} refers to the concrete + * subclass. This static method should instantiate a new TransformerServable instance based on the + * data read from the given path. + * + * @param <T> The class type of the TransformerServable implementation itself. + */ +@PublicEvolving +public interface TransformerServable<T extends TransformerServable<T>> extends WithParams<T> { + /** + * Applies the TransformerServable on the given input DataFrame and returns the result + * DataFrame. + * + * @param input the input data Review Comment: nit: Let's capitalize the first character here. ########## flink-ml-servable-core/src/main/java/org/apache/flink/ml/servable/api/ModelServable.java: ########## @@ -0,0 +1,38 @@ +/* + * 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.servable.api; + +import org.apache.flink.annotation.PublicEvolving; + +import java.io.IOException; +import java.io.InputStream; + +/** + * A ModelServable is a TransformerServable with the extra API to set model data. + * + * @param <T> The class type of the ModelServable implementation itself. + */ +@PublicEvolving +public interface ModelServable<T extends ModelServable<T>> extends TransformerServable<T> { + + /** Sets model data using the serialized model data from the given input streams. */ + default T setModelData(InputStream... modelDataInputs) throws IOException { + throw new UnsupportedOperationException("this operation is not supported"); Review Comment: nit: this -> This -- 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: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
