Skip to main content
Ctrl+K
Bayesline Public Documentation - Home Bayesline Public Documentation - Home

Getting Started

  • Installation
  • Quickstart
  • AI Assistant Skill
  • Tutorials
    • Factor Covariance Matrix Forecasts
    • Factor Returns Computation Validation
    • Exposure Upload Commit Modes
    • Portfolios
    • Portfolio Hierarchies
    • Risk Datasets
    • Data Uploaders
    • Custom Dataset From Scratch
  • Recipes
    • Uploading New Exposures to Existing Dataset and Updating the Risk Dataset
    • Idiosyncratic volatility and correlation forecasting
    • Factor Attribution
    • Model Onboarding
    • Interaction Factors
    • Portfolio Aligned Universes
  • Frequently Asked Questions (FAQ)

More Resources

  • bayesline Public API
    • bayesline.api
      • bayesline.api.equity
        • bayesline.api.equity.BayeslineEquityApi
        • bayesline.api.equity.settings_tools
        • bayesline.api.equity.AsyncBayeslineEquityApi
        • bayesline.api.equity.hierarchy_to_df
        • bayesline.api.equity.hierarchy_from_df
        • bayesline.api.equity.hierarchy_df_to_wide
        • bayesline.api.equity.DatasetError
        • bayesline.api.equity.AsyncExposureApi
        • bayesline.api.equity.AsyncExposureLoaderApi
        • bayesline.api.equity.ExposureApi
        • bayesline.api.equity.ExposureLoaderApi
        • bayesline.api.equity.CategoricalExposureGroupSettings
        • bayesline.api.equity.ContinuousExposureGroupSettings
        • bayesline.api.equity.ExposureGroupSettings
        • bayesline.api.equity.ExposureSettings
        • bayesline.api.equity.ExposureSettingsMenu
        • bayesline.api.equity.HierarchyGroups
        • bayesline.api.equity.HierarchyLevel
        • bayesline.api.equity.InteractionExposureGroupSettings
        • bayesline.api.equity.RollingBetaSettings
        • bayesline.api.equity.RollingHuberBetaSettings
        • bayesline.api.equity.RollingRegressionSettings
        • bayesline.api.equity.TSBetaExposureGroupSettings
        • bayesline.api.equity.AsyncUniverseApi
        • bayesline.api.equity.AsyncUniverseLoaderApi
        • bayesline.api.equity.UniverseApi
        • bayesline.api.equity.UniverseLoaderApi
        • bayesline.api.equity.CategoricalFilterSettings
        • bayesline.api.equity.Hierarchy
        • bayesline.api.equity.MCapFilterSettings
        • bayesline.api.equity.UniverseSettings
        • bayesline.api.equity.UniverseSettingsMenu
        • bayesline.api.equity.AsyncFactorModelConstructionApi
        • bayesline.api.equity.AsyncFactorModelConstructionLoaderApi
        • bayesline.api.equity.FactorModelConstructionApi
        • bayesline.api.equity.FactorModelConstructionLoaderApi
        • bayesline.api.equity.ModelConstructionSettings
        • bayesline.api.equity.ModelConstructionSettingsMenu
        • bayesline.api.equity.AsyncPortfolioApi
        • bayesline.api.equity.AsyncPortfolioLoaderApi
        • bayesline.api.equity.PortfolioApi
        • bayesline.api.equity.PortfolioCatalog
        • bayesline.api.equity.PortfolioFofCollision
        • bayesline.api.equity.PortfolioLoaderApi
        • bayesline.api.equity.PortfolioName
        • bayesline.api.equity.PortfolioSelectionResolution
        • bayesline.api.equity.PortfolioOrganizerSettings
        • bayesline.api.equity.PortfolioOrganizerSettingsMenu
        • bayesline.api.equity.PortfolioSettings
        • bayesline.api.equity.PortfolioSettingsMenu
        • bayesline.api.equity.AsyncFactorModelApi
        • bayesline.api.equity.AsyncFactorModelEngineApi
        • bayesline.api.equity.AsyncFactorModelLoaderApi
        • bayesline.api.equity.AsyncFactorModelMetadataApi
        • bayesline.api.equity.FactorModelApi
        • bayesline.api.equity.FactorModelEngineApi
        • bayesline.api.equity.FactorModelLoaderApi
        • bayesline.api.equity.FactorModelMetadataApi
        • bayesline.api.equity.RiskModelCatalog
        • bayesline.api.equity.FactorRiskModelMetadata
        • bayesline.api.equity.FactorRiskModelSettings
        • bayesline.api.equity.FactorRiskModelSettingsMenu
        • bayesline.api.equity.GetModelMode
        • bayesline.api.equity.AsyncFactorModelEngineImpl
        • bayesline.api.equity.AsyncFactorModelImpl
        • bayesline.api.equity.AsyncFactorModelLoaderImpl
        • bayesline.api.equity.FactorModelEngineImpl
        • bayesline.api.equity.FactorModelImpl
        • bayesline.api.equity.FactorModelLoaderImpl
        • bayesline.api.equity.AsyncTypedReportAccessorApi
        • bayesline.api.equity.TypedReportAccessorApi
        • bayesline.api.equity.ACCESSOR_IMPLS
        • bayesline.api.equity.ASYNC_ACCESSOR_IMPLS
        • bayesline.api.equity.AsyncReportApi
        • bayesline.api.equity.ReportApi
        • bayesline.api.equity.AnyReportSettings
        • bayesline.api.equity.AsyncReportLoaderApi
        • bayesline.api.equity.ReportLoaderApi
        • bayesline.api.equity.AsyncFactorCovarianceReportAccessor
        • bayesline.api.equity.AsyncFactorCovarianceReportAccessorImpl
        • bayesline.api.equity.AsyncFactorCovarianceReportApi
        • bayesline.api.equity.FactorCovarianceReportAccessorImpl
        • bayesline.api.equity.FactorCovarianceReportApi
        • bayesline.api.equity.FactorCovarianceReportSettings
        • bayesline.api.equity.AsyncExposureReportAccessor
        • bayesline.api.equity.AsyncExposureReportAccessorImpl
        • bayesline.api.equity.AsyncExposureReportApi
        • bayesline.api.equity.ExposureReportAccessorImpl
        • bayesline.api.equity.ExposureReportApi
        • bayesline.api.equity.ExposureReportSettings
        • bayesline.api.equity.AsyncFactorStatsReportAccessor
        • bayesline.api.equity.AsyncFactorStatsReportAccessorImpl
        • bayesline.api.equity.AsyncFactorStatsReportApi
        • bayesline.api.equity.FactorStatsReportAccessorImpl
        • bayesline.api.equity.FactorStatsReportApi
        • bayesline.api.equity.FactorStatsReportSettings
        • bayesline.api.equity.AsyncIdioReportAccessor
        • bayesline.api.equity.AsyncIdioReportAccessorImpl
        • bayesline.api.equity.AsyncIdioReportApi
        • bayesline.api.equity.IdioReportAccessorImpl
        • bayesline.api.equity.IdioReportApi
        • bayesline.api.equity.IdioReportSettings
        • bayesline.api.equity.AsyncMcapExposureReportAccessor
        • bayesline.api.equity.AsyncMcapExposureReportAccessorImpl
        • bayesline.api.equity.AsyncMcapExposureReportApi
        • bayesline.api.equity.McapExposureReportAccessorImpl
        • bayesline.api.equity.McapExposureReportApi
        • bayesline.api.equity.McapExposureReportSettings
        • bayesline.api.equity.AsyncPortfolioHoldingsReportAccessor
        • bayesline.api.equity.AsyncPortfolioHoldingsReportAccessorImpl
        • bayesline.api.equity.AsyncPortfolioHoldingsReportApi
        • bayesline.api.equity.PortfolioHoldingsReportAccessorImpl
        • bayesline.api.equity.PortfolioHoldingsReportApi
        • bayesline.api.equity.PortfolioHoldingsReportSettings
        • bayesline.api.equity.AsyncPortfolioReturnsReportAccessor
        • bayesline.api.equity.AsyncPortfolioReturnsReportAccessorImpl
        • bayesline.api.equity.AsyncPortfolioReturnsReportApi
        • bayesline.api.equity.PortfolioReturnsReportAccessorImpl
        • bayesline.api.equity.PortfolioReturnsReportApi
        • bayesline.api.equity.PortfolioReturnsReportSettings
        • bayesline.api.equity.AsyncPortfolioReturnsTieoutReportAccessor
        • bayesline.api.equity.AsyncPortfolioReturnsTieoutReportAccessorImpl
        • bayesline.api.equity.AsyncPortfolioReturnsTieoutReportApi
        • bayesline.api.equity.PortfolioReturnsTieoutReportAccessorImpl
        • bayesline.api.equity.PortfolioReturnsTieoutReportApi
        • bayesline.api.equity.PortfolioReturnsTieoutReportSettings
        • bayesline.api.equity.TieoutReferenceRef
        • bayesline.api.equity.AsyncReturnAttributionReportAccessor
        • bayesline.api.equity.AsyncReturnAttributionReportAccessorImpl
        • bayesline.api.equity.AsyncReturnAttributionReportApi
        • bayesline.api.equity.ReturnAttributionReportAccessorImpl
        • bayesline.api.equity.ReturnAttributionReportApi
        • bayesline.api.equity.ReturnAttributionReportSettings
        • bayesline.api.equity.AnyScenarioSettings
        • bayesline.api.equity.Basket
        • bayesline.api.equity.BasketFactorScenario
        • bayesline.api.equity.HoldingsOverrideWindow
        • bayesline.api.equity.OverrideUnit
        • bayesline.api.equity.PortfolioHoldingsScenario
        • bayesline.api.equity.PortfolioOverride
        • bayesline.api.equity.RebalanceFrequency
        • bayesline.api.equity.ScenarioSettings
        • bayesline.api.equity.TSFactorSelection
        • bayesline.api.equity.TSFactorSpec
        • bayesline.api.equity.FactorCovarianceSettings
        • bayesline.api.equity.IdioVolSettings
        • bayesline.api.equity.ReportSettings
        • bayesline.api.equity.ReportSettingsMenu
        • bayesline.api.equity.AsyncUniverseCountReportAccessor
        • bayesline.api.equity.AsyncUniverseCountReportAccessorImpl
        • bayesline.api.equity.AsyncUniverseCountReportApi
        • bayesline.api.equity.UniverseCountReportAccessorImpl
        • bayesline.api.equity.UniverseCountReportApi
        • bayesline.api.equity.UniverseCountReportSettings
        • bayesline.api.equity.AsyncWeightsReportAccessor
        • bayesline.api.equity.AsyncWeightsReportAccessorImpl
        • bayesline.api.equity.AsyncWeightsReportApi
        • bayesline.api.equity.WeightsReportAccessorImpl
        • bayesline.api.equity.WeightsReportApi
        • bayesline.api.equity.WeightsReportSettings
        • bayesline.api.equity.AsyncXSRReportAccessor
        • bayesline.api.equity.AsyncXSRReportAccessorImpl
        • bayesline.api.equity.AsyncXSRReportApi
        • bayesline.api.equity.XSRReportAccessorImpl
        • bayesline.api.equity.XSRReportApi
        • bayesline.api.equity.XSRReportSettings
        • bayesline.api.equity.AsyncReportAccessorApi
        • bayesline.api.equity.IllegalPathError
        • bayesline.api.equity.ReportAccessorApi
        • bayesline.api.equity.ReportAccessorSettings
        • bayesline.api.equity.AsyncPortfolioHierarchyApi
        • bayesline.api.equity.AsyncPortfolioHierarchyLoaderApi
        • bayesline.api.equity.PortfolioHierarchyApi
        • bayesline.api.equity.PortfolioHierarchyLoaderApi
        • bayesline.api.equity.SYSTEM_GROUPING_PREFIX
        • bayesline.api.equity.PortfolioHierarchySettings
        • bayesline.api.equity.PortfolioHierarchySettingsMenu
        • bayesline.api.equity.system_level_name
        • bayesline.api.equity.AssetIdApi
        • bayesline.api.equity.AsyncAssetIdApi
        • bayesline.api.equity.AsyncCalendarApi
        • bayesline.api.equity.AsyncCalendarLoaderApi
        • bayesline.api.equity.CalendarApi
        • bayesline.api.equity.CalendarLoaderApi
        • bayesline.api.equity.CalendarSettings
        • bayesline.api.equity.CalendarSettingsMenu
        • bayesline.api.equity.AsyncDataTypeUploaderApi
        • bayesline.api.equity.AsyncUploaderApi
        • bayesline.api.equity.AsyncUploadersApi
        • bayesline.api.equity.AsyncUploadParserApi
        • bayesline.api.equity.DataTypeUploaderApi
        • bayesline.api.equity.MultiParserResult
        • bayesline.api.equity.UploadCommitResult
        • bayesline.api.equity.UploadDataTypeFreshness
        • bayesline.api.equity.UploaderApi
        • bayesline.api.equity.UploadError
        • bayesline.api.equity.UploadersApi
        • bayesline.api.equity.UploadParserApi
        • bayesline.api.equity.UploadParserResult
        • bayesline.api.equity.UploadPermissionError
        • bayesline.api.equity.UploadStagingResult
        • bayesline.api.equity.UploadSettings
        • bayesline.api.equity.UploadSettingsMenu
        • bayesline.api.equity.AsyncRiskDatasetApi
        • bayesline.api.equity.AsyncRiskDatasetLoaderApi
        • bayesline.api.equity.RiskDatasetApi
        • bayesline.api.equity.RiskDatasetLoaderApi
        • bayesline.api.equity.AnyRiskDatasetSettings
        • bayesline.api.equity.DerivedRiskDatasetSettings
        • bayesline.api.equity.RiskDatasetExposureSettings
        • bayesline.api.equity.RiskDatasetHuberRegressionExposureSettings
        • bayesline.api.equity.RiskDatasetMetadata
        • bayesline.api.equity.RiskDatasetProperties
        • bayesline.api.equity.RiskDatasetReferencedExposureSettings
        • bayesline.api.equity.RiskDatasetSettings
        • bayesline.api.equity.RiskDatasetSettingsMenu
        • bayesline.api.equity.RiskDatasetUnitExposureSettings
        • bayesline.api.equity.RiskDatasetUpdateResult
        • bayesline.api.equity.RiskDatasetUploadedExposureSettings
        • bayesline.api.equity.RootRiskDatasetSettings
        • bayesline.api.equity.DatasetStatus
      • bayesline.api.AsyncBayeslineApi
      • bayesline.api.BayeslineApi
      • bayesline.api.AsyncBayeslineApi
      • bayesline.api.ACLEntry
      • bayesline.api.ACLError
      • bayesline.api.ACLValidationError
      • bayesline.api.CreateACLEntry
      • bayesline.api.CreateGroupMembership
      • bayesline.api.CreateUserGroup
      • bayesline.api.CreateUserRole
      • bayesline.api.GroupCreationError
      • bayesline.api.GroupDeletionError
      • bayesline.api.GroupMembership
      • bayesline.api.GroupMembershipError
      • bayesline.api.GroupUpdateError
      • bayesline.api.PermissionDeniedError
      • bayesline.api.PermissionGrantError
      • bayesline.api.PermissionLevel
      • bayesline.api.PrincipalNotFoundError
      • bayesline.api.PrincipalType
      • bayesline.api.ResourceNotFoundError
      • bayesline.api.ResourcePermissionSummary
      • bayesline.api.ResourceType
      • bayesline.api.RoleAssignmentError
      • bayesline.api.RoleType
      • bayesline.api.UpdateACLEntry
      • bayesline.api.UpdateUserGroup
      • bayesline.api.UserGroup
      • bayesline.api.UserPermissionsSummary
      • bayesline.api.UserRef
      • bayesline.api.UserRole
      • bayesline.api.expand_roles
      • bayesline.api.role_satisfies
      • bayesline.api.AsyncPermissionsApi
      • bayesline.api.PermissionsApi
      • bayesline.api.AsyncRegistryBasedApiBase
      • bayesline.api.AsyncSettingsRegistry
      • bayesline.api.AsyncTypedSettingsRegistry
      • bayesline.api.RegistryBasedApiBase
      • bayesline.api.SettingsIdentifiers
      • bayesline.api.SettingsRegistry
      • bayesline.api.TypedSettingsRegistry
      • bayesline.api.CouldNotDeleteSettingsError
      • bayesline.api.CouldNotPermissionSettingsError
      • bayesline.api.CouldNotSaveSettingsError
      • bayesline.api.DatasetAwareSettings
      • bayesline.api.DatasetError
      • bayesline.api.DeleteItemResult
      • bayesline.api.DeleteResult
      • bayesline.api.EmptySettingsMenu
      • bayesline.api.ItemResult
      • bayesline.api.ItemStatus
      • bayesline.api.PermissionItemResult
      • bayesline.api.PermissionResult
      • bayesline.api.RawSettings
      • bayesline.api.SaveItemResult
      • bayesline.api.SaveResult
      • bayesline.api.SettingInvalid
      • bayesline.api.SettingNotFound
      • bayesline.api.SettingNotPermissioned
      • bayesline.api.SettingResult
      • bayesline.api.Settings
      • bayesline.api.SettingsMenu
      • bayesline.api.SettingsMetaData
      • bayesline.api.SettingsRegistryError
      • bayesline.api.SettingsRegistryResult
      • bayesline.api.SettingsTransferObject
      • bayesline.api.SettingValid
      • bayesline.api.expect_valid
      • bayesline.api.unwrap_valid
      • bayesline.api.REPORT_SETTINGS_TYPES
      • bayesline.api.RISKDATASET_SETTINGS_TYPES
      • bayesline.api.SETTINGS_TYPES
      • bayesline.api.migrate_raw_json
      • bayesline.api.parse_stored
      • bayesline.api.stamp_version
      • bayesline.api.strip_meta_keys
      • bayesline.api.validate_migration_chain
      • bayesline.api.DATASET_KEY
      • bayesline.api.AsyncTask
      • bayesline.api.AsyncTasksApi
      • bayesline.api.Task
      • bayesline.api.TaskError
      • bayesline.api.TaskProgress
      • bayesline.api.TaskResponse
      • bayesline.api.TasksApi
      • bayesline.api.TaskState
    • bayesline.apiclient
      • bayesline.apiclient.ApiClient
      • bayesline.apiclient.AsyncApiClient
      • bayesline.apiclient.BayeslineApiClient
      • bayesline.apiclient.AsyncBayeslineApiClient
      • bayesline.apiclient.AsyncTasksClient
      • bayesline.apiclient.TasksClient
      • bayesline.apiclient.AsyncTaskClient
      • bayesline.apiclient.TaskClient
      • bayesline.apiclient.AsyncDataFrameTaskClient
      • bayesline.apiclient.DataFrameTaskClient
      • bayesline.apiclient.PydanticTaskClient
      • bayesline.apiclient.AsyncPydanticTaskClient
      • bayesline.apiclient.AsyncLazyFrameTaskClient
      • bayesline.apiclient.LazyFrameTaskClient
      • bayesline.apiclient.ResolvedObjectTaskClient
      • bayesline.apiclient.AsyncResolvedObjectTaskClient
      • bayesline.apiclient.AsyncSettingsRegistryClient
      • bayesline.apiclient.SettingsRegistryClient
  • Change Log
  • Glossary
  • .rst

bayesline documentation

bayesline documentation#

Public API for Bayesline products.

Getting Started

  • Installation
  • Quickstart
  • AI Assistant Skill
    • Install
    • What’s inside
  • Tutorials
    • Factor Covariance Matrix Forecasts
    • Factor Returns Computation Validation
    • Exposure Upload Commit Modes
    • Adding New Factors
    • Portfolios
    • Portfolio Hierarchies
    • Risk Datasets
    • Data Uploaders
    • Custom Dataset From Scratch
  • Recipes
    • Uploading New Exposures to Existing Dataset and Updating the Risk Dataset
    • Idiosyncratic volatility and correlation forecasting
    • Factor Attribution
    • Model Onboarding
    • Interaction Factors
    • Portfolio Aligned Universes
  • Frequently Asked Questions (FAQ)

More Resources

  • bayesline Public API
    • Subpackages
      • bayesline.api
      • bayesline.apiclient
  • Change Log
  • Glossary

next

Installation

By Bayesline authors

© Copyright 2025, Bayesline.