magpie.utility.interfaces

Interface Printable

All Known Implementing Classes:

AbstractNonlinearRegression, AbstractParsedNonlinearRegression, AllMetalsSplitter, AttributeIntervalSplitter, BaseAttributeSelector, BaseClassifier, BaseClusterer, BaseDatasetNormalizer, BaseDatasetSplitter, BaseModel, BaseRegression, BaseStatistics, BestIndividualSelector, ClassificationRegression, ClassificationStatistics, ClustererSplitter, ClustererStatistics, CompositeRegression, CompositionBasedCSPEngine, CompositionDataset, CoulombEwaldMatrixRegression, CoulombSineMatrixRegression, CrystalStructureDataset, CSPEngine, CSPPerformanceStats, CumulantExpansionClassifier, Dataset, DMSPEngine, ElementDataset, ExhaustiveAttributeSelector, FilterSplitter, GuessMeanRegression, IndependentVariableNormalizer, InverseNormalizer, LassoAttributeSelector, LASSORegression, LinearCorrectedRegression, MeasuredClassSplitter, MeredigAttributeSelector, MetallurgicalHeuristicRegression, MixedMetalsSplitter, MixingRuleRegression, MultiNormalizer, MultiObjectiveRegression, MultipleElementGroupsSplitter, MultiPropertyDataset, MultiPropertyRegression, NonlinearRegressionExpr, NonZeroClassificationSplitter, ObjectiveFunctionSplitter, PhaseDiagramExclusionValidator, PolynomialRegression, PRDFRegression, PredictedClassIntervalSplitter, PrototypeDataset, PythonBasedAttributeSelector, RandomForestAttributeSelector, RandomGuessRegression, RegexAttributeSelector, RegressionStatistics, RegularSolutionNormalizer, RemoveCorrelatedAttributeSelector, RemoveDuplicateAttributeSelector, RemoveNaNAttributeSelector, RescalingNormalizer, ScikitLearnClassifier, ScikitLearnRegression, SimpleLinearModelExample, SingleElementGroupSplitter, SingleGuessRegression, SoftmaxNormalizer, SplitClassifier, SplitModel, SplitRegression, StagedAttributeSelector, StagedRegression, StructureKRRBasedRegression, TargetRegressionStatistics, UserSpecifiedAttributeSelector, UserSpecifiedExcludingAttributeSelector, WekaAttributeSelector, WekaClassifier, WekaClusterer, WekaRegression, ZScoreNormalizer

public interface Printable

Dictates commands that must be fulfilled for an object to be "printable".

Ensure that you add any new printing commands to the Javadoc for the class. Surround them by <print> HTML tags and follow the same format as any other command (see Commandable for more details)

Method Summary

Modifier and Type	Method and Description
java.lang.String	about() Prints a simple status message about this object
java.lang.String	printCommand(java.util.List<java.lang.String> Command) Handles more complicated printing commands.
java.lang.String	printDescription(boolean htmlFormat) Print full name of object, and a simple description of the options.

Method Detail

about

java.lang.String about()

Prints a simple status message about this object

Returns:

Short status message

printCommand

java.lang.String printCommand(java.util.List<java.lang.String> Command)
                       throws java.lang.Exception

Handles more complicated printing commands.

Parameters:

Command - Command specifying what to print

Returns:

String formatted as requested

Throws:

java.lang.Exception - If command not understood

printDescription

java.lang.String printDescription(boolean htmlFormat)

Print full name of object, and a simple description of the options. This description should print enough information to reproduce how this object was created, but not necessarily enough to run it (e.g., coefficients for the model).

Example: For a model training a separate WekaRegression for intermetallics

magpie.models.regression.SplitRegression

Splitter: AllMetalsSplitter
All Metals: magpie.models.regression.WekaRegression trees.REPTree
Contains Nonmetal: magpie.regression.LASSORegreession -maxterms 2

Parameters:

htmlFormat - Whether format for output to an HTML page (e.g., <div> to create indentation) or for printing to screen.

Returns:

String describing the model

See Also:

#printModel()