stream.learner.PredictionService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of streams-api Show documentation
The newest version!
/*
 *  streams library
 *
 *  Copyright (C) 2011-2014 by Christian Bockermann, Hendrik Blom
 * 
 *  streams is a library, API and runtime environment for processing high
 *  volume data streams. It is composed of three submodules "stream-api",
 *  "stream-core" and "stream-runtime".
 *
 *  The streams library (and its submodules) is free software: you can 
 *  redistribute it and/or modify it under the terms of the 
 *  GNU Affero General Public License as published by the Free Software 
 *  Foundation, either version 3 of the License, or (at your option) any 
 *  later version.
 *
 *  The stream.ai library (and its submodules) is distributed in the hope
 *  that it will be useful, but WITHOUT ANY WARRANTY; without even the implied 
 *  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see http://www.gnu.org/licenses/.
 */
package stream.learner;

import java.io.Serializable;
import java.rmi.RemoteException;

import stream.Data;
import stream.service.Service;

/**
 * 
 * A stream/online learning algorithm provides any-time prediction capabilities.
 * This interface should be implemented by all learning processors that provide
 * classification/prediction.
 * 
 * 
 * @author Christian Bockermann <[email protected]>
 * 
 */
public interface PredictionService extends Service {

	/**
	 * Returns the name of the prediction (i.e. the name of the label attribute)
	 * 
	 * @return
	 */
	public String getName() throws RemoteException;

	/**
	 * Performs the prediction based on the current state of the implementing
	 * class (learning algorithm).
	 * 
	 * @param item
	 *            The data item (vector) that holds the unlabeled data.
	 * @return The label value for that data (prediction).
	 */
	public Serializable predict(Data item) throws RemoteException;
}