Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.examples.group.bgd.data;
020
021import org.apache.reef.examples.group.utils.math.Vector;
022
023import java.io.Serializable;
024
025/**
026 * Base interface for Examples for linear models.
027 */
028public interface Example extends Serializable {
029
030  /**
031   * Access to the label.
032   *
033   * @return the label
034   */
035  double getLabel();
036
037  /**
038   * Computes the prediction for this Example, given the model w.
039   * <p>
040   * w.dot(this.getFeatures())
041   *
042   * @param w the model
043   * @return the prediction for this Example, given the model w.
044   */
045  double predict(Vector w);
046
047  /**
048   * Adds the current example's gradient to the gradientVector, assuming that
049   * the gradient with respect to the prediction is gradient.
050   */
051  void addGradient(Vector gradientVector, double gradient);
052}