Mutual info covariance: private API

PortfolioOptimisers.show_fields — Method
show_fields(
    _::MutualInfoCovariance
) -> Tuple{Symbol, Symbol, Symbol}

Renders every field of a MutualInfoCovariance except cache.

A cache holds the state of an incremental fit. That state is not part of the configuration, and it prints under the estimator at each site that renders the estimator. Set set_show_nothing_fields!(:MutualInfoCovariance, true) to render it.

Arguments

  • ::MutualInfoCovariance: The mutual information covariance estimator. The method reads only its type.

Returns

  • fields::Tuple: The field names to render, which is (:ve, :bins, :normalise).

Related

source