weka.classifiers.neural.common.NeuralModel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wekaclassalgos Show documentation

Fork of the following defunct sourceforge.net project: https://sourceforge.net/projects/wekaclassalgos/

There is a newer version: 2023.2.8

/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

package weka.classifiers.neural.common;

import weka.core.Instance;
import weka.core.Instances;

import java.io.Serializable;

/**
 * Title: Weka Neural Implementation
 * Description: ...
 * Copyright: Copyright (c) 2003
 * Company: N/A
 *
 * @author Jason Brownlee
 * @version 1.0
 */

public interface NeuralModel extends Serializable {

  // update the model for a single pattern
  public void updateModel(Instance instance, double aLearningRate);

  public void startingEpoch();

  public void finishedEpoch(Instances instances, double aLearningRate);

  public double getLearningRate(int epochNumber);


  // run a vector through the model and get a result
  public double[] getNetworkOutputs(Instance instance);

  public double[] getDistributionForInstance(Instance instance);

  // stats
  public String getModelInformation();

  public int getNumOutputNeurons();

  public double[] getAllWeights();
}