com.spss.psapi.transform

Interface CompositeModelResult



  • public interface CompositeModelResult
    This encapsulates the concrete results for the individual models forming the Composite Model.
    Since:
    PSAPI 15.0
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getModelMeasureLabel(java.lang.String measure)
      Returns a descriptive label for the specified evaluation measure or null if the measure is not valid for this result.
      int getModelMeasurePartitionCount()
      Returns the number of partitions for which evaluation measures exist.
      java.util.List<java.lang.String> getModelMeasures()
      Returns the list of measures used to evaluate this model result.
      StorageType getModelMeasureType(java.lang.String measure)
      Returns the data type of the specified evaluation measure or null if the measure is not valid for this result.
      java.lang.Object getModelMeasureValue(java.lang.String measure, int partition)
      Returns the value of the specified evaluation measure in the specified partition, or null if either the measure or the partition is not valid for this result.
      java.lang.String getModelName()
      Returns the name of this model result.
      ModelOutput getModelOutput()
      Returns the model output of the composite model result.
      boolean isUsed()
      Returns true if this composite model result is used.
    • Method Detail

      • getModelName

        java.lang.String getModelName()
        Returns the name of this model result. The model name is expected to be unique within a set of composite model result objects.
        Returns:
        the name of this model result
        Since:
        PSAPI 15.0.0.1
      • getModelOutput

        ModelOutput getModelOutput()
        Returns the model output of the composite model result.
        Returns:
        the model output of the composite model result.
      • isUsed

        boolean isUsed()
        Returns true if this composite model result is used.
        Returns:
        true if this composite model result is used.
      • getModelMeasures

        java.util.List<java.lang.String> getModelMeasures()
        Returns the list of measures used to evaluate this model result.
        Returns:
        the list of evaluation measure names for this result
        Since:
        PSAPI 15.0.0.1
      • getModelMeasureLabel

        java.lang.String getModelMeasureLabel(java.lang.String measure)
        Returns a descriptive label for the specified evaluation measure or null if the measure is not valid for this result.
        Parameters:
        measure - the evaluation measure name
        Returns:
        a descriptive label for the measure
        Since:
        PSAPI 15.0.0.1
      • getModelMeasureType

        StorageType getModelMeasureType(java.lang.String measure)
        Returns the data type of the specified evaluation measure or null if the measure is not valid for this result.
        Parameters:
        measure - the evaluation measure name
        Returns:
        the type of the measure
        Since:
        PSAPI 15.0.0.1
      • getModelMeasurePartitionCount

        int getModelMeasurePartitionCount()
        Returns the number of partitions for which evaluation measures exist. Partitions (where they exist) are numbered: 0=Training, 1=Testing, 2=Validation.
        Returns:
        the number of partitions for which evaluation measures exist
        Since:
        PSAPI 15.0.0.1
      • getModelMeasureValue

        java.lang.Object getModelMeasureValue(java.lang.String measure,
                                            int partition)
        Returns the value of the specified evaluation measure in the specified partition, or null if either the measure or the partition is not valid for this result.
        Parameters:
        measure - the evaluation measure name
        partition - the partition index
        Returns:
        the corresponding value
        Since:
        PSAPI 15.0.0.1

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.