com.linkedin.dagli.dag.DAGResult5 Maven / Gradle / Ivy

Go to download

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

DAG-oriented machine learning framework for bug-resistant, readable, efficient, maintainable and trivially deployable models in Java and other JVM languages

There is a newer version: 15.0.0-beta9

Show newest version

// AUTOGENERATED CODE.  DO NOT MODIFY DIRECTLY!  Instead, please modify the dag/DAGResultX.ftl file.
// See the README in the module's src/template directory for details.
package com.linkedin.dagli.dag;

import com.linkedin.dagli.objectio.ObjectReader;
import com.linkedin.dagli.tuple.Tuple5;


/**
 * Interface for obtaining the results of executing a DAG.  As a DAG may have multiple output nodes, whose result
 * values are the "outputs" of the DAG.  These may be retrieved together (as a tuple) directly from this interface
 * (which extends {@link ObjectReader}), or individually via the getResultX() methods.
 *
 * The ordering of the outputs is determined when the DAG is created, matching the order of the outputs passed in the
 * DAG.withPlaceholders(...).withOutputs(...) call.
 *
 * @param  the type of result #1 of the DAG
 * @param  the type of result #2 of the DAG
 * @param  the type of result #3 of the DAG
 * @param  the type of result #4 of the DAG
 * @param  the type of result #5 of the DAG
 */
public interface DAGResult5 extends ObjectReader> {
  /**
   * Gets the results produced by the first output node of the DAG as an {@link ObjectReader}.  This
   * {@link ObjectReader} is parallel to the examples inputted to the DAG: that is, the ith value of the
   * {@link ObjectReader} corresponds to the ith example.  The size of the {@link ObjectReader} will (of course) also
   * equal the number of examples.
   *
   * @return the values produced by the first output node of the DAG for the inputted examples
   */
  public abstract ObjectReader getResult1();

  /**
   * Gets the results produced by the second output node of the DAG as an {@link ObjectReader}.  This
   * {@link ObjectReader} is parallel to the examples inputted to the DAG: that is, the ith value of the
   * {@link ObjectReader} corresponds to the ith example.  The size of the {@link ObjectReader} will (of course) also
   * equal the number of examples.
   *
   * @return the values produced by the second output node of the DAG for the inputted examples
   */
  public abstract ObjectReader getResult2();

  /**
   * Gets the results produced by the third output node of the DAG as an {@link ObjectReader}.  This
   * {@link ObjectReader} is parallel to the examples inputted to the DAG: that is, the ith value of the
   * {@link ObjectReader} corresponds to the ith example.  The size of the {@link ObjectReader} will (of course) also
   * equal the number of examples.
   *
   * @return the values produced by the third output node of the DAG for the inputted examples
   */
  public abstract ObjectReader getResult3();

  /**
   * Gets the results produced by the fourth output node of the DAG as an {@link ObjectReader}.  This
   * {@link ObjectReader} is parallel to the examples inputted to the DAG: that is, the ith value of the
   * {@link ObjectReader} corresponds to the ith example.  The size of the {@link ObjectReader} will (of course) also
   * equal the number of examples.
   *
   * @return the values produced by the fourth output node of the DAG for the inputted examples
   */
  public abstract ObjectReader getResult4();

  /**
   * Gets the results produced by the fifth output node of the DAG as an {@link ObjectReader}.  This
   * {@link ObjectReader} is parallel to the examples inputted to the DAG: that is, the ith value of the
   * {@link ObjectReader} corresponds to the ith example.  The size of the {@link ObjectReader} will (of course) also
   * equal the number of examples.
   *
   * @return the values produced by the fifth output node of the DAG for the inputted examples
   */
  public abstract ObjectReader getResult5();
}