Struct FeatureDescription 

pub struct FeatureDescription { /* private fields */ }

Description of a model feature (input or output).

Implementations

impl FeatureDescription

pub fn name(&self) -> &str

Examples found in repository

examples/inspect_model.rs (line 19)

fn main() {
    let model_path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "tests/fixtures/test_linear.mlmodelc".to_string());

    println!("Loading model: {model_path}");
    let model = Model::load(&model_path, ComputeUnits::All).expect("Failed to load model");

    println!("\n--- Inputs ---");
    for desc in model.inputs() {
        println!(
            "  {}: {:?} shape={:?} optional={}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
            desc.is_optional(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    println!("\n--- Outputs ---");
    for desc in model.outputs() {
        println!(
            "  {}: {:?} shape={:?}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    let meta = model.metadata();
    println!("\n--- Metadata ---");
    println!("  author: {:?}", meta.author);
    println!("  description: {:?}", meta.description);
    println!("  version: {:?}", meta.version);
    println!("  license: {:?}", meta.license);
}

pub fn feature_type(&self) -> &FeatureType

Examples found in repository

examples/inspect_model.rs (line 20)

fn main() {
    let model_path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "tests/fixtures/test_linear.mlmodelc".to_string());

    println!("Loading model: {model_path}");
    let model = Model::load(&model_path, ComputeUnits::All).expect("Failed to load model");

    println!("\n--- Inputs ---");
    for desc in model.inputs() {
        println!(
            "  {}: {:?} shape={:?} optional={}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
            desc.is_optional(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    println!("\n--- Outputs ---");
    for desc in model.outputs() {
        println!(
            "  {}: {:?} shape={:?}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    let meta = model.metadata();
    println!("\n--- Metadata ---");
    println!("  author: {:?}", meta.author);
    println!("  description: {:?}", meta.description);
    println!("  version: {:?}", meta.version);
    println!("  license: {:?}", meta.license);
}

pub fn shape(&self) -> Option<&[usize]>

Examples found in repository

examples/inspect_model.rs (line 21)

fn main() {
    let model_path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "tests/fixtures/test_linear.mlmodelc".to_string());

    println!("Loading model: {model_path}");
    let model = Model::load(&model_path, ComputeUnits::All).expect("Failed to load model");

    println!("\n--- Inputs ---");
    for desc in model.inputs() {
        println!(
            "  {}: {:?} shape={:?} optional={}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
            desc.is_optional(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    println!("\n--- Outputs ---");
    for desc in model.outputs() {
        println!(
            "  {}: {:?} shape={:?}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    let meta = model.metadata();
    println!("\n--- Metadata ---");
    println!("  author: {:?}", meta.author);
    println!("  description: {:?}", meta.description);
    println!("  version: {:?}", meta.version);
    println!("  license: {:?}", meta.license);
}

pub fn data_type(&self) -> Option<DataType>

Examples found in repository

examples/inspect_model.rs (line 24)

fn main() {
    let model_path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "tests/fixtures/test_linear.mlmodelc".to_string());

    println!("Loading model: {model_path}");
    let model = Model::load(&model_path, ComputeUnits::All).expect("Failed to load model");

    println!("\n--- Inputs ---");
    for desc in model.inputs() {
        println!(
            "  {}: {:?} shape={:?} optional={}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
            desc.is_optional(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    println!("\n--- Outputs ---");
    for desc in model.outputs() {
        println!(
            "  {}: {:?} shape={:?}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    let meta = model.metadata();
    println!("\n--- Metadata ---");
    println!("  author: {:?}", meta.author);
    println!("  description: {:?}", meta.description);
    println!("  version: {:?}", meta.version);
    println!("  license: {:?}", meta.license);
}

pub fn is_optional(&self) -> bool

Examples found in repository

examples/inspect_model.rs (line 22)

fn main() {
    let model_path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "tests/fixtures/test_linear.mlmodelc".to_string());

    println!("Loading model: {model_path}");
    let model = Model::load(&model_path, ComputeUnits::All).expect("Failed to load model");

    println!("\n--- Inputs ---");
    for desc in model.inputs() {
        println!(
            "  {}: {:?} shape={:?} optional={}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
            desc.is_optional(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    println!("\n--- Outputs ---");
    for desc in model.outputs() {
        println!(
            "  {}: {:?} shape={:?}",
            desc.name(),
            desc.feature_type(),
            desc.shape(),
        );
        if let Some(dt) = desc.data_type() {
            println!("    data_type: {dt}");
        }
    }

    let meta = model.metadata();
    println!("\n--- Metadata ---");
    println!("  author: {:?}", meta.author);
    println!("  description: {:?}", meta.description);
    println!("  version: {:?}", meta.version);
    println!("  license: {:?}", meta.license);
}

pub fn shape_constraint(&self) -> Option<&ShapeConstraint>

Trait Implementations

impl Clone for FeatureDescription

fn clone(&self) -> FeatureDescription

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FeatureDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.