statsmodels ----------- +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Float | | - :xref_param_type:`Float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Integer | | - :xref_param_type:`Integer ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or DataFrame | | - :xref_param_type:`array ` or :xref_param_type:`DataFrame ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, optional | | - :term:`array-like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional | | - :xref_param_type:`float`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x `coint_rank`) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` `coint_rank`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'approx' (default) or 'asymp' | | - 'approx' (default) :xref_param_type:`or` 'asymp' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'auto, 'size', or 'off' | | - 'auto, 'size', :xref_param_type:`or` 'off' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'bartlett' or 'regression' | | - 'bartlett' or 'regression' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'cluster' or 'hac' or False | | - 'cluster' or 'hac' or :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'display' (default), 'raw' or 'strings' | | - 'display' (default), 'raw' or 'strings' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'endog' or int | | - 'endog' or :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'l1' or 'l1_cvxopt_cp' | | - 'l1' or 'l1_cvxopt_cp' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'lagged', 'centered', or 'leading' | | - 'lagged', 'centered', :xref_param_type:`or` 'leading' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'mean', 'linear', 'prob', optional. | | - 'mean', 'linear', 'prob', optional. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'none', 'drop', or 'raise' | | - 'none', 'drop', :xref_param_type:`or` 'raise' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'norm' or callable | | - 'norm' or :xref_param_type:`callable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'string', int, or None | | - 'string', :xref_param_type:`int`, :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'two_sided' (default), 'less' or 'greater' | | - 'two_sided' (default), 'less' or 'greater' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'unbiased' (default) or 'mle' | | - 'unbiased' (default) :xref_param_type:`or` 'mle' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (Q, P) array-like | | - (:xref_param_type:`Q`, :xref_param_type:`P`) :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (k_ar x neqs x neqs) | | - (:xref_param_type:`k_ar` :xref_param_type:`x` :xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (n,3) array | | - (n,3) :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (optional) instance of ResultStore | | - (optional) :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`ResultStore` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (optional), float or array | | - (optional), :xref_param_type:`float` or :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (optionsal), float or array | | - (:xref_param_type:`optionsal`), :xref_param_type:`float` or :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (scalar, array_like) | | - (:xref_param_type:`scalar`, :term:`numpy:array_like`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1 | | - 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D ndarray, shape (K,) | | - 1-D :xref_param_type:`ndarray `, :xref_param_type:`shape` (K,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1D array_like | | - 1D :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1D or 2D array_like | | - 1D or 2D :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d array | | - 1d :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d array (float) | | - 1d :xref_param_type:`array ` (:xref_param_type:`float`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d array, (nparams,) | | - 1d :xref_param_type:`array `, (nparams,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d array-like | | - 1d :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d array_like | | - 1d :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d or 2d array | | - 1d or 2d :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1darray | | - 1darray | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1xm array | | - 1xm :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2-D ndarray of ints, shape (nobs, K) | | - 2-D :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`ints `, :xref_param_type:`shape` (:xref_param_type:`nobs`, :xref_param_type:`K`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2D array-like | | - 2D :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2d array | | - 2d :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2d array (N,1) (optional) | | - 2d :xref_param_type:`array ` (N,1) (optional) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2d array (N,K) | | - 2d :xref_param_type:`array ` (N,K) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2d array, optional | | - 2d :xref_param_type:`array `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2d array-like | | - 2d :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2d array-like, optional | | - 2d :term:`array-like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2d ndarray | | - 2d :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 4 | | - 4 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`CointRankResults` | | - :class:`CointRankResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`VECMResults` | | - :class:`VECMResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`VECM` | | - :class:`VECM` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`statsmodels.iolib.summary.Summary` | | - :class:`statsmodels.iolib.summary.Summary` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`statsmodels.tsa.vector_ar.hypothesis_test_results.CausalityTestResults` | | - :class:`statsmodels.tsa.vector_ar.hypothesis_test_results.CausalityTestResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`statsmodels.tsa.vector_ar.hypothesis_test_results.NormalityTestResults` | | - :class:`statsmodels.tsa.vector_ar.hypothesis_test_results.NormalityTestResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`statsmodels.tsa.vector_ar.hypothesis_test_results.WhitenessTestResults` | | - :class:`statsmodels.tsa.vector_ar.hypothesis_test_results.WhitenessTestResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`statsmodels.tsa.vector_ar.var_model.LagOrderResults` | | - :class:`statsmodels.tsa.vector_ar.var_model.LagOrderResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ??? | | - ??? | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - A DiscreteModel instance | | - :xref_param_type:`A` :xref_param_type:`DiscreteModel` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - A scipy.stats or statsmodels distribution | | - :xref_param_type:`A` :xref_param_type:`scipy.stats` or :xref_param_type:`statsmodels` :xref_param_type:`distribution` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - AR Model instance | | - :xref_param_type:`AR` :xref_param_type:`Model` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - AR model instance | | - :xref_param_type:`AR` :xref_param_type:`model` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ARMA instance | | - :xref_param_type:`ARMA` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ARMAResults instance | | - :xref_param_type:`ARMAResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - AllPairsResults instance | | - :xref_param_type:`AllPairsResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Array_like | | - :xref_param_type:`Array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Axes instance | | - :xref_param_type:`Axes` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Bool | | - :xref_param_type:`Bool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Boolean | | - :xref_param_type:`Boolean` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Bunch | | - :xref_param_type:`Bunch` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - CSR sparse matrix | | - :xref_param_type:`CSR` :xref_param_type:`sparse ` :xref_param_type:`matrix ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ContrastResult instance | | - :xref_param_type:`ContrastResult` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ContrastResults instance | | - :xref_param_type:`ContrastResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - CovariancePenalty object | | - :xref_param_type:`CovariancePenalty` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - CustomKernel object | | - :xref_param_type:`CustomKernel` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame | | - :xref_param_type:`DataFrame ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame or pandas Styler instance | | - :xref_param_type:`DataFrame ` or :xref_param_type:`pandas` :xref_param_type:`Styler` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame, dict, or recarray | | - :xref_param_type:`DataFrame `, :xref_param_type:`dict`, :xref_param_type:`or` :xref_param_type:`recarray` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrames | | - :xref_param_type:`DataFrames` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Dataset instance | | - :xref_param_type:`Dataset` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DescStat instance | | - :xref_param_type:`DescStat` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Dictionary | | - :xref_param_type:`Dictionary` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Discrepancy of observed values | | - :xref_param_type:`Discrepancy` :xref_param_type:`of` :xref_param_type:`observed` :xref_param_type:`values` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DiscreteResults instance | | - :xref_param_type:`DiscreteResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DistributedModel class instance | | - :xref_param_type:`DistributedModel` :term:`python:class` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DynamicFactor instance | | - :xref_param_type:`DynamicFactor` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ExponentialSmoothing class | | - :xref_param_type:`ExponentialSmoothing` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ExponentialSmoothing instance | | - :xref_param_type:`ExponentialSmoothing` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Factor | | - :xref_param_type:`Factor` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Factor key | | - :xref_param_type:`Factor` :xref_param_type:`key` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - FactorResults instance | | - :xref_param_type:`FactorResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - False or float in (0, 1) | | - :xref_param_type:`False` or :xref_param_type:`float` :xref_param_type:`in` (0, 1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Figure | | - :xref_param_type:`Figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - FilterResults | | - :xref_param_type:`FilterResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Float (non-negative) | | - :xref_param_type:`Float` (non-negative) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Function. | | - Function. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - GEE class | | - :xref_param_type:`GEE` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - GEEResults instance | | - :xref_param_type:`GEEResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - GMMResult instance | | - :xref_param_type:`GMMResult` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - HamiltonFilterResults or KimSmootherResults instance | | - :xref_param_type:`HamiltonFilterResults` or :xref_param_type:`KimSmootherResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - HdrResults instance | | - :xref_param_type:`HdrResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Holder | | - :xref_param_type:`Holder` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Holt class | | - :xref_param_type:`Holt` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - HoltWintersResults class | | - :xref_param_type:`HoltWintersResults` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - IRAnalysis | | - :xref_param_type:`IRAnalysis` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Int | | - :xref_param_type:`Int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Integer | | - :xref_param_type:`Integer ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Integer or 'defined_by_method' | | - :xref_param_type:`Integer ` or 'defined_by_method' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Iterable | | - :xref_param_type:`Iterable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - KDEMultivariate instance | | - :xref_param_type:`KDEMultivariate` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - KalmanFilter | | - :xref_param_type:`KalmanFilter` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - KalmanFilter instance | | - :xref_param_type:`KalmanFilter` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - KalmanSmoother | | - :xref_param_type:`KalmanSmoother` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Kernel Class | | - :xref_param_type:`Kernel` :xref_param_type:`Class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - LagOrderResults | | - :xref_param_type:`LagOrderResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - List of strings of length equal to the number of parameters | | - :xref_param_type:`List` :xref_param_type:`of` :xref_param_type:`strings ` :xref_param_type:`of` :xref_param_type:`length` :xref_param_type:`equal` :xref_param_type:`to` :xref_param_type:`the` :xref_param_type:`number` :xref_param_type:`of` :xref_param_type:`parameters` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MLEModel instance | | - :xref_param_type:`MLEModel` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MarkovAutoregression instance | | - :xref_param_type:`MarkovAutoregression` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MarkovRegression instance | | - :xref_param_type:`MarkovRegression` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MarkovSwitching instance | | - :xref_param_type:`MarkovSwitching` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MarkovSwitchingModel | | - :xref_param_type:`MarkovSwitchingModel` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MaskedArray | | - :xref_param_type:`MaskedArray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib AxesSubplot instance | | - :xref_param_type:`Matplotlib` :xref_param_type:`AxesSubplot` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib AxesSubplot instance, optional | | - :xref_param_type:`Matplotlib` :xref_param_type:`AxesSubplot` :xref_param_type:`instance`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib Figure instance, optional | | - :xref_param_type:`Matplotlib` :xref_param_type:`Figure` :xref_param_type:`instance`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib Figure object | | - :xref_param_type:`Matplotlib` :xref_param_type:`Figure` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib LinearSegmentedColormap instance, optional | | - :xref_param_type:`Matplotlib` :xref_param_type:`LinearSegmentedColormap` :xref_param_type:`instance`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib axes instance | | - :xref_param_type:`Matplotlib` :xref_param_type:`axes` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib axes instance, optional | | - :xref_param_type:`Matplotlib` :xref_param_type:`axes` :xref_param_type:`instance`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib figure instance | | - :xref_param_type:`Matplotlib` :xref_param_type:`figure` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib figure instance, optional | | - :xref_param_type:`Matplotlib` :xref_param_type:`figure` :xref_param_type:`instance`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MixedLMParams object | | - :xref_param_type:`MixedLMParams` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MixedLMParams or array-like | | - :xref_param_type:`MixedLMParams` or :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MixedLMParams, or array-like. | | - :xref_param_type:`MixedLMParams`, :xref_param_type:`or` array-like. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Model class | | - :xref_param_type:`Model` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Model instance | | - :xref_param_type:`Model` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Model results instance | | - :xref_param_type:`Model` :xref_param_type:`results` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None | | - :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or 1-D ndarray | | - :xref_param_type:`None` or 1-D :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or a list of tuples | | - :xref_param_type:`None` or :xref_param_type:`a` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`tuples ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or array | | - :xref_param_type:`None` or :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or array_like | | - :xref_param_type:`None` or :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or axis instance | | - :xref_param_type:`None` or :xref_param_type:`axis` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or dict | | - :xref_param_type:`None` or :xref_param_type:`dict` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or family instance | | - :xref_param_type:`None` or :xref_param_type:`family` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or float | | - :xref_param_type:`None` or :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or float in (0,1) | | - :xref_param_type:`None` or :xref_param_type:`float` :xref_param_type:`in` (0,1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or float or array_like | | - :xref_param_type:`None` or :xref_param_type:`float` or :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or function | | - :xref_param_type:`None` or :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or int | | - :xref_param_type:`None` or :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or integer or float in intervall (0,1) | | - :xref_param_type:`None` or :xref_param_type:`integer ` or :xref_param_type:`float` :xref_param_type:`in` :xref_param_type:`intervall` (0,1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or joblib parallel_backend object | | - :xref_param_type:`None` or :xref_param_type:`joblib` :xref_param_type:`parallel_backend` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or list of int | | - :xref_param_type:`None` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or list of integers | | - :xref_param_type:`None` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`integers ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or list of smoother instances | | - :xref_param_type:`None` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`smoother` :xref_param_type:`instances` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or list of strings | | - :xref_param_type:`None` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or matplotlib axis instance | | - :xref_param_type:`None` or :xref_param_type:`matplotlib` :xref_param_type:`axis` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or matplotlib figure instance | | - :xref_param_type:`None` or :xref_param_type:`matplotlib` :xref_param_type:`figure` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or ndarray | | - :xref_param_type:`None` or :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or string | | - :xref_param_type:`None` or :xref_param_type:`string ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or tuple | | - :xref_param_type:`None` or :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or tuple of dicts | | - :xref_param_type:`None` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`dicts` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or tuple of int (nrows, ncols) | | - :xref_param_type:`None` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`int` (:xref_param_type:`nrows`, :xref_param_type:`ncols`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, 'dfk1', or 'dfk2' | | - :xref_param_type:`None`, 'dfk1', :xref_param_type:`or` 'dfk2' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, 'mean', or function | | - :xref_param_type:`None`, 'mean', :xref_param_type:`or` :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, float or int | | - :xref_param_type:`None`, :xref_param_type:`float` or :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, int or array_like | | - :xref_param_type:`None`, :xref_param_type:`int` or :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, int or tuple of array_like | | - :xref_param_type:`None`, :xref_param_type:`int` or :xref_param_type:`tuple` :xref_param_type:`of` :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, list of ints, list of strings | | - :xref_param_type:`None`, :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`ints `, :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, or list of strings | | - :xref_param_type:`None`, :xref_param_type:`or` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - NormalityTestResults | | - :xref_param_type:`NormalityTestResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - OLS result instance | | - :xref_param_type:`OLS` :xref_param_type:`result` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - OLS results instance | | - :xref_param_type:`OLS` :xref_param_type:`results` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - PHReg model instance | | - :xref_param_type:`PHReg` :xref_param_type:`model` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Panel | | - :xref_param_type:`Panel` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Penalty object | | - :xref_param_type:`Penalty` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Real | | - :xref_param_type:`Real` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Record Array | | - :xref_param_type:`Record` :xref_param_type:`Array` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - RecursiveLS instance | | - :xref_param_type:`RecursiveLS` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Regression Results instance | | - :xref_param_type:`Regression` :xref_param_type:`Results` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - RegressionEffects instance | | - :xref_param_type:`RegressionEffects` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - RegressionFDR instance | | - :xref_param_type:`RegressionFDR` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - RegressionResults instance | | - :xref_param_type:`RegressionResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Representation | | - :xref_param_type:`Representation` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Result instance | | - :xref_param_type:`Result` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ResultStore, optional | | - :xref_param_type:`ResultStore`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Results instance | | - :xref_param_type:`Results` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Results object | | - :xref_param_type:`Results` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - RobustNorm, optional | | - :xref_param_type:`RobustNorm`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - RootResult (optional) | | - :xref_param_type:`RootResult` (optional) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SARIMAX instance | | - :xref_param_type:`SARIMAX` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series, DataFrame, or ndarray | | - :xref_param_type:`Series `, :xref_param_type:`DataFrame `, :xref_param_type:`or` :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SimpleExpSmoothing class | | - :xref_param_type:`SimpleExpSmoothing` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SimpleTable | | - :xref_param_type:`SimpleTable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SimpleTable instance | | - :xref_param_type:`SimpleTable` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - StataWriter instance | | - :xref_param_type:`StataWriter` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - String | | - :xref_param_type:`String` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Summary instance | | - :xref_param_type:`Summary` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SummaryTable | | - :xref_param_type:`SummaryTable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - TODO: not implemented yet | | - TODO: :xref_param_type:`not` :xref_param_type:`implemented` :xref_param_type:`yet` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - TableDist object. | | - :xref_param_type:`TableDist` object. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - True or False | | - :xref_param_type:`True` or :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - TukeyHSDResults instance | | - :xref_param_type:`TukeyHSDResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - UnobservedComponents instance | | - :xref_param_type:`UnobservedComponents` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - VAR instance | | - :xref_param_type:`VAR` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - VAR model instance | | - :xref_param_type:`VAR` :xref_param_type:`model` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - VARMAX instance | | - :xref_param_type:`VARMAX` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - VARResults or VECMResults | | - :xref_param_type:`VARResults` or :xref_param_type:`VECMResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - VARResults or statsmodels.tsa.vecm.vecm.VECMResults | | - :xref_param_type:`VARResults` or :xref_param_type:`statsmodels.tsa.vecm.vecm.VECMResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - WhitenessTestResults | | - :xref_param_type:`WhitenessTestResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `ProbPlot` instance, array-like, or None, optional | | - `ProbPlot` :xref_param_type:`instance`, :term:`array-like`, :xref_param_type:`or` :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `statsmodels.tsa.arima.ARMA` instance | | - `statsmodels.tsa.arima.ARMA` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a dict of slices | | - :xref_param_type:`a` :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`slices` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a link function instance | | - :xref_param_type:`a` :xref_param_type:`link` :xref_param_type:`function` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a link instance, optional | | - :xref_param_type:`a` :xref_param_type:`link` :xref_param_type:`instance`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a list of figure handles | | - :xref_param_type:`a` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`figure` :xref_param_type:`handles` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a list of string(s) | | - :xref_param_type:`a` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`string `\(:xref_param_type:`s`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a list of strings | | - :xref_param_type:`a` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a variance function | | - :xref_param_type:`a` :xref_param_type:`variance` :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - anything | | - :xref_param_type:`anything` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array | | - :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (1+nobs,nvars) | | - :xref_param_type:`array ` (1+nobs,nvars) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (horiz, nvars) | | - :xref_param_type:`array ` (:xref_param_type:`horiz`, :xref_param_type:`nvars`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (nlags, nvar, nvar) | | - :xref_param_type:`array ` (:xref_param_type:`nlags`, :xref_param_type:`nvar`, :xref_param_type:`nvar`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (nlags,nvars,nvars) | | - :xref_param_type:`array ` (nlags,nvars,nvars) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (nlags-1, nvar, nvar) | | - :xref_param_type:`array ` (nlags-1, :xref_param_type:`nvar`, :xref_param_type:`nvar`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (nmoms, nmoms) | | - :xref_param_type:`array ` (:xref_param_type:`nmoms`, :xref_param_type:`nmoms`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (nobs+horiz, nvars) | | - :xref_param_type:`array ` (nobs+horiz, :xref_param_type:`nvars`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (nobs, 2) | | - :xref_param_type:`array ` (:xref_param_type:`nobs`, 2) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (nobs,nchoices) | | - :xref_param_type:`array ` (nobs,nchoices) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (nobs,nvars) | | - :xref_param_type:`array ` (nobs,nvars) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (nrepl,) | | - :xref_param_type:`array ` (nrepl,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array (optional) | | - :xref_param_type:`array ` (optional) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array 1d, (nobs+?,) | | - :xref_param_type:`array ` 1d, (nobs+?,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array like | | - :xref_param_type:`array ` :xref_param_type:`like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of bool | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`bool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of float | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of floats | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of int | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of shape given by size | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`shape` :xref_param_type:`given` :xref_param_type:`by` :xref_param_type:`size` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or DataFrame | | - :xref_param_type:`array ` or :xref_param_type:`DataFrame ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or None | | - :xref_param_type:`array ` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or Series | | - :xref_param_type:`array ` or :xref_param_type:`Series ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or dataframe | | - :xref_param_type:`array ` or :xref_param_type:`dataframe ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or float, optional | | - :xref_param_type:`array ` or :xref_param_type:`float`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or list | | - :xref_param_type:`array ` or :xref_param_type:`list` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or pd.DataFrame | | - :xref_param_type:`array ` or :xref_param_type:`pd.DataFrame` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, (nlags,nvars,nvars) | | - :xref_param_type:`array `, (nlags,nvars,nvars) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, (nobs, nchoices) | | - :xref_param_type:`array `, (:xref_param_type:`nobs`, :xref_param_type:`nchoices`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, (nobs, nobs) | | - :xref_param_type:`array `, (:xref_param_type:`nobs`, :xref_param_type:`nobs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, (nobs, nre) or (nobs,) | | - :xref_param_type:`array `, (:xref_param_type:`nobs`, :xref_param_type:`nre`) :xref_param_type:`or` (nobs,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, (nobs,nvars,nvars) | | - :xref_param_type:`array `, (nobs,nvars,nvars) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, (nre+1,) | | - :xref_param_type:`array `, (nre+1,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, 1d | | - :xref_param_type:`array `, 1d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, 2d | | - :xref_param_type:`array `, 2d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, DataFrame or None | | - :xref_param_type:`array `, :xref_param_type:`DataFrame ` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, Series, DataFrame or None | | - :xref_param_type:`array `, :xref_param_type:`Series `, :xref_param_type:`DataFrame ` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, bool | | - :xref_param_type:`array `, :xref_param_type:`bool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, boolean | | - :xref_param_type:`array `, :xref_param_type:`boolean ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, optional | | - :xref_param_type:`array `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, recarray or DataFrame | | - :xref_param_type:`array `, :xref_param_type:`recarray` or :xref_param_type:`DataFrame ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, shape () or (1,) or (K,) | | - :xref_param_type:`array `, :xref_param_type:`shape` () :xref_param_type:`or` (1,) :xref_param_type:`or` (K,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, shape (M, N) | | - :xref_param_type:`array `, :xref_param_type:`shape` (:xref_param_type:`M`, :xref_param_type:`N`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, shape (M,) or (M, K) | | - :xref_param_type:`array `, :xref_param_type:`shape` (M,) :xref_param_type:`or` (:xref_param_type:`M`, :xref_param_type:`K`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, shape (N, M) | | - :xref_param_type:`array `, :xref_param_type:`shape` (:xref_param_type:`N`, :xref_param_type:`M`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, shape (N,) or (N, K) depending on shape of b | | - :xref_param_type:`array `, :xref_param_type:`shape` (N,) :xref_param_type:`or` (:xref_param_type:`N`, :xref_param_type:`K`) :xref_param_type:`depending` :xref_param_type:`on` :xref_param_type:`shape` :xref_param_type:`of` :xref_param_type:`b` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, shape (min(M,N),) | | - :xref_param_type:`array `, :xref_param_type:`shape` (:xref_param_type:`min`\(M,N),) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like | | - :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like (`rank` + 1 if `rank` < `neqs` else `rank`) | | - :term:`array-like` (`rank` + 1 :xref_param_type:`if` `rank` < `neqs` :xref_param_type:`else` `rank`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like (`rank` +1 if `rank` < `neqs` else `rank`) | | - :term:`array-like` (`rank` +1 :xref_param_type:`if` `rank` < `neqs` :xref_param_type:`else` `rank`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like (length must be divisible by `ncut`) | | - :term:`array-like` (:xref_param_type:`length` :xref_param_type:`must` :xref_param_type:`be` :xref_param_type:`divisible` :xref_param_type:`by` `ncut`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like (nobs_tot x neqs) | | - :term:`array-like` (:xref_param_type:`nobs_tot` :xref_param_type:`x` :xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like NOT optional | | - :term:`array-like` :xref_param_type:`NOT` optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like object | | - :term:`array-like` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like of datetime, optional | | - :term:`array-like` :xref_param_type:`of` :xref_param_type:`datetime`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like or int | | - :term:`array-like` or :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, (nobs,) or (nobs, k_vars) | | - :term:`array-like`, (nobs,) :xref_param_type:`or` (:xref_param_type:`nobs`, :xref_param_type:`k_vars`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, 1-d | | - :term:`array-like`, 1-d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, 1d | | - :term:`array-like`, 1d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, optional | | - :term:`array-like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, optional An array of entry times for handling | | - :term:`array-like`, optional :xref_param_type:`An` :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`entry` :xref_param_type:`times` :xref_param_type:`for` :xref_param_type:`handling` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, optional after fit has been called | | - :term:`array-like`, optional :xref_param_type:`after` :xref_param_type:`fit` :xref_param_type:`has` :xref_param_type:`been` :xref_param_type:`called` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, optional. | | - :term:`array-like`, optional. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, pandas.Series | | - :term:`array-like`, :xref_param_type:`pandas.Series` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, str, or tuple | | - :term:`array-like`, :xref_param_type:`str`, :xref_param_type:`or` :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, str, tuple | | - :term:`array-like`, :xref_param_type:`str`, :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_lie | | - :xref_param_type:`array_lie` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_lik, 1d | | - :xref_param_type:`array_lik`, 1d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like | | - :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like (n_samples, k_vars) | | - :term:`numpy:array_like` (:xref_param_type:`n_samples`, :xref_param_type:`k_vars`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like (optional) | | - :term:`numpy:array_like` (optional) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of bool | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`bool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of int, 1-D | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`int`, 1-D | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or None | | - :term:`numpy:array_like` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or None, optional | | - :term:`numpy:array_like` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or float | | - :term:`numpy:array_like` or :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or instance of DescrStatsW | | - :term:`numpy:array_like` or :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`DescrStatsW` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or integer | | - :term:`numpy:array_like` or :xref_param_type:`integer ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or list | | - :term:`numpy:array_like` or :xref_param_type:`list` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or tuple, list | | - :term:`numpy:array_like` or :xref_param_type:`tuple`, :xref_param_type:`list` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 1-D | | - :term:`numpy:array_like`, 1-D | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 1-D or 2-D | | - :term:`numpy:array_like`, 1-D or 2-D | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 1-d | | - :term:`numpy:array_like`, 1-d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 1d | | - :term:`numpy:array_like`, 1d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 1d or 2d | | - :term:`numpy:array_like`, 1d or 2d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 1d, (nar+nma+1,) | | - :term:`numpy:array_like`, 1d, (nar+nma+1,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 1d, float | | - :term:`numpy:array_like`, 1d, :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 1d, optional | | - :term:`numpy:array_like`, 1d, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 2-D | | - :term:`numpy:array_like`, 2-D | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 2-Dim | | - :term:`numpy:array_like`, 2-Dim | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 2D | | - :term:`numpy:array_like`, 2D | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 2d | | - :term:`numpy:array_like`, 2d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 2d (N, k) | | - :term:`numpy:array_like`, 2d (:xref_param_type:`N`, :xref_param_type:`k`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 2d (N,k) | | - :term:`numpy:array_like`, 2d (N,k) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, 2d, (k, k) | | - :term:`numpy:array_like`, 2d, (:xref_param_type:`k`, :xref_param_type:`k`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, float | | - :term:`numpy:array_like`, :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, int | | - :term:`numpy:array_like`, :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, ndim | | - :term:`numpy:array_like`, :xref_param_type:`ndim` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, optional | | - :term:`numpy:array_like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, same ndim as x, currently 2d | | - :term:`numpy:array_like`, :xref_param_type:`same` :xref_param_type:`ndim` :xref_param_type:`as` :xref_param_type:`x`, :xref_param_type:`currently` 2d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, square | | - :term:`numpy:array_like`, :xref_param_type:`square` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, tuple ? | | - :term:`numpy:array_like`, :xref_param_type:`tuple` ? | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_likes, optional | | - :xref_param_type:`array_likes`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - arraylike | | - :xref_param_type:`arraylike` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - arraylike or None | | - :xref_param_type:`arraylike` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - axes, optional | | - :xref_param_type:`axes`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - axis or figure instance | | - :xref_param_type:`axis` or :xref_param_type:`figure` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool | | - :xref_param_type:`bool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool (default is True) | | - :xref_param_type:`bool` (default :xref_param_type:`is` :xref_param_type:`True`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool , optional | | - :xref_param_type:`bool` , optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or None | | - :xref_param_type:`bool` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or array-like | | - :xref_param_type:`bool` or :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or float | | - :xref_param_type:`bool` or :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or int | | - :xref_param_type:`bool` or :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or str | | - :xref_param_type:`bool` or :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or string, optional | | - :xref_param_type:`bool` or :xref_param_type:`string `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or tuple of scalars, optional | | - :xref_param_type:`bool` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`scalars`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or tuple, optional | | - :xref_param_type:`bool` or :xref_param_type:`tuple`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, | | - bool, | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default False | | - :xref_param_type:`bool`, default :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default is True | | - :xref_param_type:`bool`, default :xref_param_type:`is` :xref_param_type:`True` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default: False | | - :xref_param_type:`bool`, default: :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default: True | | - :xref_param_type:`bool`, default: :xref_param_type:`True` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default: `False` | | - :xref_param_type:`bool`, default: `False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional | | - :xref_param_type:`bool`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional (default True) | | - :xref_param_type:`bool`, optional (default :xref_param_type:`True`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean | | - :xref_param_type:`boolean ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean or iterable, optional | | - :xref_param_type:`boolean ` or :term:`python:iterable`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, | | - boolean, | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default True | | - :xref_param_type:`boolean `, default :xref_param_type:`True` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default: False | | - :xref_param_type:`boolean `, default: :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, int, str, or datetime, optional | | - :xref_param_type:`boolean `, :xref_param_type:`int`, :xref_param_type:`str`, :xref_param_type:`or` :xref_param_type:`datetime`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, optional | | - :xref_param_type:`boolean `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean,optional | | - boolean,optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boot, optional | | - :xref_param_type:`boot`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable | | - :xref_param_type:`callable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable (default is numpy.exp) | | - :xref_param_type:`callable` (default :xref_param_type:`is` :xref_param_type:`numpy.exp`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable (default is numpy.log) | | - :xref_param_type:`callable` (default :xref_param_type:`is` :xref_param_type:`numpy.log`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable callback(xk) | | - :xref_param_type:`callable` :xref_param_type:`callback`\(:xref_param_type:`xk`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable callback(xk), optional | | - :xref_param_type:`callable` :xref_param_type:`callback`\(:xref_param_type:`xk`), optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable or float | | - :xref_param_type:`callable` or :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class | | - :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class instance | | - :term:`python:class` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class or object, optional | | - :term:`python:class` or :xref_param_type:`object`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class, optional | | - :term:`python:class`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - continuous distribution | | - :xref_param_type:`continuous` :xref_param_type:`distribution` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - datetime.datetime | | - :xref_param_type:`datetime.datetime` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - depends on cov_type | | - :xref_param_type:`depends` :xref_param_type:`on` :xref_param_type:`cov_type` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict | | - :xref_param_type:`dict` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or None | | - :xref_param_type:`dict` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or None, optional | | - :xref_param_type:`dict` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, None | | - :xref_param_type:`dict`, :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, optional | | - :xref_param_type:`dict`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, pandas.Series, np.ndarray, pandas.DataFrame | | - :xref_param_type:`dict`, :xref_param_type:`pandas.Series`, :xref_param_type:`np.ndarray`, :xref_param_type:`pandas.DataFrame` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict-like | | - dict-like | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict-like or None | | - dict-like or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict_like | | - :xref_param_type:`dict_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dictionary | | - :xref_param_type:`dictionary ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dictionary of name,tuple | | - :xref_param_type:`dictionary ` :xref_param_type:`of` name,tuple | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dictionary of name:tuple | | - :xref_param_type:`dictionary ` :xref_param_type:`of` name:tuple | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dictionary, optional | | - :xref_param_type:`dictionary `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - discrete frozen distribution | | - :xref_param_type:`discrete` :xref_param_type:`frozen` :xref_param_type:`distribution` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - distribution instance | | - :xref_param_type:`distribution` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - distribution instance with fit_fr method | | - :xref_param_type:`distribution` :xref_param_type:`instance` :xref_param_type:`with` :xref_param_type:`fit_fr` :xref_param_type:`method` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dit-like | | - dit-like | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype | | - :xref_param_type:`dtype ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - extra arguments | | - :xref_param_type:`extra` :xref_param_type:`arguments` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - extra keyword arguments | | - :xref_param_type:`extra` :xref_param_type:`keyword` :xref_param_type:`arguments` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - figure | | - :xref_param_type:`figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file path or buffer | | - :xref_param_type:`file` :xref_param_type:`path` or :xref_param_type:`buffer` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file-like | | - :term:`file-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - filename or file handle | | - :xref_param_type:`filename` or :xref_param_type:`file` :xref_param_type:`handle` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - fitted linear model results instance | | - :xref_param_type:`fitted` :xref_param_type:`linear` :xref_param_type:`model` :xref_param_type:`results` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float | | - :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float (for general case will be array) | | - :xref_param_type:`float` (:xref_param_type:`for` :xref_param_type:`general` :xref_param_type:`case` :xref_param_type:`will` :xref_param_type:`be` :xref_param_type:`array `) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float (0 < signif < 1) | | - :xref_param_type:`float` (0 < :xref_param_type:`signif` < 1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float (default 1e-6) | | - :xref_param_type:`float` (default 1e-6) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float (default is 0.5) | | - :xref_param_type:`float` (default :xref_param_type:`is` 0.5) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float (default is 0.8) | | - :xref_param_type:`float` (default :xref_param_type:`is` 0.8) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float (default: alpha = 0.05) | | - :xref_param_type:`float` (default: :xref_param_type:`alpha` = 0.05) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float (negative) or None | | - :xref_param_type:`float` (:xref_param_type:`negative`) :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float (optional) | | - :xref_param_type:`float` (optional) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float (positive) or None | | - :xref_param_type:`float` (:xref_param_type:`positive`) :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float 0 < `alpha` < 1, default 0.05 | | - :xref_param_type:`float` 0 < `alpha` < 1, default 0.05 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float between 0 and 1, default 5 % | | - :xref_param_type:`float` :xref_param_type:`between` 0 :xref_param_type:`and` 1, default 5 % | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float between 0 and 1, optional | | - :xref_param_type:`float` :xref_param_type:`between` 0 :xref_param_type:`and` 1, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float in (0, 1) | | - :xref_param_type:`float` :xref_param_type:`in` (0, 1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float in (0, 1), optional | | - :xref_param_type:`float` :xref_param_type:`in` (0, 1), optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float in (0,1) | | - :xref_param_type:`float` :xref_param_type:`in` (0,1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float in interval (0,1) | | - :xref_param_type:`float` :xref_param_type:`in` :xref_param_type:`interval` (0,1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or 'auto' (default = 'auto') | | - :xref_param_type:`float` or 'auto' (default = 'auto') | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or 'med', 'min', 'max' | | - :xref_param_type:`float` or 'med', 'min', 'max' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or None | | - :xref_param_type:`float` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or None, optional | | - :xref_param_type:`float` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or array | | - :xref_param_type:`float` or :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or array of floats | | - :xref_param_type:`float` or :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or array, optional. | | - :xref_param_type:`float` or :xref_param_type:`array `, optional. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or array-like | | - :xref_param_type:`float` or :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or array_like | | - :xref_param_type:`float` or :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or inf | | - :xref_param_type:`float` or :xref_param_type:`inf` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or int, array | | - :xref_param_type:`float` or :xref_param_type:`int`, :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or ndarray | | - :xref_param_type:`float` or :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or string | | - :xref_param_type:`float` or :xref_param_type:`string ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or tuple | | - :xref_param_type:`float` or :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, 0 < `alpha` < 1 | | - :xref_param_type:`float`, 0 < `alpha` < 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, 0 < `alpha` < 1 or None | | - :xref_param_type:`float`, 0 < `alpha` < 1 or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, 0 < `signif` < 1 | | - :xref_param_type:`float`, 0 < `signif` < 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, 0 < `signif` < 1, default 5 % | | - :xref_param_type:`float`, 0 < `signif` < 1, default 5 % | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, 0 <= `pvalue` <= 1 | | - :xref_param_type:`float`, 0 <= `pvalue` <= 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, a small positive number | | - :xref_param_type:`float`, :xref_param_type:`a` :xref_param_type:`small` :xref_param_type:`positive` :xref_param_type:`number` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, array_like or None, optional | | - :xref_param_type:`float`, :term:`numpy:array_like` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, between 0 and 1 | | - :xref_param_type:`float`, :xref_param_type:`between` 0 :xref_param_type:`and` 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, default 1.96 | | - :xref_param_type:`float`, default 1.96 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, default 5% | | - :xref_param_type:`float`, default 5% | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, ndarray | | - :xref_param_type:`float`, :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional | | - :xref_param_type:`float`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, {0.1, 0.05, 0.01}, default: 0.05 | | - :xref_param_type:`float`, {0.1, 0.05, 0.01}, default: 0.05 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - formula expression or tuple | | - :xref_param_type:`formula` :xref_param_type:`expression` or :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function | | - :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function (defualt None) | | - :xref_param_type:`function` (:xref_param_type:`defualt` :xref_param_type:`None`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function (key) -> dict, optional | | - :xref_param_type:`function` (:xref_param_type:`key`) -> :xref_param_type:`dict`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function (key) -> string, optional | | - :xref_param_type:`function` (:xref_param_type:`key`) -> :xref_param_type:`string `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function mapping reals to positive reals | | - :xref_param_type:`function` :xref_param_type:`mapping` :xref_param_type:`reals` :xref_param_type:`to` :xref_param_type:`positive` :xref_param_type:`reals` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function or array-like | | - :xref_param_type:`function` or :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function, default: kernel_rbf | | - :xref_param_type:`function`, default: :xref_param_type:`kernel_rbf` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function, optional | | - :xref_param_type:`function`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function, random number generator | | - :xref_param_type:`function`, :xref_param_type:`random` :xref_param_type:`number` :xref_param_type:`generator` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - generalized_linear_model.PredictionResults | | - :xref_param_type:`generalized_linear_model.PredictionResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - generator | | - :xref_param_type:`generator` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - generator or None | | - :xref_param_type:`generator` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - html color | | - :xref_param_type:`html` :xref_param_type:`color` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance | | - :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance (optional) | | - :xref_param_type:`instance` (optional) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance numpy.ndarray | | - :xref_param_type:`instance` :xref_param_type:`numpy.ndarray` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of (GenericLikelihood ?)Result class | | - instance of (GenericLikelihood ?)Result class | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of Bunch with | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`Bunch` :xref_param_type:`with` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of CompareMeans | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`CompareMeans` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of GMMResults | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`GMMResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of LikelihoodResults | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`LikelihoodResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of MVNormal | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`MVNormal` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of MVT | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`MVT` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of RegressionResults | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`RegressionResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of SimpleTable | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`SimpleTable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of a distribution class | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`a` :xref_param_type:`distribution` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of result class | | - :xref_param_type:`instance` :xref_param_type:`of` :xref_param_type:`result` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int | | - :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (0 <= `rank` <= `neqs`) | | - :xref_param_type:`int` (0 <= `rank` <= `neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (default is 0) | | - :xref_param_type:`int` (default :xref_param_type:`is` 0) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (default is 2) | | - :xref_param_type:`int` (default :xref_param_type:`is` 2) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (default: 1) | | - :xref_param_type:`int` (default: 1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (optional, default=1) | | - :xref_param_type:`int` (optional, default=1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (or float) | | - :xref_param_type:`int` (:xref_param_type:`or` :xref_param_type:`float`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int > 0 | | - :xref_param_type:`int` > 0 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int >= 0 | | - :xref_param_type:`int` >= 0 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int in {2, ..., 10} | | - :xref_param_type:`int` :xref_param_type:`in` {2, ..., 10} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or 'cue' | | - :xref_param_type:`int` or 'cue' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or 'freq', optional | | - :xref_param_type:`int` or 'freq', optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or None | | - :xref_param_type:`int` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or None, default: None | | - :xref_param_type:`int` or :xref_param_type:`None`, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or None, optional | | - :xref_param_type:`int` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or array | | - :xref_param_type:`int` or :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or array_like | | - :xref_param_type:`int` or :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or array_like, optional | | - :xref_param_type:`int` or :term:`numpy:array_like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or bin edges | | - :xref_param_type:`int` or :xref_param_type:`bin` :xref_param_type:`edges` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or float | | - :xref_param_type:`int` or :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or np.e | | - :xref_param_type:`int` or :xref_param_type:`np.e` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or np.e, optional | | - :xref_param_type:`int` or :xref_param_type:`np.e`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or np.inf | | - :xref_param_type:`int` or :xref_param_type:`np.inf` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str | | - :xref_param_type:`int` or :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str or iterable of int or string, optional | | - :xref_param_type:`int` or :xref_param_type:`str` or :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`int` or :xref_param_type:`string `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str or sequence of int or str | | - :xref_param_type:`int` or :xref_param_type:`str` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`int` or :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str or sequence of int or str or None, default: None | | - :xref_param_type:`int` or :xref_param_type:`str` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`int` or :xref_param_type:`str` or :xref_param_type:`None`, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str or sequence of int or str or `None`, default: `None` | | - :xref_param_type:`int` or :xref_param_type:`str` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`int` or :xref_param_type:`str` or `None`, default: `None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str {1,2,3} or {"I","II","III"} | | - :xref_param_type:`int` or :xref_param_type:`str` {1,2,3} :xref_param_type:`or` {"I","II","III"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or string | | - :xref_param_type:`int` or :xref_param_type:`string ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or tuple | | - :xref_param_type:`int` or :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or tuple of ints | | - :xref_param_type:`int` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, 0 <= `coint_rank` <= neqs | | - :xref_param_type:`int`, 0 <= `coint_rank` <= :xref_param_type:`neqs` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, >= 1 | | - :xref_param_type:`int`, >= 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, array_like | | - :xref_param_type:`int`, :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default 1 | | - :xref_param_type:`int`, default 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default 100 | | - :xref_param_type:`int`, default 100 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default 1000 | | - :xref_param_type:`int`, default 1000 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default 500 | | - :xref_param_type:`int`, default 500 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default None | | - :xref_param_type:`int`, default :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default: 0 | | - :xref_param_type:`int`, default: 0 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, float | | - :xref_param_type:`int`, :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, nonnegative | | - :xref_param_type:`int`, :xref_param_type:`nonnegative` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optiona | | - :xref_param_type:`int`, :xref_param_type:`optiona` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional | | - :xref_param_type:`int`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional0 | | - :xref_param_type:`int`, :xref_param_type:`optional0` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, str, or datetime | | - :xref_param_type:`int`, :xref_param_type:`str`, :xref_param_type:`or` :xref_param_type:`datetime` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, str, or datetime, optional | | - :xref_param_type:`int`, :xref_param_type:`str`, :xref_param_type:`or` :xref_param_type:`datetime`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer | | - :xref_param_type:`integer ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer (default 501) | | - :xref_param_type:`integer ` (default 501) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer (default: 0) | | - :xref_param_type:`integer ` (default: 0) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer or array-like | | - :xref_param_type:`integer ` or :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer or array_like | | - :xref_param_type:`integer ` or :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer or string | | - :xref_param_type:`integer ` or :xref_param_type:`string ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, optional | | - :xref_param_type:`integer `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable | | - :term:`python:iterable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable of DataFrames | | - :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`DataFrames` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable or iterable of iterables, optional | | - :term:`python:iterable` or :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`iterables`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable, optional | | - :term:`python:iterable`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - kalman_filter.PredictionResults | | - :xref_param_type:`kalman_filter.PredictionResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - kalman_filter.PredictionResults instance | | - :xref_param_type:`kalman_filter.PredictionResults` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - keys for term_slices | | - :xref_param_type:`keys` :xref_param_type:`for` :xref_param_type:`term_slices` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - keyword arguments | | - :xref_param_type:`keyword` :xref_param_type:`arguments` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - keywords | | - :xref_param_type:`keywords` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label | | - :xref_param_type:`label` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - linear_model.PredictionResults | | - :xref_param_type:`linear_model.PredictionResults` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - link function or None | | - :xref_param_type:`link` :xref_param_type:`function` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list | | - :xref_param_type:`list` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list (n_samples,) | | - :xref_param_type:`list` (n_samples,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list (or tuple) of str | | - :xref_param_type:`list` (:xref_param_type:`or` :xref_param_type:`tuple`) :xref_param_type:`of` :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list ? check | | - :xref_param_type:`list` ? :xref_param_type:`check` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of SimpleTable | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`SimpleTable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of SimpleTable instances | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`SimpleTable` :xref_param_type:`instances` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of arrays | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`arrays` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of float | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of floats | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of floats between 0 and 1, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`floats ` :xref_param_type:`between` 0 :xref_param_type:`and` 1, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of int | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of length 2 | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`length` 2 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of lists or 2d array (not matrix!) | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`lists` or 2d :xref_param_type:`array ` (:xref_param_type:`not` matrix!) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of mu, mc2, skew, kurt | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`mu`, :xref_param_type:`mc2`, :xref_param_type:`skew`, :xref_param_type:`kurt` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of ndarrays | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`ndarrays` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of pairs | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`pairs` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of str | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of str or None | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of str, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of strings | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of strings or None | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of strings, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of tuple | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of tuples | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`tuples ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of tuples or None | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`tuples ` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of units | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`units` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or None | | - :xref_param_type:`list` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or None, optional | | - :xref_param_type:`list` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or iterable of ndarrays | | - :xref_param_type:`list` or :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`ndarrays` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or ndarray | | - :xref_param_type:`list` or :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list(int) | | - :xref_param_type:`list`\(:xref_param_type:`int`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, length s+1 | | - :xref_param_type:`list`, :xref_param_type:`length` s+1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, optional | | - :xref_param_type:`list`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list/tuple of array-like | | - list/tuple :xref_param_type:`of` :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list[str] | | - :xref_param_type:`list`\[:xref_param_type:`str`] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - m x m array | | - :xref_param_type:`m` :xref_param_type:`x` :xref_param_type:`m` :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - marginal effects instance | | - :xref_param_type:`marginal` :xref_param_type:`effects` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib Axes instance | | - :xref_param_type:`matplotlib` :xref_param_type:`Axes` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib Figure | | - :xref_param_type:`matplotlib` :xref_param_type:`Figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib Figure instance | | - :xref_param_type:`matplotlib` :xref_param_type:`Figure` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib axes | | - :xref_param_type:`matplotlib` :xref_param_type:`axes` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib axes instance | | - :xref_param_type:`matplotlib` :xref_param_type:`axes` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib axes object | | - :xref_param_type:`matplotlib` :xref_param_type:`axes` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib axis, optional | | - :xref_param_type:`matplotlib` :xref_param_type:`axis`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib figure | | - :xref_param_type:`matplotlib` :xref_param_type:`figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib figure instance | | - :xref_param_type:`matplotlib` :xref_param_type:`figure` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.Axes, optional | | - :xref_param_type:`matplotlib.Axes`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.Figure | | - :xref_param_type:`matplotlib.Figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.axes | | - :xref_param_type:`matplotlib.axes` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.axes, optional | | - :xref_param_type:`matplotlib.axes`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - model class, optional | | - :xref_param_type:`model` :term:`python:class`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - model instance | | - :xref_param_type:`model` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - model object | | - :xref_param_type:`model` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - model results instance | | - :xref_param_type:`model` :xref_param_type:`results` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - module | | - :xref_param_type:`module` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - namedtuple | | - :xref_param_type:`namedtuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - nd_array, (n_cat, n_cat) | | - :xref_param_type:`nd_array`, (:xref_param_type:`n_cat`, :xref_param_type:`n_cat`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - nd_array, (n_rows, n_cat) | | - :xref_param_type:`nd_array`, (:xref_param_type:`n_rows`, :xref_param_type:`n_cat`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray | | - :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (#(determinist. terms inside the coint. rel.) x `coint_rank`) | | - :xref_param_type:`ndarray ` (#(determinist. :xref_param_type:`terms` :xref_param_type:`inside` :xref_param_type:`the` coint. rel.) :xref_param_type:`x` `coint_rank`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (1 x `coint_rank`) | | - :xref_param_type:`ndarray ` (1 :xref_param_type:`x` `coint_rank`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (1 x neqs) or (neqs) | | - :xref_param_type:`ndarray ` (1 :xref_param_type:`x` :xref_param_type:`neqs`) :xref_param_type:`or` (:xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (K x K) | | - :xref_param_type:`ndarray ` (:xref_param_type:`K` :xref_param_type:`x` :xref_param_type:`K`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (Kp + 1) x K | | - :xref_param_type:`ndarray ` (:xref_param_type:`Kp` + 1) :xref_param_type:`x` :xref_param_type:`K` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (T x K) | | - :xref_param_type:`ndarray ` (:xref_param_type:`T` :xref_param_type:`x` :xref_param_type:`K`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (d x d) | | - :xref_param_type:`ndarray ` (:xref_param_type:`d` :xref_param_type:`x` :xref_param_type:`d`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (d) | | - :xref_param_type:`ndarray ` (:xref_param_type:`d`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (exog_coint.shape[1] x `coint_rank`) or `None` | | - :xref_param_type:`ndarray ` (:xref_param_type:`exog_coint.shape`\[1] :xref_param_type:`x` `coint_rank`) :xref_param_type:`or` `None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (k x k) | | - :xref_param_type:`ndarray ` (:xref_param_type:`k` :xref_param_type:`x` :xref_param_type:`k`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (k x k), lower triangular | | - :xref_param_type:`ndarray ` (:xref_param_type:`k` :xref_param_type:`x` :xref_param_type:`k`), :xref_param_type:`lower` :xref_param_type:`triangular` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (k x k), optional | | - :xref_param_type:`ndarray ` (:xref_param_type:`k` :xref_param_type:`x` :xref_param_type:`k`), optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (k_ar x neqs x neqs) | | - :xref_param_type:`ndarray ` (:xref_param_type:`k_ar` :xref_param_type:`x` :xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (k_ar x neqs) | | - :xref_param_type:`ndarray ` (:xref_param_type:`k_ar` :xref_param_type:`x` :xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (k_ar_diff*neqs x nobs) | | - :xref_param_type:`ndarray ` (k_ar_diff*neqs :xref_param_type:`x` :xref_param_type:`nobs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (k_vars, k_vars) | | - :xref_param_type:`ndarray ` (:xref_param_type:`k_vars`, :xref_param_type:`k_vars`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (k_vars, k_vars) or scalar | | - :xref_param_type:`ndarray ` (:xref_param_type:`k_vars`, :xref_param_type:`k_vars`) :xref_param_type:`or` :xref_param_type:`scalar` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (len_endog x n_seasons-1) | | - :xref_param_type:`ndarray ` (:xref_param_type:`len_endog` :xref_param_type:`x` n_seasons-1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (length k) | | - :xref_param_type:`ndarray ` (:xref_param_type:`length` :xref_param_type:`k`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (m,1) | | - :xref_param_type:`ndarray ` (m,1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (maxn x k x k) | | - :xref_param_type:`ndarray ` (:xref_param_type:`maxn` :xref_param_type:`x` :xref_param_type:`k` :xref_param_type:`x` :xref_param_type:`k`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (maxn x neqs x neqs) | | - :xref_param_type:`ndarray ` (:xref_param_type:`maxn` :xref_param_type:`x` :xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (n,k) | | - :xref_param_type:`ndarray ` (n,k) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x #(deterministic terms outside the coint. rel.)) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` #(:xref_param_type:`deterministic` :xref_param_type:`terms` :xref_param_type:`outside` :xref_param_type:`the` coint. rel.)) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x 1) or (neqs x 0) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` 1) :xref_param_type:`or` (:xref_param_type:`neqs` :xref_param_type:`x` 0) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x `coint_rank`) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` `coint_rank`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x det. terms outside the coint. relation) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` det. :xref_param_type:`terms` :xref_param_type:`outside` :xref_param_type:`the` coint. :xref_param_type:`relation`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x exog_coefs.shape[1]) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`exog_coefs.shape`\[1]) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x neqs) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x neqs), optional | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`neqs`), optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x neqs*(k_ar-1)) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` neqs*(k_ar-1)) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x nobs) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`nobs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x nobs_tot) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`nobs_tot`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x number_of_deterministic_terms) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`number_of_deterministic_terms`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs x seasons) | | - :xref_param_type:`ndarray ` (:xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`seasons`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs**2 * k_ar x neqs**2 * k_ar) | | - :xref_param_type:`ndarray ` (neqs**2 * :xref_param_type:`k_ar` :xref_param_type:`x` neqs**2 * :xref_param_type:`k_ar`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (neqs+num_det_coef_coint x `coint_rank`) | | - :xref_param_type:`ndarray ` (neqs+num_det_coef_coint :xref_param_type:`x` `coint_rank`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (nobs x neqs) | | - :xref_param_type:`ndarray ` (:xref_param_type:`nobs` :xref_param_type:`x` :xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (nobs) | | - :xref_param_type:`ndarray ` (:xref_param_type:`nobs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (nobs,) or (nobs, k_var) | | - :xref_param_type:`ndarray ` (nobs,) :xref_param_type:`or` (:xref_param_type:`nobs`, :xref_param_type:`k_var`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (nobs,) or (nobs, nobs) | | - :xref_param_type:`ndarray ` (nobs,) :xref_param_type:`or` (:xref_param_type:`nobs`, :xref_param_type:`nobs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (nobs_tot x #det_terms) or None, default: None | | - :xref_param_type:`ndarray ` (:xref_param_type:`nobs_tot` :xref_param_type:`x` #det_terms) :xref_param_type:`or` :xref_param_type:`None`, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (nobs_tot x #det_terms_coint) or None, default: None | | - :xref_param_type:`ndarray ` (:xref_param_type:`nobs_tot` :xref_param_type:`x` #det_terms_coint) :xref_param_type:`or` :xref_param_type:`None`, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (nobs_tot x neqs) or `None` | | - :xref_param_type:`ndarray ` (:xref_param_type:`nobs_tot` :xref_param_type:`x` :xref_param_type:`neqs`) :xref_param_type:`or` `None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (nobs_tot x neqs) or `None`, default: `None` | | - :xref_param_type:`ndarray ` (:xref_param_type:`nobs_tot` :xref_param_type:`x` :xref_param_type:`neqs`) :xref_param_type:`or` `None`, default: `None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (num_det_coef_coint x `coint_rank`) | | - :xref_param_type:`ndarray ` (:xref_param_type:`num_det_coef_coint` :xref_param_type:`x` `coint_rank`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (p x K x K) | | - :xref_param_type:`ndarray ` (:xref_param_type:`p` :xref_param_type:`x` :xref_param_type:`K` :xref_param_type:`x` :xref_param_type:`K`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (p x k x k) | | - :xref_param_type:`ndarray ` (:xref_param_type:`p` :xref_param_type:`x` :xref_param_type:`k` :xref_param_type:`x` :xref_param_type:`k`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (p x k) | | - :xref_param_type:`ndarray ` (:xref_param_type:`p` :xref_param_type:`x` :xref_param_type:`k`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (pq x pq) | | - :xref_param_type:`ndarray ` (:xref_param_type:`pq` :xref_param_type:`x` :xref_param_type:`pq`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (steps x neqs) | | - :xref_param_type:`ndarray ` (:xref_param_type:`steps` :xref_param_type:`x` :xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (steps x self.exog.shape[1]) | | - :xref_param_type:`ndarray ` (:xref_param_type:`steps` :xref_param_type:`x` :xref_param_type:`self.exog.shape`\[1]) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (subclass) | | - :xref_param_type:`ndarray ` (:xref_param_type:`subclass`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (trend_coefs.shape[1] x neqs) | | - :xref_param_type:`ndarray ` (:xref_param_type:`trend_coefs.shape`\[1] :xref_param_type:`x` :xref_param_type:`neqs`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray ? | | - :xref_param_type:`ndarray ` ? | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of int | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of ints, shape (nobs, K) | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`ints `, :xref_param_type:`shape` (:xref_param_type:`nobs`, :xref_param_type:`K`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or ?? | | - :xref_param_type:`ndarray ` or ?? | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or DataFrame | | - :xref_param_type:`ndarray ` or :xref_param_type:`DataFrame ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or None | | - :xref_param_type:`ndarray ` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or `None`, default: `None` | | - :xref_param_type:`ndarray ` or `None`, default: `None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or float | | - :xref_param_type:`ndarray ` or :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or list of strings | | - :xref_param_type:`ndarray ` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or string | | - :xref_param_type:`ndarray ` or :xref_param_type:`string ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or tuple of 2 ndarray's | | - :xref_param_type:`ndarray ` or :xref_param_type:`tuple` :xref_param_type:`of` 2 ndarray's | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (1,m) | | - :xref_param_type:`ndarray `, (1,m) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (K * (J-1),) | | - :xref_param_type:`ndarray `, (:xref_param_type:`K` * (J-1),) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (k, k) | | - :xref_param_type:`ndarray `, (:xref_param_type:`k`, :xref_param_type:`k`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (k,k) | | - :xref_param_type:`ndarray `, (k,k) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (k_constraints, 2) | | - :xref_param_type:`ndarray `, (:xref_param_type:`k_constraints`, 2) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (k_vars, k_vars) | | - :xref_param_type:`ndarray `, (:xref_param_type:`k_vars`, :xref_param_type:`k_vars`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (k_vars,) or scalar | | - :xref_param_type:`ndarray `, (k_vars,) :xref_param_type:`or` :xref_param_type:`scalar` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (len(frac), len(idx)) | | - :xref_param_type:`ndarray `, (:xref_param_type:`len`\(:xref_param_type:`frac`), :xref_param_type:`len`\(:xref_param_type:`idx`)) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (len(x), len(idx)) | | - :xref_param_type:`ndarray `, (:xref_param_type:`len`\(:xref_param_type:`x`), :xref_param_type:`len`\(:xref_param_type:`idx`)) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (n, len(m)) | | - :xref_param_type:`ndarray `, (:xref_param_type:`n`, :xref_param_type:`len`\(:xref_param_type:`m`)) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (n,k) | | - :xref_param_type:`ndarray `, (n,k) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (n_groups,) | | - :xref_param_type:`ndarray `, (n_groups,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (nlags+1,) | | - :xref_param_type:`ndarray `, (nlags+1,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (nobs, k_vars_fe) | | - :xref_param_type:`ndarray `, (:xref_param_type:`nobs`, :xref_param_type:`k_vars_fe`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (nobs, k_vars_re) | | - :xref_param_type:`ndarray `, (:xref_param_type:`nobs`, :xref_param_type:`k_vars_re`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (nobs, n_groups) | | - :xref_param_type:`ndarray `, (:xref_param_type:`nobs`, :xref_param_type:`n_groups`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (nobs,) | | - :xref_param_type:`ndarray `, (nobs,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (nobs,) or (nobs, k_vars) | | - :xref_param_type:`ndarray `, (nobs,) :xref_param_type:`or` (:xref_param_type:`nobs`, :xref_param_type:`k_vars`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, (optional) | | - :xref_param_type:`ndarray `, (optional) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, 1-D | | - :xref_param_type:`ndarray `, 1-D | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, 1d | | - :xref_param_type:`ndarray `, 1d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, 2-D | | - :xref_param_type:`ndarray `, 2-D | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, 2d | | - :xref_param_type:`ndarray `, 2d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, 2d, (nm*(nm-1)/2, nm) | | - :xref_param_type:`ndarray `, 2d, (nm*(nm-1)/2, :xref_param_type:`nm`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, 2d, (nm-1, nm) | | - :xref_param_type:`ndarray `, 2d, (nm-1, :xref_param_type:`nm`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, 2d, (nobs, nfactors) | | - :xref_param_type:`ndarray `, 2d, (:xref_param_type:`nobs`, :xref_param_type:`nfactors`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, 2d, (nobs, nvars) | | - :xref_param_type:`ndarray `, 2d, (:xref_param_type:`nobs`, :xref_param_type:`nvars`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, 2d, symmetric | | - :xref_param_type:`ndarray `, 2d, :xref_param_type:`symmetric` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, float, 1d | | - :xref_param_type:`ndarray `, :xref_param_type:`float`, 1d | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, int8, 2d (nobs, n_groups) | | - :xref_param_type:`ndarray `, :xref_param_type:`int8`, 2d (:xref_param_type:`nobs`, :xref_param_type:`n_groups`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, ndim-1 | | - :xref_param_type:`ndarray `, ndim-1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, optional | | - :xref_param_type:`ndarray `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, pandas.Series or pandas.DataFrame | | - :xref_param_type:`ndarray `, :xref_param_type:`pandas.Series` or :xref_param_type:`pandas.DataFrame` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape (nobs, K) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape` (:xref_param_type:`nobs`, :xref_param_type:`K`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray-like | | - ndarray-like | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray_1d | | - :xref_param_type:`ndarray_1d` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - neqs x neqs array, default to largest for each | | - :xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`neqs` :xref_param_type:`array `, default :xref_param_type:`to` :xref_param_type:`largest` :xref_param_type:`for` :xref_param_type:`each` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - neqs x neqs mask array with known parameters masked | | - :xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`neqs` :xref_param_type:`mask` :xref_param_type:`array ` :xref_param_type:`with` :xref_param_type:`known` :xref_param_type:`parameters` :xref_param_type:`masked` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - neqs x neqs np.ndarray with unknown parameters marked with 'E' | | - :xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`neqs` :xref_param_type:`np.ndarray` :xref_param_type:`with` :xref_param_type:`unknown` :xref_param_type:`parameters` :xref_param_type:`marked` :xref_param_type:`with` 'E' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - neqs x neqs np.ndarry with unknown parameters marked with 'E' | | - :xref_param_type:`neqs` :xref_param_type:`x` :xref_param_type:`neqs` :xref_param_type:`np.ndarry` :xref_param_type:`with` :xref_param_type:`unknown` :xref_param_type:`parameters` :xref_param_type:`marked` :xref_param_type:`with` 'E' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - nested tuples and lists | | - :xref_param_type:`nested` :xref_param_type:`tuples ` :xref_param_type:`and` :xref_param_type:`lists` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - new instance of class | | - :xref_param_type:`new` :xref_param_type:`instance` :xref_param_type:`of` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - non-negative real | | - non-negative :xref_param_type:`real` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - non-negative scalar or numpy array (same size as parameters) | | - non-negative :xref_param_type:`scalar` or :xref_param_type:`numpy` :xref_param_type:`array ` (:xref_param_type:`same` :xref_param_type:`size` :xref_param_type:`as` :xref_param_type:`parameters`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - not used | | - :xref_param_type:`not` :xref_param_type:`used` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - not used yet | | - :xref_param_type:`not` :xref_param_type:`used` :xref_param_type:`yet` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - not used, | | - :xref_param_type:`not` used, | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - nothing returned, modifications are inplace | | - :xref_param_type:`nothing` :xref_param_type:`returned`, :xref_param_type:`modifications` :xref_param_type:`are` :xref_param_type:`inplace` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.dtype, optional | | - :xref_param_type:`np.dtype`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.ndarray | | - :xref_param_type:`np.ndarray` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.ndarray of Booleans | | - :xref_param_type:`np.ndarray` :xref_param_type:`of` :xref_param_type:`Booleans` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - number | | - :xref_param_type:`number` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numeric | | - :xref_param_type:`numeric` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy array (2D) | | - :xref_param_type:`numpy` :xref_param_type:`array ` (2D) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy matrix | | - :xref_param_type:`numpy` :xref_param_type:`matrix ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy matrix (default identity matrix) | | - :xref_param_type:`numpy` :xref_param_type:`matrix ` (default :xref_param_type:`identity` :xref_param_type:`matrix `) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy.array | | - :xref_param_type:`numpy.array` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy.array (default) or pandas.DataFrame | | - :xref_param_type:`numpy.array` (default) :xref_param_type:`or` :xref_param_type:`pandas.DataFrame` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - nx1 array | | - :xref_param_type:`nx1` :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - nxk array | | - :xref_param_type:`nxk` :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - obj | | - :xref_param_type:`obj` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object | | - :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object or array-like | | - :xref_param_type:`object` or :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional keywords | | - optional :xref_param_type:`keywords` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional keywords for power function | | - optional :xref_param_type:`keywords` :xref_param_type:`for` :xref_param_type:`power` :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pandas.DataFrame | | - :xref_param_type:`pandas.DataFrame` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pandas.DataFrame, optional | | - :xref_param_type:`pandas.DataFrame`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pandas.Series or dict-like | | - :xref_param_type:`pandas.Series` or dict-like | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pandas.dataframe | | - :xref_param_type:`pandas.dataframe` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pd.Index | | - :xref_param_type:`pd.Index` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pd.Index or None | | - :xref_param_type:`pd.Index` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pd.Index, optional | | - :xref_param_type:`pd.Index`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - positive integer | | - :xref_param_type:`positive` :xref_param_type:`integer ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - positive real | | - :xref_param_type:`positive` :xref_param_type:`real` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - positive real scalar | | - :xref_param_type:`positive` :xref_param_type:`real` :xref_param_type:`scalar` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - property | | - :xref_param_type:`property` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pvalue | | - :xref_param_type:`pvalue` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - real | | - :xref_param_type:`real` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - real array-valued function | | - :xref_param_type:`real` array-valued :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - real valued function | | - :xref_param_type:`real` :xref_param_type:`valued` :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - real-valued function | | - real-valued :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - regression result instance | | - :xref_param_type:`regression` :xref_param_type:`result` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - regression results instance | | - :xref_param_type:`regression` :xref_param_type:`results` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - result instance | | - :xref_param_type:`result` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - results instance | | - :xref_param_type:`results` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar | | - :xref_param_type:`scalar` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or 1-D ndarray of shape (K,) | | - :xref_param_type:`scalar` or 1-D :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`shape` (K,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or 1-D ndarray, shape (K,) | | - :xref_param_type:`scalar` or 1-D :xref_param_type:`ndarray `, :xref_param_type:`shape` (K,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array-like | | - :xref_param_type:`scalar` or :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like | | - :xref_param_type:`scalar` or :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like (optional) | | - :xref_param_type:`scalar` or :term:`numpy:array_like` (optional) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional | | - :xref_param_type:`scalar`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scipy.stats distribution | | - :xref_param_type:`scipy.stats` :xref_param_type:`distribution` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scipy.stats.distribution | | - :xref_param_type:`scipy.stats.distribution` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - see Parameters | | - :xref_param_type:`see` :xref_param_type:`Parameters` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - see `endog` in Parameters | | - :xref_param_type:`see` `endog` :xref_param_type:`in` :xref_param_type:`Parameters` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - see delta_x in Parameters | | - :xref_param_type:`see` :xref_param_type:`delta_x` :xref_param_type:`in` :xref_param_type:`Parameters` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - see delta_y_1_T in Parameters | | - :xref_param_type:`see` :xref_param_type:`delta_y_1_T` :xref_param_type:`in` :xref_param_type:`Parameters` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - see y_lag1 in Parameters | | - :xref_param_type:`see` :xref_param_type:`y_lag1` :xref_param_type:`in` :xref_param_type:`Parameters` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence | | - :term:`python:sequence` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence (length k) | | - :term:`python:sequence` (:xref_param_type:`length` :xref_param_type:`k`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of data or cells | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`data` or :xref_param_type:`cells` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of ndarrays | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`ndarrays` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of ndarrays or 2-D ndarray | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`ndarrays` or 2-D :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of scalar or str, optional | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalar` or :xref_param_type:`str`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence or None | | - :term:`python:sequence` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sparse.coo_matrix | | - :xref_param_type:`sparse.coo_matrix` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - square array | | - :xref_param_type:`square` :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - square matrix | | - :xref_param_type:`square` :xref_param_type:`matrix ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - square ndarray | | - :xref_param_type:`square` :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - square symmetric ndarray | | - :xref_param_type:`square` :xref_param_type:`symmetric` :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - statespace.kalman_filter.KalmanFilter | | - :xref_param_type:`statespace.kalman_filter.KalmanFilter` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - statsmodels Principal Component Analysis instance | | - :xref_param_type:`statsmodels` :xref_param_type:`Principal` :xref_param_type:`Component` :xref_param_type:`Analysis` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - statsmodels model | | - :xref_param_type:`statsmodels` :xref_param_type:`model` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - statsmodels model class instance | | - :xref_param_type:`statsmodels` :xref_param_type:`model` :term:`python:class` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - statsmodels results instance or list of result instances | | - :xref_param_type:`statsmodels` :xref_param_type:`results` :xref_param_type:`instance` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`result` :xref_param_type:`instances` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - statsmodels.robust.norms.RobustNorm, optional | | - :xref_param_type:`statsmodels.robust.norms.RobustNorm`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str | | - :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str ('data' or 'header') | | - :xref_param_type:`str` ('data' or 'header') | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or Matplotlib Colormap instance, optional | | - :xref_param_type:`str` or :xref_param_type:`Matplotlib` :xref_param_type:`Colormap` :xref_param_type:`instance`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or None | | - :xref_param_type:`str` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or None, optional | | - :xref_param_type:`str` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or array-like | | - :xref_param_type:`str` or :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or array_like | | - :xref_param_type:`str` or :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or filehandle | | - :xref_param_type:`str` or :xref_param_type:`filehandle` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or generic Formula object | | - :xref_param_type:`str` or :xref_param_type:`generic` :xref_param_type:`Formula` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or int {"I","II","III"} or {1,2,3} | | - :xref_param_type:`str` or :xref_param_type:`int` {"I","II","III"} :xref_param_type:`or` {1,2,3} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or offset | | - :xref_param_type:`str` or :xref_param_type:`offset` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or patsy.model_desc | | - :xref_param_type:`str` or :xref_param_type:`patsy.model_desc` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or sequence of strs | | - :xref_param_type:`str` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`strs` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"F", "Chisq", "Cp"} or None | | - :xref_param_type:`str` {"F", "Chisq", "Cp"} :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"additive", "multiplicative"} | | - :xref_param_type:`str` {"additive", "multiplicative"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"aq","qm", "other"} | | - :xref_param_type:`str` {"aq","qm", "other"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"c", "ct", "ctt", "nc"} | | - :xref_param_type:`str` {"c", "ct", "ctt", "nc"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"c", "nc", "ct", "ctt"} | | - :xref_param_type:`str` {"c", "nc", "ct", "ctt"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"c","t","ct","ctt"} | | - :xref_param_type:`str` {"c","t","ct","ctt"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"ls", "ssm"} | | - :xref_param_type:`str` {"ls", "ssm"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"ml"}, default: "ml" | | - :xref_param_type:`str` {"ml"}, default: "ml" | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"nc", "c", "ct", "ctt"} | | - :xref_param_type:`str` {"nc", "c", "ct", "ctt"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {"nc", "co", "ci", "lo", "li"} | | - :xref_param_type:`str` {"nc", "co", "ci", "lo", "li"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'45', 's', 'r', q'} or None | | - :xref_param_type:`str` {'45', 's', 'r', q'} :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'45', 's', 'r', q'} or None, optional | | - :xref_param_type:`str` {'45', 's', 'r', q'} :xref_param_type:`or` :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'45','r','s','q'} | | - :xref_param_type:`str` {'45','r','s','q'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'DFFITS', 'Cooks'} | | - :xref_param_type:`str` {'DFFITS', 'Cooks'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'aic','bic','hic','t-stat'} | | - :xref_param_type:`str` {'aic','bic','hic','t-stat'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'aic','bic','hqic','t-stat'} | | - :xref_param_type:`str` {'aic','bic','hqic','t-stat'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'c', 'ct'} | | - :xref_param_type:`str` {'c', 'ct'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'c', 'tc', 'ctt', 'nc'} | | - :xref_param_type:`str` {'c', 'tc', 'ctt', 'nc'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'c','nc'} | | - :xref_param_type:`str` {'c','nc'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'cmle', 'mle'}, optional | | - :xref_param_type:`str` {'cmle', 'mle'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'css-mle','mle','css'} | | - :xref_param_type:`str` {'css-mle','mle','css'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'ex','sep','in'} | | - :xref_param_type:`str` {'ex','sep','in'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'forward', 'backward', 'both', 'none'} or None | | - :xref_param_type:`str` {'forward', 'backward', 'both', 'none'} :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'line', 'scatter', 'both'}, optional | | - :xref_param_type:`str` {'line', 'scatter', 'both'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'nc', 'c', 'ct'} | | - :xref_param_type:`str` {'nc', 'c', 'ct'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'newton','nm','bfgs','powell','cg','ncg','basinhopping', | | - :xref_param_type:`str` {'newton','nm','bfgs','powell','cg','ncg','basinhopping', | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'raise', 'add', 'skip'} | | - :xref_param_type:`str` {'raise', 'add', 'skip'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {``"f"``, ``"wald"``} | | - :xref_param_type:`str` {``"f"``, ``"wald"``} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {``"granger"``, ``"inst"``}, default: ``"granger"`` | | - :xref_param_type:`str` {``"granger"``, ``"inst"``}, default: ``"granger"`` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {``"nc"``, ``"co"``, ``"ci"``, ``"lo"``, ``"li"``} | | - :xref_param_type:`str` {``"nc"``, ``"co"``, ``"ci"``, ``"lo"``, ``"li"``} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, datetime | | - :xref_param_type:`str`, :xref_param_type:`datetime` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, defaults to 'brentq' | | - :xref_param_type:`str`, :xref_param_type:`defaults` :xref_param_type:`to` 'brentq' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, float | | - :xref_param_type:`str`, :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, list | | - :xref_param_type:`str`, :xref_param_type:`list` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, optional | | - :xref_param_type:`str`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, tuple, datetime.timedelta, DateOffset or None, optional | | - :xref_param_type:`str`, :xref_param_type:`tuple`, :xref_param_type:`datetime.timedelta`, :xref_param_type:`DateOffset` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, {``"trace"``, ``"maxeig"``}, default: ``"trace"`` | | - :xref_param_type:`str`, {``"trace"``, ``"maxeig"``}, default: ``"trace"`` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string | | - :xref_param_type:`string ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string 'cov' | | - :xref_param_type:`string ` 'cov' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string in ['nobs', 'effect_size', 'alpha'] | | - :xref_param_type:`string ` :xref_param_type:`in` ['nobs', 'effect_size', 'alpha'] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string in ['norm', 'binom'] | | - :xref_param_type:`string ` :xref_param_type:`in` ['norm', 'binom'] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string in ['normal'] | | - :xref_param_type:`string ` :xref_param_type:`in` ['normal'] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string in ['two-sided', 'smaller', 'larger'] | | - :xref_param_type:`string ` :xref_param_type:`in` ['two-sided', 'smaller', 'larger'] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string of Penalty object | | - :xref_param_type:`string ` :xref_param_type:`of` :xref_param_type:`Penalty` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or (int, int) tuple | | - :xref_param_type:`string ` :xref_param_type:`or` (:xref_param_type:`int`, :xref_param_type:`int`) :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or HuberScale() | | - :xref_param_type:`string ` or :xref_param_type:`HuberScale`\() | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or None | | - :xref_param_type:`string ` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or array or callable | | - :xref_param_type:`string ` or :xref_param_type:`array ` or :xref_param_type:`callable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or array_like, optional | | - :xref_param_type:`string ` or :term:`numpy:array_like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or callable | | - :xref_param_type:`string ` or :xref_param_type:`callable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or filehandle | | - :xref_param_type:`string ` or :xref_param_type:`filehandle` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or float in (0, 1) | | - :xref_param_type:`string ` or :xref_param_type:`float` :xref_param_type:`in` (0, 1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or float, optional | | - :xref_param_type:`string ` or :xref_param_type:`float`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or int | | - :xref_param_type:`string ` or :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or tuple | | - :xref_param_type:`string ` or :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string {'breakvar'} or None | | - :xref_param_type:`string ` {'breakvar'} :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string {'jarquebera'} or None | | - :xref_param_type:`string ` {'jarquebera'} :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string {'ljungbox','boxpierece'} or None | | - :xref_param_type:`string ` {'ljungbox','boxpierece'} :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, 'ar' | | - :xref_param_type:`string `, 'ar' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, 'increasing', 'decreasing' or 'two-sided' | | - :xref_param_type:`string `, 'increasing', 'decreasing' or 'two-sided' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, 'pooled' | | - :xref_param_type:`string `, 'pooled' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, 'pooled' or 'unequal' | | - :xref_param_type:`string `, 'pooled' or 'unequal' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, 'two-sided' (default) or 'one-sided' | | - :xref_param_type:`string `, 'two-sided' (default) :xref_param_type:`or` 'one-sided' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, 'two-sided' (default), 'larger', 'smaller' | | - :xref_param_type:`string `, 'two-sided' (default), 'larger', 'smaller' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default is 'bfgs' | | - :xref_param_type:`string `, default :xref_param_type:`is` 'bfgs' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, defines method for robust | | - :xref_param_type:`string `, :xref_param_type:`defines` :xref_param_type:`method` :xref_param_type:`for` :xref_param_type:`robust` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, kernel to use in the kernel density estimation for the | | - :xref_param_type:`string `, :xref_param_type:`kernel` :xref_param_type:`to` :xref_param_type:`use` :xref_param_type:`in` :xref_param_type:`the` :xref_param_type:`kernel` :xref_param_type:`density` :xref_param_type:`estimation` :xref_param_type:`for` :xref_param_type:`the` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, method used to calculate the variance-covariance matrix | | - :xref_param_type:`string `, :xref_param_type:`method` :xref_param_type:`used` :xref_param_type:`to` :xref_param_type:`calculate` :xref_param_type:`the` variance-covariance :xref_param_type:`matrix ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional | | - :xref_param_type:`string `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string. | | - string. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - structured array | | - :xref_param_type:`structured` :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str{'c', 'ct'} | | - :xref_param_type:`str`\{'c', 'ct'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str{'n','c','t','ct'} or iterable | | - :xref_param_type:`str`\{'n','c','t','ct'} :xref_param_type:`or` :term:`python:iterable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str{'n','c','t','ct'} or iterable, optional | | - :xref_param_type:`str`\{'n','c','t','ct'} :xref_param_type:`or` :term:`python:iterable`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - table is attached | | - :xref_param_type:`table` :xref_param_type:`is` :xref_param_type:`attached` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tables are attached | | - :xref_param_type:`tables` :xref_param_type:`are` :xref_param_type:`attached` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tree | | - :xref_param_type:`tree` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple | | - :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of None or ndarrays | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`None` or :xref_param_type:`ndarrays` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of dicts, optional | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`dicts`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of float | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of int | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of lists, optional | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`lists`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of two ndarrays | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`two` :xref_param_type:`ndarrays` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple or array_like ([min, k_vars], [max, k_vars]) | | - :xref_param_type:`tuple` or :term:`numpy:array_like` ([:xref_param_type:`min`, :xref_param_type:`k_vars`], [:xref_param_type:`max`, :xref_param_type:`k_vars`]) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple or array_like ? | | - :xref_param_type:`tuple` or :term:`numpy:array_like` ? | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple or dict | | - :xref_param_type:`tuple` or :xref_param_type:`dict` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, (ar, ma) | | - :xref_param_type:`tuple`, (:xref_param_type:`ar`, :xref_param_type:`ma`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, (mu, ar, ma) | | - :xref_param_type:`tuple`, (:xref_param_type:`mu`, :xref_param_type:`ar`, :xref_param_type:`ma`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, 2 elements | | - :xref_param_type:`tuple`, 2 :xref_param_type:`elements` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, optional | | - :xref_param_type:`tuple`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, sequence | | - :xref_param_type:`tuple`, :term:`python:sequence` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type, optional | | - :xref_param_type:`type`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - unknown values of A and B matrix concatenated | | - :xref_param_type:`unknown` :xref_param_type:`values` :xref_param_type:`of` :xref_param_type:`A` :xref_param_type:`and` :xref_param_type:`B` :xref_param_type:`matrix ` :xref_param_type:`concatenated` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - var, optional | | - :xref_param_type:`var`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - vector length neqs, default to largest for each | | - :xref_param_type:`vector` :xref_param_type:`length` :xref_param_type:`neqs`, default :xref_param_type:`to` :xref_param_type:`largest` :xref_param_type:`for` :xref_param_type:`each` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - vector-valued function | | - vector-valued :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {"add", "mul", "additive", "multiplicative", None}, optional | | - {"add", "mul", "additive", "multiplicative", :xref_param_type:`None`}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'AIC', 'BIC', 't-stat', None} | | - {'AIC', 'BIC', 't-stat', :xref_param_type:`None`} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'MBD', 'BD2'}, optional | | - {'MBD', 'BD2'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'aic', 'bic', 'hqic'} | | - {'aic', 'bic', 'hqic'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'aic', 'bic', 't-stat'} | | - {'aic', 'bic', 't-stat'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'aic', 'fpe', 'hqic', 'bic', None} | | - {'aic', 'fpe', 'hqic', 'bic', :xref_param_type:`None`} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'approx', 'table'}, optional | | - {'approx', 'table'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'approximate_diffuse','stationary','known'}, optional | | - {'approximate_diffuse','stationary','known'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'bky', 'bh') | | - {'bky', 'bh') | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'bootstrap', 'montecarlo'} | | - {'bootstrap', 'montecarlo'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'both', 'left', 'right'}, optional | | - {'both', 'left', 'right'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'c', 'nc', 'ct', 'ctt'} | | - {'c', 'nc', 'ct', 'ctt'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'c','ct','ctt','nc'} | | - {'c','ct','ctt','nc'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'cov', ...} | | - {'cov', ...} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'diagonal', 'unstructured'} | | - {'diagonal', 'unstructured'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'diagonal', 'unstructured'}, optional | | - {'diagonal', 'unstructured'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'eim', 'oim'}, optional | | - {'eim', 'oim'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'expanding', 'rolling'} | | - {'expanding', 'rolling'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'f', 'wald'} | | - {'f', 'wald'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'filtered', 'smoothed'}, or None, optional | | - {'filtered', 'smoothed'}, :xref_param_type:`or` :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'full', 'drop-last', 'drop-first'} | | - {'full', 'drop-last', 'drop-first'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'goodman', 'sison-glaz'}, optional | | - {'goodman', 'sison-glaz'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'guerrero', 'loglik'} | | - {'guerrero', 'loglik'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'harvey', 'approx'} or None, optional | | - {'harvey', 'approx'} :xref_param_type:`or` :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'indep', 'negcorr') | | - {'indep', 'negcorr') | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right'}, optional | | - {'left', 'right'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'mean', 'median'} or number | | - {'mean', 'median'} :xref_param_type:`or` :xref_param_type:`number` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'mle'} | | - {'mle'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'naive'} | | - {'naive'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'nc', 'c', 't', 'ct'} | | - {'nc', 'c', 't', 'ct'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'nc', 'c'}, optional | | - {'nc', 'c'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'nm', 'newton', 'bfgs', 'cg', 'ncg', 'powell'} | | - {'nm', 'newton', 'bfgs', 'cg', 'ncg', 'powell'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'norm', 'exp'}, optional | | - {'norm', 'exp'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'ols'} | | - {'ols'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'opg','oim','approx'}, optional | | - {'opg','oim','approx'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'s', 'd', 'c', 'z'}, optional | | - {'s', 'd', 'c', 'z'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'s','d','c','z'}, optional | | - {'s','d','c','z'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'scalar', 'diagonal', 'unstructured'}, optional | | - {'scalar', 'diagonal', 'unstructured'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'sd', 'mad'} | | - {'sd', 'mad'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'standard', 'lutkepohl'} | | - {'standard', 'lutkepohl'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'ywunbiased', 'ywmle', 'ols'} | | - {'ywunbiased', 'ywmle', 'ols'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0,1}, optional | | - {0,1}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0.05, 0.01} | | - {0.05, 0.01} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0.4, float} optional | | - {0.4, :xref_param_type:`float`} optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0.95, 0.99} | | - {0.95, 0.99} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {False, True} | | - {:xref_param_type:`False`, :xref_param_type:`True`} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, "hc0", "hc1", "hc2", "hc3"} | | - {:xref_param_type:`None`, "hc0", "hc1", "hc2", "hc3"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, int}, optional | | - {:xref_param_type:`None`, :xref_param_type:`int`}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {True, False, 'log', float}, optional | | - {:xref_param_type:`True`, :xref_param_type:`False`, 'log', :xref_param_type:`float`}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {{prefix}}SimulationSmoother object | | - {{prefix}}SimulationSmoother object | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+