describe

Display summary of pipeline components

Since R2026a

collapse all in page

    Syntax

    describe(pipeline)
    Info = describe(pipeline)

    Description

    describe(pipeline) prints a summary of the components in the pipeline pipeline. For each component, the summary includes the following information:

    • Component type

    • Whether the component contains learnables

    • Whether the component has learned parameters

    • Component inputs

    • Component outputs

    example

    Info = describe(pipeline) returns the summary information in the table Info.

    Examples

    collapse all

    Create a simple pipeline with two components connected in parallel. Display the summary of the pipeline components.

    normalizer = normalizerComponent;
onehotEncoder = oneHotEncoderComponent;
pipeline = parallel(normalizer,onehotEncoder);
describe(pipeline)
                                  Type             HasLearnables    HasLearned    Inputs      Outputs  
                     ______________________    _____________    __________    ______    ___________

    Normalizer       normalizerComponent           true           false       DataIn    DataScaled 
    OneHotEncoder    oneHotEncoderComponent        true           false       DataIn    DataEncoded

    The pipeline has two components, both of which have learnable parameters. Neither component has learned parameters. The summary also shows the inputs and outputs of the pipeline components.

    Input Arguments

    collapse all

    Pipeline to describe, specified as a LearningPipeline object.

    Output Arguments

    collapse all

    Description of the pipeline components, returned as a table. Each row of the table corresponds to a component in pipeline, and each column corresponds to a property of the component.

    ColumnDescription
    TypeComponent object type
    HasLearnablesIndicator for the learnables. A value of true indicates that the component contains learnables.
    HasLearnedIndicator showing the learning status of the component. A value of true indicates that the learn object function has been applied to the component, and the learnables are nonempty.
    InputsNames of the component input ports
    OutputsNames of the component output ports

    Version History

    Introduced in R2026a

    See Also

    |