partial_fit!(opt::Union{JuMPOptimisationEstimator, HierarchicalRiskParity, HierarchicalEqualRiskContribution, SchurComplementHierarchicalRiskParity}, rd::ReturnsResult)
partial_fit!(opt::Union{JuMPOptimiser, BaseClusteringOptimisationEstimator, InverseVolatility, NestedClustered, BaseStackingOptimisationEstimator, BaseSubsetResamplingOptimisationEstimator}, rd::ReturnsResult)
partial_fit!(opt::Union{EqualWeighted, RandomWeighted, BestConstantRebalancedPortfolio}, rd::ReturnsResult)
partial_fit!(opt::PreviousWeights, rd::ReturnsResult)
partial_fit!(opt::FiniteAllocationOptimisationEstimator, rd::ReturnsResult)
partial_fit!(td::TD_OptE_Opt, rd::ReturnsResult)Folds observations into an optimiser, and solves nothing.
const TD_OptE_Opt = Union{TimeDependent{<:AbstractVector{<:OptE_Opt}},
TimeDependent{<:TimeDependentOptimiserCallable},
TimeDependent{<:PreviousWeightsFunction},
TimeDependent{<:Base.Callable}}Alias for the TimeDependent forms that a field which holds an optimiser takes, where the schedule changes the optimiser itself.
abstract type BaseClusteringOptimisationEstimator <: BaseOptimisationEstimatorAbstract supertype for the shared configuration that a hierarchical optimiser holds in its opt field.
abstract type JuMPOptimisationEstimator <: NonFiniteAllocationOptimisationEstimatorAbstract supertype for portfolio optimisers that build and solve a JuMP model.
abstract type BaseStackingOptimisationEstimator <: NonFiniteAllocationOptimisationEstimatorAbstract supertype of the optimisers that combine several inner optimisers through one outer optimiser.
abstract type BaseSubsetResamplingOptimisationEstimator <: NonFiniteAllocationOptimisationEstimatorAbstract supertype for the estimators that average one optimiser over random subsets of the assets.
partial_fit!(est, X)Folds observations into an estimator's partial-fit state, and returns the estimator.
partial_fit!(
state::SampleBufferState,
X::AbstractMatrix{<:Union{Number, AbstractJuMPScalar}};
...
) -> SampleBufferState
partial_fit!(
state::SampleBufferState,
X::AbstractMatrix{<:Union{Number, AbstractJuMPScalar}},
F::Union{Nothing, AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
ne,
E,
iv,
ivpa,
panel_fields,
gaps
) -> SampleBufferStateFolds every observation of a block into a SampleBufferState.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
port_opt_view(x, i, args...; kwargs...) -> nothing_scalar_array_view(x, i)Select the assets i of an estimator, a result or an algorithm.
struct ReturnsResult{__T_nx, __T_X, __T_nf, __T_F, __T_nb, __T_B, __T_ne, __T_E, __T_ts, __T_iv, __T_ivpa, __T_pnl} <: AbstractReturnsResultReturns data of a universe: the asset returns, and optionally the factor returns, the benchmark returns, the Exogenous Series, the timestamps, the implied volatilities and an Asset Panel.
partial_fit!(
state::ReturnsBufferState,
rd::ReturnsResult;
own_returns,
own_factors,
own_exogenous
) -> ReturnsBufferStateFolds the observations of a ReturnsResult into a ReturnsBufferState.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
state::SimpleExpectedReturnsState,
x::AbstractVector{<:Union{Number, AbstractJuMPScalar}}
) -> SimpleExpectedReturnsStateThe SimpleExpectedReturnsState method of partial_fit! folds one observation into the count and the running mean.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
state::CovarianceState,
x::AbstractVector{<:Union{Number, AbstractJuMPScalar}}
) -> CovarianceStateThe CovarianceState method of partial_fit! folds one observation into the count, the running mean and the co-moment accumulator.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
state::SimpleVarianceState,
x::AbstractVector{<:Union{Number, AbstractJuMPScalar}}
) -> SimpleVarianceStateThe SimpleVarianceState method of partial_fit! folds one observation into the count, the running mean and the per-asset accumulator.
partial_fit!(ce::PortfolioOptimisersCovariance{<:Any, <:Any, Nothing}, X::MatNum;
dims::Int = 1, kwargs...)
partial_fit!(ce::PortfolioOptimisersCovariance{<:Any, <:Any, Nothing}, x::VecNum;
kwargs...)Folds observations into a PortfolioOptimisersCovariance through ce.ce.
partial_fit!(est::SeedWindowed, X::MatNum; dims::Int = 1, kwargs...)
partial_fit!(est::SeedWindowed, x::VecNum; kwargs...)Fold a block of observations into a windowed estimator under a SeedWindow.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(de::Union{GrowthRate, ChangeToScale, ChangeInIntensity}, rd::ReturnsResult)Folds the observations of a ReturnsResult into the carried state of a lag Descriptor, and returns the estimator with the state after them in cache.
partial_fit!(de::Union{EWMean, EWVolumeRatio, DaysToCover}, rd::ReturnsResult)Folds the observations of a ReturnsResult into the carried state of an exponentially weighted mean Descriptor, and returns the estimator with the state after them in cache.
partial_fit!(de::Union{EWVolatility{<:RegimeAdjustedExpWeightedVariance},
EWResidualVolatility{<:Any,
<:RegimeAdjustedExpWeightedVariance}},
rd::ReturnsResult)Folds the observations of a ReturnsResult into the carried state of a volatility Descriptor, and returns the estimator with the state after them in cache.
partial_fit!(de::Union{EWBeta, EWMacroSensitivity, EWDownsideBeta}, rd::ReturnsResult)Folds the observations of a ReturnsResult into the carried state of an exponentially weighted beta Descriptor, and returns the estimator with the state after them in cache.
partial_fit!(de::RollingLogReturn{<:Any, <:Any, <:Any, <:Any,
<:Option{<:RollingLogReturnState}},
rd::ReturnsResult)Folds the observations of a ReturnsResult into the carried state of a RollingLogReturn, and returns the estimator with the state after them in cache.
partial_fit!(
est::Union{AbstractEstimator, CovarianceEstimator},
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask,
iv,
ivpa
) -> Covariance{<:AbstractExpectedReturnsEstimator, <:CovarianceEstimator, <:AbstractMomentAlgorithm}Folds observations into the sample buffer an estimator carries.
partial_fit!(ce::GeodesicShrinkageCovariance{<:Any, <:Any, <:Any, <:Any, Nothing},
X::MatNum; dims::Int = 1, kwargs...)
partial_fit!(ce::GeodesicShrinkageCovariance{<:Any, <:Any, <:Any, <:Any, Nothing},
x::VecNum; kwargs...)Folds observations into a GeodesicShrinkageCovariance by forwarding them to ce.ce.
struct EmpiricalPrior{__T_ce, __T_me, __T_horizon, __T_fill_limit, __T_max_scenarios, __T_cache, __T_x_src} <: AbstractLowOrderPriorEstimator_AEmpirical prior estimator for asset returns.
partial_fit!(pe::HighOrderPriorEstimator, X, F = nothing; kwargs...)Fold observations into a HighOrderPriorEstimator, and pass them to its members.
partial_fit!(
pe::AbstractPriorEstimator,
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
...
) -> Any
partial_fit!(
pe::AbstractPriorEstimator,
X::Union{AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}},
F::Union{Nothing, AbstractMatrix{<:Union{Number, AbstractJuMPScalar}}, AbstractVector{<:Union{Number, AbstractJuMPScalar}}};
dims,
active_mask,
estimation_mask
) -> AnyFolds observations, and the factor observations beside them, into the sample buffer that a prior carries.
partial_fit!(pe::AbstractPriorEstimator, rd::ReturnsResult)Folds the observations of a ReturnsResult into a prior.
partial_fit!(state::PriorCarryState, x::VecNum; kwargs...)
partial_fit!(state::PriorCarryState, X::MatNum; dims::Int = 1, kwargs...)Folds observations into the buffer that a PriorCarryState carries.
partial_fit!(pe::BlackLittermanPrior, X, F = nothing; kwargs...)Folds observations into a BlackLittermanPrior by forwarding them to its embedded prior.
partial_fit!(me::PriorExpectedReturns, X::VecNum_MatNum; kwargs...)Folds the rows into the adapter's prior through the prior's own partial_fit!, and returns an adapter that holds the folded prior.
partial_fit!(state::PipelineBufferState, data::Prices_RR) -> PipelineBufferState
partial_fit!(state::PipelineBufferState, ::Nothing) -> PipelineBufferStateAppends a block of observations to a PipelineBufferState, and drops the oldest rows past the cap.
partial_fit!(pipe::Pipeline{<:Any, <:Any, <:Option{<:Union{PipelineBufferState, ReturnsBufferState}}}, data::Prices_RR)Folds a block of observations into a Pipeline, without a fit.
abstract type OptimisationEstimator <: AbstractOptimisationEstimatorAbstract supertype for portfolio optimisation estimators that produce portfolio weights.
partial_fit!(ce::AbstractCovarianceEstimator, rd::ReturnsResult)Fold the observations of the returns data rd into a covariance estimator.
struct BestConstantRebalancedPortfolio{__T_wb, __T_fees, __T_sets, __T_wf, __T_fb, __T_iters, __T_tol, __T_strict, __T_cache} <: NaiveOptimisationEstimatorAllocates the constant rebalanced portfolio that maximises the log wealth of its window, through Cover's fixed point and without a solver.
struct EqualWeighted{__T_wb, __T_fees, __T_sets, __T_wf, __T_fb, __T_strict, __T_cache} <: NaiveOptimisationEstimatorAllocates the same weight to every asset of the Coverage Universe of the window.
struct InverseVolatility{__T_pe, __T_wb, __T_fees, __T_sets, __T_wf, __T_fb, __T_sq, __T_strict, __T_cache} <: NaiveOptimisationEstimatorAllocates each asset a weight inversely proportional to its volatility, or to its variance when sq = true.
struct PreviousWeights{__T_w, __T_fees, __T_fb} <: NaiveOptimisationEstimatorHolds the weights it was handed, and solves nothing.
struct RandomWeighted{__T_alpha, __T_rng, __T_seed, __T_wb, __T_fees, __T_sets, __T_wf, __T_fb, __T_strict, __T_cache} <: NaiveOptimisationEstimatorDraws portfolio weights at random from a Dirichlet distribution with concentration alpha.
struct HierarchicalRiskParity{__T_opt, __T_r, __T_sca, __T_fb} <: ClusteringOptimisationEstimatorAllocates weights by recursively bisecting the dendrogram's leaf order and splitting each part's weight in inverse proportion to the risk of its two halves.
struct SchurComplementHierarchicalRiskParity{__T_opt, __T_params, __T_fb} <: ClusteringOptimisationEstimatorRuns the hierarchical risk parity recursion on covariance blocks that a Schur complement augments with the information of the cross-cluster block.
struct HierarchicalEqualRiskContribution{__T_opt, __T_ri, __T_ro, __T_scai, __T_scao, __T_ex, __T_fb} <: ClusteringOptimisationEstimatorSplits weight down the dendrogram between clusters by their outer risk ro, then splits each cluster's share between its assets by their inner risk ri.
struct JuMPOptimiser{__T_pe, __T_slv, __T_cbe, __T_bgt, __T_fees, __T_ret, __T_sca, __T_sc, __T_so, __T_strict, __T_cache} <: BaseJuMPOptimisationEstimatorHolds the problem definition and the solver settings that every JuMP optimiser shares.
struct MeanRisk{__T_opt, __T_r, __T_obj, __T_wi, __T_fb} <: RiskJuMPOptimisationEstimatorOptimises one objective of risk and return over the portfolios that the constraints of a JuMP model admit.
struct NestedClustered{__T_pe, __T_cle, __T_wb, __T_fees, __T_sets, __T_opti, __T_opto, __T_cv, __T_scorer, __T_wf, __T_ex, __T_fb, __T_strict, __T_pcol, __T_cache} <: ClusteringOptimisationEstimatorClusters the assets, optimises each cluster, and then optimises across the cluster portfolios.
abstract type FiniteAllocationOptimisationEstimator <: OptimisationEstimatorAbstract supertype for estimators that turn continuous portfolio weights into share counts.
partial_fit!(opt::OnlinePortfolioSelection, rd::ReturnsResult)Folds the rows of a Returns Result into the head's recursion as the Block Step, and reads nothing out.