``bayesline.api.equity``
========================

.. currentmodule:: bayesline.api.equity

Equity API

Equity API
----------
.. autosummary::
   :toctree: _autosummary

   BayeslineEquityApi
   settings_tools
   AsyncBayeslineEquityApi
   hierarchy_to_df
   hierarchy_from_df
   hierarchy_df_to_wide
   DatasetError

Equity Exposure
---------------
.. autosummary::
   :toctree: _autosummary

   AsyncExposureApi
   AsyncExposureLoaderApi
   ExposureApi
   ExposureLoaderApi
   CategoricalExposureGroupSettings
   ContinuousExposureGroupSettings
   ExposureGroupSettings
   ExposureSettings
   ExposureSettingsMenu
   HierarchyGroups
   HierarchyLevel
   InteractionExposureGroupSettings
   RollingBetaSettings
   RollingHuberBetaSettings
   RollingRegressionSettings
   TSBetaExposureGroupSettings

Equity Universe
---------------
.. autosummary::
   :toctree: _autosummary

   AsyncUniverseApi
   AsyncUniverseLoaderApi
   UniverseApi
   UniverseLoaderApi
   CategoricalFilterSettings
   Hierarchy
   MCapFilterSettings
   UniverseSettings
   UniverseSettingsMenu

Equity Model Construction
-------------------------
.. autosummary::
   :toctree: _autosummary

   AsyncFactorModelConstructionApi
   AsyncFactorModelConstructionLoaderApi
   FactorModelConstructionApi
   FactorModelConstructionLoaderApi
   ModelConstructionSettings
   ModelConstructionSettingsMenu

Equity Portfolio
----------------
.. autosummary::
   :toctree: _autosummary

   AsyncPortfolioApi
   AsyncPortfolioLoaderApi
   PortfolioApi
   PortfolioCatalog
   PortfolioFofCollision
   PortfolioLoaderApi
   PortfolioName
   PortfolioSelectionResolution
   PortfolioOrganizerSettings
   PortfolioOrganizerSettingsMenu
   PortfolioSettings
   PortfolioSettingsMenu

Equity Risk Models
------------------
.. autosummary::
   :toctree: _autosummary

   AsyncFactorModelApi
   AsyncFactorModelEngineApi
   AsyncFactorModelLoaderApi
   AsyncFactorModelMetadataApi
   FactorModelApi
   FactorModelEngineApi
   FactorModelLoaderApi
   FactorModelMetadataApi
   RiskModelCatalog
   FactorRiskModelMetadata
   FactorRiskModelSettings
   FactorRiskModelSettingsMenu
   GetModelMode
   AsyncFactorModelEngineImpl
   AsyncFactorModelImpl
   AsyncFactorModelLoaderImpl
   FactorModelEngineImpl
   FactorModelImpl
   FactorModelLoaderImpl

