jerqi commented on code in PR #5612: URL: https://github.com/apache/gravitino/pull/5612#discussion_r1848186820
########## api/src/main/java/org/apache/gravitino/model/ModelVersion.java: ########## @@ -0,0 +1,76 @@ +/* + * 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.gravitino.model; + +import java.util.Map; +import org.apache.gravitino.Auditable; +import org.apache.gravitino.annotation.Evolving; + +/** + * An interface representing a single model checkpoint under a model {@link Model}. A model version + * is a snapshot at a point of time of a model artifact in ML. Users can link a model version to a + * registered model. + */ +@Evolving +public interface ModelVersion extends Auditable { + + /** + * The version of this model object. The version number is an integer number starts from 0. Each + * time the model checkpoint / snapshot is linked to the registered, the version number will be + * increased by 1. + * + * @return The version of the model object. + */ + int version(); + + /** + * The comment of this model version. This comment can be different from the comment of the model + * to provide more detailed information about this version. + * + * @return The comment of the model version. Null is returned if no comment is set. + */ + default String comment() { + return null; + } + + /** + * The aliases of this model version. The aliases are the alternative names of the model version. + * The aliases are optional. The aliases are unique for a model version. If the alias is already + * set to one model version, it cannot be set to another model version. + * + * @return The aliases of the model version. + */ + String[] aliases(); + + /** + * The URL of the model artifact. The URL is the location of the model artifact. The URL can be a + * file path or a remote URL. + * + * @return The URL of the model artifact. + */ + String url(); + + /** + * The properties of the model version. The properties are key-value pairs that can be used to + * store additional information of the model version. The properties are optional. + * + * @return the properties of the model version. + */ + Map<String, String> properties(); Review Comment: Do we need to add the author and date for ModelVersion if this is a version management. I just want to refer to some design about `git`. -- 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: commits-unsubscr...@gravitino.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
