com.tencent.angel.client.AngelClientInterface Maven / Gradle / Ivy
/*
* Tencent is pleased to support the open source community by making Angel available.
*
* Copyright (C) 2017-2018 THL A29 Limited, a Tencent company. All rights reserved.
*
* Licensed 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
*
* https://opensource.org/licenses/Apache-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 com.tencent.angel.client;
import com.tencent.angel.exception.AngelException;
import com.tencent.angel.ml.matrix.MatrixContext;
import com.tencent.angel.ml.model.MLModel;
import com.tencent.angel.model.ModelLoadContext;
import com.tencent.angel.model.ModelSaveContext;
import com.tencent.angel.worker.task.BaseTask;
import java.util.List;
/**
* Angel client interface. It defines application control operations from angel client.
*/
public interface AngelClientInterface {
/**
* Add a new matrix.
*
* @param mContext matrix context
* @throws AngelException
*/
void addMatrix(MatrixContext mContext) throws AngelException;
/**
* Add a new matrix.
*
* @throws AngelException
*/
void createMatrices() throws AngelException;
/**
* Add a new matrix.
*
* @throws AngelException
*/
void createMatrices(List contexts) throws AngelException;
/**
* Submit application.
*
* @throws AngelException
*/
void startPSServer() throws AngelException;
/**
* Load the model from files.
*
* @param model model
* @throws AngelException
*/
void loadModel(MLModel model) throws AngelException;
/**
* Load the model from files
*
* @param context model load context
* @throws AngelException
*/
void load(ModelLoadContext context) throws AngelException;
/**
* Recover the model from the checkpoint
* @param checkpointId the checkpoint id
* @param context load context
* @throws AngelException
*/
void recover(int checkpointId, ModelLoadContext context) throws AngelException;
/**
* Accept specified task and start
*
* @param taskClass
* @throws AngelException
*/
void runTask(@SuppressWarnings("rawtypes") Class taskClass)
throws AngelException;
/**
* Startup workers and start to execute tasks.
*
* Use #runTask instead
*
* @throws AngelException
*/
@Deprecated void run() throws AngelException;
/**
* Wait until all the tasks are done.
*
* @throws AngelException
*/
void waitForCompletion() throws AngelException;
/**
* Write the model to files.
*
* @param model model need to write to files.
* @throws AngelException
*/
void saveModel(MLModel model) throws AngelException;
/**
* Save the model to files
*
* @param context model save context
* @throws AngelException
*/
void save(ModelSaveContext context) throws AngelException;
/**
* Write the model checkpoint
* @param checkpointId the checkpoint id
* @param context save context
* @throws AngelException
*/
void checkpoint(int checkpointId, ModelSaveContext context) throws AngelException;
/**
* Stop the whole application.
*
* @throws AngelException stop failed
*/
void stop() throws AngelException;
/**
* Stop the whole application with given state.
*
* @param stateCode 0:succeed,1:killed,2:failed
* @throws AngelException stop failed
*/
void stop(int stateCode) throws AngelException;
/**
* Kill the application
*
* @throws AngelException
*/
void kill() throws AngelException;
/**
* Clean thre resource
*
* @throws AngelException
*/
void close() throws AngelException;
}