Equity Reports
--------------
.. autosummary::
   :toctree: _autosummary

   AsyncTypedReportAccessorApi
   TypedReportAccessorApi
   ACCESSOR_IMPLS
   ASYNC_ACCESSOR_IMPLS
   AsyncReportApi
   ReportApi
   AnyReportSettings
   AsyncReportLoaderApi
   ReportLoaderApi
   AsyncFactorCovarianceReportAccessor
   AsyncFactorCovarianceReportAccessorImpl
   AsyncFactorCovarianceReportApi
   FactorCovarianceReportAccessorImpl
   FactorCovarianceReportApi
   FactorCovarianceReportSettings
   AsyncExposureReportAccessor
   AsyncExposureReportAccessorImpl
   AsyncExposureReportApi
   ExposureReportAccessorImpl
   ExposureReportApi
   ExposureReportSettings
   AsyncFactorStatsReportAccessor
   AsyncFactorStatsReportAccessorImpl
   AsyncFactorStatsReportApi
   FactorStatsReportAccessorImpl
   FactorStatsReportApi
   FactorStatsReportSettings
   AsyncIdioReportAccessor
   AsyncIdioReportAccessorImpl
   AsyncIdioReportApi
   IdioReportAccessorImpl
   IdioReportApi
   IdioReportSettings
   AsyncMcapExposureReportAccessor
   AsyncMcapExposureReportAccessorImpl
   AsyncMcapExposureReportApi
   McapExposureReportAccessorImpl
   McapExposureReportApi
   McapExposureReportSettings
   AsyncPortfolioHoldingsReportAccessor
   AsyncPortfolioHoldingsReportAccessorImpl
   AsyncPortfolioHoldingsReportApi
   PortfolioHoldingsReportAccessorImpl
   PortfolioHoldingsReportApi
   PortfolioHoldingsReportSettings
   AsyncPortfolioReturnsReportAccessor
   AsyncPortfolioReturnsReportAccessorImpl
   AsyncPortfolioReturnsReportApi
   PortfolioReturnsReportAccessorImpl
   PortfolioReturnsReportApi
   PortfolioReturnsReportSettings
   AsyncPortfolioReturnsTieoutReportAccessor
   AsyncPortfolioReturnsTieoutReportAccessorImpl
   AsyncPortfolioReturnsTieoutReportApi
   PortfolioReturnsTieoutReportAccessorImpl
   PortfolioReturnsTieoutReportApi
   PortfolioReturnsTieoutReportSettings
   TieoutReferenceRef
   AsyncReturnAttributionReportAccessor
   AsyncReturnAttributionReportAccessorImpl
   AsyncReturnAttributionReportApi
   ReturnAttributionReportAccessorImpl
   ReturnAttributionReportApi
   ReturnAttributionReportSettings
   AnyScenarioSettings
   Basket
   BasketFactorScenario
   HoldingsOverrideWindow
   OverrideUnit
   PortfolioHoldingsScenario
   PortfolioOverride
   RebalanceFrequency
   ScenarioSettings
   TSFactorSelection
   TSFactorSpec
   FactorCovarianceSettings
   IdioVolSettings
   ReportSettings
   ReportSettingsMenu
   AsyncUniverseCountReportAccessor
   AsyncUniverseCountReportAccessorImpl
   AsyncUniverseCountReportApi
   UniverseCountReportAccessorImpl
   UniverseCountReportApi
   UniverseCountReportSettings
   AsyncWeightsReportAccessor
   AsyncWeightsReportAccessorImpl
   AsyncWeightsReportApi
   WeightsReportAccessorImpl
   WeightsReportApi
   WeightsReportSettings
   AsyncXSRReportAccessor
   AsyncXSRReportAccessorImpl
   AsyncXSRReportApi
   XSRReportAccessorImpl
   XSRReportApi
   XSRReportSettings
   AsyncReportAccessorApi
   IllegalPathError
   ReportAccessorApi
   ReportAccessorSettings

Equity Portfolio Hierarchy
--------------------------
.. autosummary::
   :toctree: _autosummary

   AsyncPortfolioHierarchyApi
   AsyncPortfolioHierarchyLoaderApi
   PortfolioHierarchyApi
   PortfolioHierarchyLoaderApi
   SYSTEM_GROUPING_PREFIX
   PortfolioHierarchySettings
   PortfolioHierarchySettingsMenu
   system_level_name

Equity ID
---------
.. autosummary::
   :toctree: _autosummary

   AssetIdApi
   AsyncAssetIdApi

Equity Calendar
---------------
.. autosummary::
   :toctree: _autosummary

   AsyncCalendarApi
   AsyncCalendarLoaderApi
   CalendarApi
   CalendarLoaderApi
   CalendarSettings
   CalendarSettingsMenu

Equity Uploaders
----------------
.. autosummary::
   :toctree: _autosummary

   AsyncDataTypeUploaderApi
   AsyncUploaderApi
   AsyncUploadersApi
   AsyncUploadParserApi
   DataTypeUploaderApi
   MultiParserResult
   UploadCommitResult
   UploadDataTypeFreshness
   UploaderApi
   UploadError
   UploadersApi
   UploadParserApi
   UploadParserResult
   UploadPermissionError
   UploadStagingResult
   UploadSettings
   UploadSettingsMenu

Equity Risk Dataset
-------------------
.. autosummary::
   :toctree: _autosummary

   AsyncRiskDatasetApi
   AsyncRiskDatasetLoaderApi
   RiskDatasetApi
   RiskDatasetLoaderApi
   AnyRiskDatasetSettings
   DerivedRiskDatasetSettings
   RiskDatasetExposureSettings
   RiskDatasetHuberRegressionExposureSettings
   RiskDatasetMetadata
   RiskDatasetProperties
   RiskDatasetReferencedExposureSettings
   RiskDatasetSettings
   RiskDatasetSettingsMenu
   RiskDatasetUnitExposureSettings
   RiskDatasetUpdateResult
   RiskDatasetUploadedExposureSettings
   RootRiskDatasetSettings
   DatasetStatus