Skip to main content
Ctrl+K
quantlab 0.2.0 - Home quantlab 0.2.0 - Home
  • Getting started
  • User guide
  • API reference
  • Developer guide
  • Release notes
  • GitHub
  • PyPI
  • Getting started
  • User guide
  • API reference
  • Developer guide
  • Release notes
  • GitHub
  • PyPI

Section Navigation

  • quantlab.utils
    • quantlab.utils.atomic
      • quantlab.utils.atomic.write_json_atomically
      • quantlab.utils.atomic.write_parquet_atomically
    • quantlab.utils.cli
      • quantlab.utils.cli.add_max_workers_arg
      • quantlab.utils.cli.add_output_dir_args
      • quantlab.utils.cli.inside_repository
      • quantlab.utils.cli.place_downloads
      • quantlab.utils.cli.print_conversion_result
      • quantlab.utils.cli.resolve_output_dirs
    • quantlab.utils.cross_section
      • quantlab.utils.cross_section.cross_sectional_zscore
    • quantlab.utils.date_range
      • quantlab.utils.date_range.as_label
      • quantlab.utils.date_range.bar_label
      • quantlab.utils.date_range.check_range
      • quantlab.utils.date_range.label_ns
      • quantlab.utils.date_range.last_moment
      • quantlab.utils.date_range.range_text
      • quantlab.utils.date_range.resample_padding
    • quantlab.utils.jsonable
      • quantlab.utils.jsonable.to_jsonable
    • quantlab.utils.progress
      • quantlab.utils.progress.CallbackProgressReporter
      • quantlab.utils.progress.CancelToken
      • quantlab.utils.progress.NullProgressReporter
      • quantlab.utils.progress.ProgressEvent
      • quantlab.utils.progress.ProgressReporter
      • quantlab.utils.progress.TqdmProgressReporter
    • quantlab.utils.resample
      • quantlab.utils.resample.assert_coarser
      • quantlab.utils.resample.clock_labels
      • quantlab.utils.resample.resample_seconds
      • quantlab.utils.resample.resample_store_path
      • quantlab.utils.resample.resolve_resample_how
      • quantlab.utils.resample.session_labels
      • quantlab.utils.resample.source_interval_seconds
      • quantlab.utils.resample.validate_resample_config
    • quantlab.utils.returns
      • quantlab.utils.returns.one_bar_returns
    • quantlab.utils.sidecar
      • quantlab.utils.sidecar.JsonSidecar
    • quantlab.utils.symbol_axis
      • quantlab.utils.symbol_axis.normalize_to_axis_dtype
      • quantlab.utils.symbol_axis.on_roster
      • quantlab.utils.symbol_axis.sort_symbol_axis
    • quantlab.utils.timer
      • quantlab.utils.timer.Timer
    • quantlab.utils.watermark
      • quantlab.utils.watermark.holds
      • quantlab.utils.watermark.read_watermark
      • quantlab.utils.watermark.resume_from
      • quantlab.utils.watermark.write_watermark
  • quantlab.enums
    • quantlab.enums.constant
      • quantlab.enums.constant.Date
    • quantlab.enums.data
      • quantlab.enums.data.BinanceCSVHeaders
      • quantlab.enums.data.TiingoColumns
  • quantlab.core
    • quantlab.core.component
      • quantlab.core.component.Component
      • quantlab.core.component.child_components
      • quantlab.core.component.component
      • quantlab.core.component.component_fields
      • quantlab.core.component.config_cls_of
      • quantlab.core.component.config_to_dict
      • quantlab.core.component.get_cls_from_path
      • quantlab.core.component.rebuild
      • quantlab.core.component.recorded_configs
      • quantlab.core.component.walk_components
    • quantlab.core.config
      • quantlab.core.config.FrozenConfig
    • quantlab.core.store_folder
      • quantlab.core.store_folder.load_component
      • quantlab.core.store_folder.save_component
    • quantlab.core.store_uses
      • quantlab.core.store_uses.BuiltFrom
      • quantlab.core.store_uses.FoundStoreUse
      • quantlab.core.store_uses.RangedStoreHandle
      • quantlab.core.store_uses.StoreUse
      • quantlab.core.store_uses.walk_store_uses
  • quantlab.backend
    • quantlab.backend.base
      • quantlab.backend.base.DataBackend
    • quantlab.backend.parquet
      • quantlab.backend.parquet.PlBackend
    • quantlab.backend.ranged
      • quantlab.backend.ranged.RangedStore
    • quantlab.backend.resample
      • quantlab.backend.resample.resample_on_read
      • quantlab.backend.resample.resample_panel
    • quantlab.backend.zarr
      • quantlab.backend.zarr.XrBackend
      • quantlab.backend.zarr.rechunk_index_coordinates
  • quantlab.tracking
    • quantlab.tracking.base
      • quantlab.tracking.base.NullRun
      • quantlab.tracking.base.NullTracker
      • quantlab.tracking.base.Tracker
      • quantlab.tracking.base.TrackingRun
      • quantlab.tracking.base.flatten_metrics
    • quantlab.tracking.mlflow
      • quantlab.tracking.mlflow.MlflowRun
      • quantlab.tracking.mlflow.MlflowTracker
    • quantlab.tracking.wandb
      • quantlab.tracking.wandb.WandbRun
      • quantlab.tracking.wandb.WandbTracker
  • quantlab.execution
    • quantlab.execution.approximate
      • quantlab.execution.approximate.entry_prices
      • quantlab.execution.approximate.ffill
      • quantlab.execution.approximate.mark_book
      • quantlab.execution.approximate.price_relative
      • quantlab.execution.approximate.simulate
    • quantlab.execution.rules
      • quantlab.execution.rules.BarExecution
      • quantlab.execution.rules.ExecutionBook
      • quantlab.execution.rules.ExecutionReplay
      • quantlab.execution.rules.ExecutionSettings
      • quantlab.execution.rules.OrderPlan
      • quantlab.execution.rules.add
      • quantlab.execution.rules.is_close
      • quantlab.execution.rules.plan_orders
      • quantlab.execution.rules.replay
  • quantlab.runs
    • quantlab.runs.backtest_attribution
      • quantlab.runs.backtest_attribution.annualized_log_growth
      • quantlab.runs.backtest_attribution.attribution_metrics
      • quantlab.runs.backtest_attribution.excess_decomposition
      • quantlab.runs.backtest_attribution.rebalanced_group_values
    • quantlab.runs.backtest_report
      • quantlab.runs.backtest_report.ReportExtras
      • quantlab.runs.backtest_report.backtest_report_figure
      • quantlab.runs.backtest_report.write_backtest_report
    • quantlab.runs.backtest_run
      • quantlab.runs.backtest_run.Annualization
      • quantlab.runs.backtest_run.BacktestRun
      • quantlab.runs.backtest_run.FoldArtifacts
      • quantlab.runs.backtest_run.Market
      • quantlab.runs.backtest_run.write_backtest_run
    • quantlab.runs.backtest_stats
      • quantlab.runs.backtest_stats.drawdown_span
      • quantlab.runs.backtest_stats.exposure_stats
      • quantlab.runs.backtest_stats.in_ranges
      • quantlab.runs.backtest_stats.rebalance_fill_bars
      • quantlab.runs.backtest_stats.relative_stats
      • quantlab.runs.backtest_stats.return_stats
      • quantlab.runs.backtest_stats.round_trip_stats
      • quantlab.runs.backtest_stats.round_trips
      • quantlab.runs.backtest_stats.turnover
      • quantlab.runs.backtest_stats.turnover_stats
      • quantlab.runs.backtest_stats.win_rates
      • quantlab.runs.backtest_stats.year_freq
    • quantlab.runs.directory
      • quantlab.runs.directory.open_run
      • quantlab.runs.directory.read_record
      • quantlab.runs.directory.record_path
      • quantlab.runs.directory.recorded_path
      • quantlab.runs.directory.relative_name
      • quantlab.runs.directory.run_directory
      • quantlab.runs.directory.staged
      • quantlab.runs.directory.write_record
    • quantlab.runs.factor_attribution_report
      • quantlab.runs.factor_attribution_report.factor_attribution_section
    • quantlab.runs.live_predictions
      • quantlab.runs.live_predictions.LivePredictionStore
    • quantlab.runs.prediction_panel
      • quantlab.runs.prediction_panel.LabelSpec
      • quantlab.runs.prediction_panel.PredictionPanel
    • quantlab.runs.record
      • quantlab.runs.record.DataRecorder
      • quantlab.runs.record.code_of
      • quantlab.runs.record.code_record
      • quantlab.runs.record.compare
      • quantlab.runs.record.record_read
      • quantlab.runs.record.unrecorded
    • quantlab.runs.run_metrics
      • quantlab.runs.run_metrics.AccountRecord
      • quantlab.runs.run_metrics.BenchmarkRecord
      • quantlab.runs.run_metrics.decided_bars
      • quantlab.runs.run_metrics.run_metrics
      • quantlab.runs.run_metrics.slice_ranges
    • quantlab.runs.trained_run
      • quantlab.runs.trained_run.TrainedRun
      • quantlab.runs.trained_run.evaluation_paths
      • quantlab.runs.trained_run.fold_directory
      • quantlab.runs.trained_run.member_directory
      • quantlab.runs.trained_run.new_trial_directory
      • quantlab.runs.trained_run.write_ensemble_run
      • quantlab.runs.trained_run.write_model_config
      • quantlab.runs.trained_run.write_model_run
      • quantlab.runs.trained_run.write_walk_forward_run
  • quantlab.universe
    • quantlab.universe.IndexMembershipFetcher
    • quantlab.universe.Nasdaq100MembershipFetcher
    • quantlab.universe.NasdaqUniverseFetcher
    • quantlab.universe.SP500MembershipFetcher
    • quantlab.universe.TiingoRosterFetcher
    • quantlab.universe.USEquityUniverseFetcher
    • quantlab.universe.UniverseCatalog
    • quantlab.universe.UniverseConfig
  • quantlab.dataset
    • quantlab.dataset.bad_prints
      • quantlab.dataset.bad_prints.BadPrintMaskedDataset
    • quantlab.dataset.base
      • quantlab.dataset.base.BaseDataset
      • quantlab.dataset.base.MarketDataset
      • quantlab.dataset.base.SymbolName
      • quantlab.dataset.base.TickerLookup
      • quantlab.dataset.base.bar_after_on
      • quantlab.dataset.base.bar_before_on
      • quantlab.dataset.base.stores_text
    • quantlab.dataset.common_stock
      • quantlab.dataset.common_stock.CommonStockConstituentDataset
    • quantlab.dataset.config
      • quantlab.dataset.config.BadPrintMaskedDatasetConfig
      • quantlab.dataset.config.BaseDatasetConfig
      • quantlab.dataset.config.ConstituentDatasetConfig
      • quantlab.dataset.config.CrspDatasetConfig
      • quantlab.dataset.config.DatasetConfig
      • quantlab.dataset.config.FrameDatasetConfig
      • quantlab.dataset.config.FredRateConfig
      • quantlab.dataset.config.MappedDayBarsConfig
      • quantlab.dataset.config.MappedTradeBarsConfig
      • quantlab.dataset.config.MassiveDayBarsDatasetConfig
      • quantlab.dataset.config.MassiveDisclosuresConfig
      • quantlab.dataset.config.MassiveDividendsConfig
      • quantlab.dataset.config.MassiveIposConfig
      • quantlab.dataset.config.MassiveNewsConfig
      • quantlab.dataset.config.MassiveRestPanelConfig
      • quantlab.dataset.config.MassiveShortInterestConfig
      • quantlab.dataset.config.MassiveShortVolumeConfig
      • quantlab.dataset.config.MassiveTenKChangesConfig
      • quantlab.dataset.config.MassiveTradeBarsDatasetConfig
      • quantlab.dataset.config.MergedDatasetConfig
      • quantlab.dataset.config.NbboBarsDatasetConfig
      • quantlab.dataset.config.NbboDatasetConfig
      • quantlab.dataset.config.PermatickerDayBarsConfig
      • quantlab.dataset.config.PermatickerTradeBarsConfig
      • quantlab.dataset.config.RosterDatasetConfig
      • quantlab.dataset.config.SharadarActionsConfig
      • quantlab.dataset.config.SharadarDailyConfig
      • quantlab.dataset.config.SharadarDatasetConfig
      • quantlab.dataset.config.SharadarEventsConfig
      • quantlab.dataset.config.SharadarFiscalYearsConfig
      • quantlab.dataset.config.SharadarFundamentalsConfig
      • quantlab.dataset.config.SharadarHoldingsConfig
      • quantlab.dataset.config.SharadarIndustryConfig
      • quantlab.dataset.config.SharadarInsidersConfig
      • quantlab.dataset.config.SharadarListingConfig
      • quantlab.dataset.config.SharadarShareClassConfig
      • quantlab.dataset.config.TickerMapConfig
    • quantlab.dataset.constituent
      • quantlab.dataset.constituent.CompustatNasdaq100ConstituentDataset
      • quantlab.dataset.constituent.CrspMarketConstituentDataset
      • quantlab.dataset.constituent.CrspSP500ConstituentDataset
      • quantlab.dataset.constituent.Nasdaq100ConstituentDataset
      • quantlab.dataset.constituent.SP500ConstituentDataset
    • quantlab.dataset.crsp
      • quantlab.dataset.crsp.CrspStockDataset
      • quantlab.dataset.crsp.resolve_security_filter
      • quantlab.dataset.crsp.market
        • quantlab.dataset.crsp.market.CrspMarketRoster
      • quantlab.dataset.crsp.membership
        • quantlab.dataset.crsp.membership.CrspMembership
      • quantlab.dataset.crsp.reference
        • quantlab.dataset.crsp.reference.CrspReference
        • quantlab.dataset.crsp.reference.ReferenceTableSpec
      • quantlab.dataset.crsp.symbology
        • quantlab.dataset.crsp.symbology.CrspSymbology
      • quantlab.dataset.crsp.tickers
        • quantlab.dataset.crsp.tickers.CrspTickerLookup
    • quantlab.dataset.estu
      • quantlab.dataset.estu.EstuConstituentDataset
    • quantlab.dataset.fred
      • quantlab.dataset.fred.FredRateDataset
    • quantlab.dataset.massive
      • quantlab.dataset.massive.day_bar_events
        • quantlab.dataset.massive.day_bar_events.day_bar_events
        • quantlab.dataset.massive.day_bar_events.session_days
      • quantlab.dataset.massive.day_bars
        • quantlab.dataset.massive.day_bars.MassiveDayBarDataset
      • quantlab.dataset.massive.disclosures
        • quantlab.dataset.massive.disclosures.MassiveDisclosureDataset
      • quantlab.dataset.massive.dividends
        • quantlab.dataset.massive.dividends.MassiveDividendDataset
        • quantlab.dataset.massive.dividends.usd_dividends
      • quantlab.dataset.massive.ipos
        • quantlab.dataset.massive.ipos.MassiveIpoDataset
      • quantlab.dataset.massive.mapped_bars
        • quantlab.dataset.massive.mapped_bars.MappedDayBarDataset
        • quantlab.dataset.massive.mapped_bars.MappedPermatickerDataset
        • quantlab.dataset.massive.mapped_bars.MappedTradeBarDataset
        • quantlab.dataset.massive.mapped_bars.day_digests
        • quantlab.dataset.massive.mapped_bars.map_days
      • quantlab.dataset.massive.news
        • quantlab.dataset.massive.news.MassiveNewsDataset
      • quantlab.dataset.massive.permaticker_bars
        • quantlab.dataset.massive.permaticker_bars.PermatickerDataset
        • quantlab.dataset.massive.permaticker_bars.PermatickerDayBarDataset
        • quantlab.dataset.massive.permaticker_bars.PermatickerTradeBarDataset
      • quantlab.dataset.massive.placement
        • quantlab.dataset.massive.placement.TickerPlacement
      • quantlab.dataset.massive.raw
        • quantlab.dataset.massive.raw.conditions_file
        • quantlab.dataset.massive.raw.latest_conditions
        • quantlab.dataset.massive.raw.raw_days
        • quantlab.dataset.massive.raw.raw_file
        • quantlab.dataset.massive.raw.read_aggregates
        • quantlab.dataset.massive.raw.read_conditions
        • quantlab.dataset.massive.raw.read_rest_as_of
        • quantlab.dataset.massive.raw.read_rest_records
        • quantlab.dataset.massive.raw.read_rest_snapshot
        • quantlab.dataset.massive.raw.read_rest_watermark
        • quantlab.dataset.massive.raw.read_trades
        • quantlab.dataset.massive.raw.read_watermark
        • quantlab.dataset.massive.raw.rest_as_of_days
        • quantlab.dataset.massive.raw.rest_as_of_dir
        • quantlab.dataset.massive.raw.rest_dir
        • quantlab.dataset.massive.raw.rest_frame
        • quantlab.dataset.massive.raw.rest_page_file
        • quantlab.dataset.massive.raw.rest_page_files
        • quantlab.dataset.massive.raw.rest_pending_dir
        • quantlab.dataset.massive.raw.rest_snapshots
        • quantlab.dataset.massive.raw.rest_watermark_file
        • quantlab.dataset.massive.raw.s3_key
        • quantlab.dataset.massive.raw.watermark_file
      • quantlab.dataset.massive.resample
        • quantlab.dataset.massive.resample.TradeBarResampler
      • quantlab.dataset.massive.rest_panel
        • quantlab.dataset.massive.rest_panel.MassiveRestEventPanel
        • quantlab.dataset.massive.rest_panel.MassiveRestPanel
      • quantlab.dataset.massive.short_interest
        • quantlab.dataset.massive.short_interest.MassiveShortInterestDataset
      • quantlab.dataset.massive.short_volume
        • quantlab.dataset.massive.short_volume.MassiveShortVolumeDataset
      • quantlab.dataset.massive.ten_k
        • quantlab.dataset.massive.ten_k.MassiveTenKChangesDataset
        • quantlab.dataset.massive.ten_k.section_changes
      • quantlab.dataset.massive.ticker_map
        • quantlab.dataset.massive.ticker_map.TickerMap
        • quantlab.dataset.massive.ticker_map.decide
      • quantlab.dataset.massive.trade_bars
        • quantlab.dataset.massive.trade_bars.ConvertedTradeDay
        • quantlab.dataset.massive.trade_bars.MassiveTradeBarDataset
        • quantlab.dataset.massive.trade_bars.no_trade_fills
        • quantlab.dataset.massive.trade_bars.trade_bar_store_name
      • quantlab.dataset.massive.vendor_check
        • quantlab.dataset.massive.vendor_check.check_minute_bars
    • quantlab.dataset.memory
      • quantlab.dataset.memory.FrameDataset
    • quantlab.dataset.merged
      • quantlab.dataset.merged.MergedDataset
    • quantlab.dataset.nbbo
      • quantlab.dataset.nbbo.NbboPanelDataset
      • quantlab.dataset.nbbo.bars
        • quantlab.dataset.nbbo.bars.NbboBarsDataset
        • quantlab.dataset.nbbo.bars.NbboBarsRequest
        • quantlab.dataset.nbbo.bars.NbboBarsSession
      • quantlab.dataset.nbbo.panel
        • quantlab.dataset.nbbo.panel.NbboPanelBase
      • quantlab.dataset.nbbo.resample
        • quantlab.dataset.nbbo.resample.NbboFilterPolicy
        • quantlab.dataset.nbbo.resample.NbboResampler
        • quantlab.dataset.nbbo.resample.snapshot_derived_variables
    • quantlab.dataset.raw
      • quantlab.dataset.raw.ConversionResult
      • quantlab.dataset.raw.IndexConstituentDataset
      • quantlab.dataset.raw.RawDataset
      • quantlab.dataset.raw.RawMarketDataset
    • quantlab.dataset.roster
      • quantlab.dataset.roster.RosterDataset
    • quantlab.dataset.sharadar
      • quantlab.dataset.sharadar.actions
        • quantlab.dataset.sharadar.actions.SharadarActionsDataset
        • quantlab.dataset.sharadar.actions.Variable
      • quantlab.dataset.sharadar.daily
        • quantlab.dataset.sharadar.daily.SharadarDailyDataset
      • quantlab.dataset.sharadar.events
        • quantlab.dataset.sharadar.events.SharadarEventsDataset
      • quantlab.dataset.sharadar.filings
        • quantlab.dataset.sharadar.filings.FilingPanelDataset
      • quantlab.dataset.sharadar.fiscal_years
        • quantlab.dataset.sharadar.fiscal_years.SharadarFiscalYearsDataset
        • quantlab.dataset.sharadar.fiscal_years.slot_name
      • quantlab.dataset.sharadar.fundamentals
        • quantlab.dataset.sharadar.fundamentals.SharadarFundamentalsDataset
      • quantlab.dataset.sharadar.history
        • quantlab.dataset.sharadar.history.changes
        • quantlab.dataset.sharadar.history.sep_securities
        • quantlab.dataset.sharadar.history.sic_history
        • quantlab.dataset.sharadar.history.walk_back
      • quantlab.dataset.sharadar.holdings
        • quantlab.dataset.sharadar.holdings.SharadarHoldingsDataset
      • quantlab.dataset.sharadar.industry
        • quantlab.dataset.sharadar.industry.SharadarIndustryDataset
      • quantlab.dataset.sharadar.insiders
        • quantlab.dataset.sharadar.insiders.SharadarInsidersDataset
      • quantlab.dataset.sharadar.listing
        • quantlab.dataset.sharadar.listing.SharadarListingDataset
      • quantlab.dataset.sharadar.membership
        • quantlab.dataset.sharadar.membership.SharadarSP500ConstituentDataset
        • quantlab.dataset.sharadar.membership.sp500_intervals
      • quantlab.dataset.sharadar.permatickers
        • quantlab.dataset.sharadar.permatickers.HolderSpan
        • quantlab.dataset.sharadar.permatickers.PermatickerResolver
        • quantlab.dataset.sharadar.permatickers.SeenSpan
        • quantlab.dataset.sharadar.permatickers.map_raw_table
        • quantlab.dataset.sharadar.permatickers.related_spans
        • quantlab.dataset.sharadar.permatickers.ticker_changes
      • quantlab.dataset.sharadar.point_in_time
        • quantlab.dataset.sharadar.point_in_time.ReleasePanelDataset
        • quantlab.dataset.sharadar.point_in_time.ReleaseSpec
        • quantlab.dataset.sharadar.point_in_time.TradingCalendar
        • quantlab.dataset.sharadar.point_in_time.as_of
        • quantlab.dataset.sharadar.point_in_time.on_grid
        • quantlab.dataset.sharadar.point_in_time.shown_symbols
        • quantlab.dataset.sharadar.point_in_time.to_panel
      • quantlab.dataset.sharadar.share_class
        • quantlab.dataset.sharadar.share_class.SharadarShareClassDataset
      • quantlab.dataset.sharadar.spells
        • quantlab.dataset.sharadar.spells.SpellPanelDataset
      • quantlab.dataset.sharadar.stock
        • quantlab.dataset.sharadar.stock.SharadarStockDataset
      • quantlab.dataset.sharadar.stores
        • quantlab.dataset.sharadar.stores.SharadarStore
        • quantlab.dataset.sharadar.stores.StoreResult
        • quantlab.dataset.sharadar.stores.StoreState
        • quantlab.dataset.sharadar.stores.StoreUpdate
        • quantlab.dataset.sharadar.stores.build_stores
        • quantlab.dataset.sharadar.stores.missing_stores
        • quantlab.dataset.sharadar.stores.store
        • quantlab.dataset.sharadar.stores.update_stores
        • quantlab.dataset.sharadar.stores.write_ticker_sidecars
      • quantlab.dataset.sharadar.tables
        • quantlab.dataset.sharadar.tables.SharadarTable
        • quantlab.dataset.sharadar.tables.bulk_file
        • quantlab.dataset.sharadar.tables.map_permatickers
        • quantlab.dataset.sharadar.tables.permaticker_mapping
        • quantlab.dataset.sharadar.tables.pull_day
        • quantlab.dataset.sharadar.tables.pull_time
        • quantlab.dataset.sharadar.tables.raw_files
        • quantlab.dataset.sharadar.tables.raw_table_dir
        • quantlab.dataset.sharadar.tables.raw_through
        • quantlab.dataset.sharadar.tables.read_watermark
        • quantlab.dataset.sharadar.tables.scan_raw_table
        • quantlab.dataset.sharadar.tables.snapshot_for
        • quantlab.dataset.sharadar.tables.split_basis_change
        • quantlab.dataset.sharadar.tables.table
        • quantlab.dataset.sharadar.tables.tickers_history
        • quantlab.dataset.sharadar.tables.tickers_history_file
        • quantlab.dataset.sharadar.tables.tickers_snapshot_file
        • quantlab.dataset.sharadar.tables.tickers_snapshots
        • quantlab.dataset.sharadar.tables.trading_days
        • quantlab.dataset.sharadar.tables.updated_file
        • quantlab.dataset.sharadar.tables.vendor_today
        • quantlab.dataset.sharadar.tables.window_file
        • quantlab.dataset.sharadar.tables.with_pull_day
      • quantlab.dataset.sharadar.tickers
        • quantlab.dataset.sharadar.tickers.SharadarTickerLookup
        • quantlab.dataset.sharadar.tickers.ticker_sidecar_payload
      • quantlab.dataset.sharadar.universe
        • quantlab.dataset.sharadar.universe.normalize_universe
        • quantlab.dataset.sharadar.universe.universe
    • quantlab.dataset.spot
      • quantlab.dataset.spot.SpotKlineDataset
    • quantlab.dataset.stock
      • quantlab.dataset.stock.StockDataset
  • quantlab.config
    • quantlab.config.get_data_root
    • quantlab.config.set_data_root
    • quantlab.config.stock_kline_config
    • quantlab.config.universe_config
  • quantlab.acquisition
    • quantlab.acquisition.alpaca
      • quantlab.acquisition.alpaca.AlpacaAcquisition
    • quantlab.acquisition.base
      • quantlab.acquisition.base.Capability
      • quantlab.acquisition.base.DataSourceRegistry
      • quantlab.acquisition.base.SourceDescriptor
      • quantlab.acquisition.base.register_source
    • quantlab.acquisition.config
      • quantlab.acquisition.config.AcquisitionConfig
      • quantlab.acquisition.config.stock_acquisition_config
    • quantlab.acquisition.fred
      • quantlab.acquisition.fred.FredAcquisition
      • quantlab.acquisition.fred.parse_csv
      • quantlab.acquisition.fred.refresh_raw_tier
    • quantlab.acquisition.massive
      • quantlab.acquisition.massive.client
        • quantlab.acquisition.massive.client.DayDownload
        • quantlab.acquisition.massive.client.MassiveClient
        • quantlab.acquisition.massive.client.MassiveCredentials
        • quantlab.acquisition.massive.client.ObjectStore
        • quantlab.acquisition.massive.client.RestPull
        • quantlab.acquisition.massive.client.S3ObjectStore
        • quantlab.acquisition.massive.client.rest_transport
      • quantlab.acquisition.massive.raw_tier
        • quantlab.acquisition.massive.raw_tier.write_day_file_watermark
        • quantlab.acquisition.massive.raw_tier.write_rest_page
        • quantlab.acquisition.massive.raw_tier.write_rest_watermark
      • quantlab.acquisition.massive.refresh
        • quantlab.acquisition.massive.refresh.refresh_raw_tier
      • quantlab.acquisition.massive.rest
        • quantlab.acquisition.massive.rest.RestEndpoint
    • quantlab.acquisition.refresh
      • quantlab.acquisition.refresh.RawTierRefresh
      • quantlab.acquisition.refresh.RawTierRefreshResult
      • quantlab.acquisition.refresh.RefreshedPart
    • quantlab.acquisition.registry
      • quantlab.acquisition.registry.convert
      • quantlab.acquisition.registry.credential_status
      • quantlab.acquisition.registry.download_symbols
      • quantlab.acquisition.registry.is_configured
      • quantlab.acquisition.registry.refresh_raw_tier
    • quantlab.acquisition.sharadar
      • quantlab.acquisition.sharadar.client
        • quantlab.acquisition.sharadar.client.SharadarClient
        • quantlab.acquisition.sharadar.client.default_transport
      • quantlab.acquisition.sharadar.raw_tier
        • quantlab.acquisition.sharadar.raw_tier.fold_tickers_history
        • quantlab.acquisition.sharadar.raw_tier.prune_tickers_snapshots
        • quantlab.acquisition.sharadar.raw_tier.write_bulk_pull
        • quantlab.acquisition.sharadar.raw_tier.write_table_watermark
      • quantlab.acquisition.sharadar.refresh
        • quantlab.acquisition.sharadar.refresh.refresh_raw_tier
    • quantlab.acquisition.symbol_batch
      • quantlab.acquisition.symbol_batch.AcquisitionResult
      • quantlab.acquisition.symbol_batch.BatchOutcome
      • quantlab.acquisition.symbol_batch.SymbolBatchAcquisition
    • quantlab.acquisition.tiingo
      • quantlab.acquisition.tiingo.TiingoAcquisition
    • quantlab.acquisition.wrds
      • quantlab.acquisition.wrds.crsp
        • quantlab.acquisition.wrds.crsp.CrspQueries
        • quantlab.acquisition.wrds.crsp.WrdsCrspDailyAcquisition
        • quantlab.acquisition.wrds.crsp.year_pages
      • quantlab.acquisition.wrds.crsp_reference
        • quantlab.acquisition.wrds.crsp_reference.CrspReferenceTables
      • quantlab.acquisition.wrds.nbbo_bars_sql
        • quantlab.acquisition.wrds.nbbo_bars_sql.NbboBarsQuery
      • quantlab.acquisition.wrds.rebuild
        • quantlab.acquisition.wrds.rebuild.CrspStoreRebuilder
      • quantlab.acquisition.wrds.taq
        • quantlab.acquisition.wrds.taq.WrdsSession
        • quantlab.acquisition.wrds.taq.WrdsTaqNbboAcquisition
        • quantlab.acquisition.wrds.taq.trading_days_between
      • quantlab.acquisition.wrds.taq_bars
        • quantlab.acquisition.wrds.taq_bars.WrdsTaqNbboBarsAcquisition
  • quantlab.analysis
    • quantlab.analysis.factor_correlation
      • quantlab.analysis.factor_correlation.FactorCorrelation
      • quantlab.analysis.factor_correlation.FactorCorrelationFigure
    • quantlab.analysis.factor_report
      • quantlab.analysis.factor_report.FactorAnalysis
      • quantlab.analysis.factor_report.FactorAnalyzer
      • quantlab.analysis.factor_report.FactorReportFigure
      • quantlab.analysis.factor_report.Fret
      • quantlab.analysis.factor_report.PairAnalysis
      • quantlab.analysis.factor_report.long_short_statistics
      • quantlab.analysis.factor_report.most_common_spacing
      • quantlab.analysis.factor_report.newey_west_lags
      • quantlab.analysis.factor_report.newey_west_t_stat
      • quantlab.analysis.factor_report.pair_cumulative_ic
  • quantlab.factor
    • quantlab.factor.base
      • quantlab.factor.base.Factor
    • quantlab.factor.chunking
      • quantlab.factor.chunking.ChunkedBuilder
      • quantlab.factor.chunking.memory_budget
      • quantlab.factor.chunking.release_memory
    • quantlab.factor.config
      • quantlab.factor.config.BaseFactorConfig
      • quantlab.factor.config.BenchmarkBetaConfig
      • quantlab.factor.config.FactorConfig
      • quantlab.factor.config.FactorViewConfig
      • quantlab.factor.config.IntradayAverageConfig
      • quantlab.factor.config.IntradayCompositeConfig
      • quantlab.factor.config.MarketFeatureConfig
      • quantlab.factor.config.MembershipCapWeightConfig
      • quantlab.factor.config.MembershipMaskedFactorConfig
      • quantlab.factor.config.NeutralizedConfig
      • quantlab.factor.config.PolarsFactorConfig
      • quantlab.factor.config.RosterConfig
      • quantlab.factor.config.StartClippedConfig
    • quantlab.factor.kunquant
      • quantlab.factor.kunquant.FactorKunQuant
      • quantlab.factor.kunquant.run_batch_graph
      • quantlab.factor.kunquant.shared_executor
    • quantlab.factor.kunquant_compile
      • quantlab.factor.kunquant_compile.cache_dir
      • quantlab.factor.kunquant_compile.compile_graphs
      • quantlab.factor.kunquant_compile.graph_key
    • quantlab.factor.kunquant_cs
      • quantlab.factor.kunquant_cs.CapWeightedStandardize
      • quantlab.factor.kunquant_cs.CrossSectionalIndustrySizeFill
      • quantlab.factor.kunquant_cs.CrossSectionalNeutralize
      • quantlab.factor.kunquant_cs.CrossSectionalSigmaClip
      • quantlab.factor.kunquant_cs.CrossSectionalTopN
      • quantlab.factor.kunquant_cs.CrossSectionalTrim
      • quantlab.factor.kunquant_cs.CrossSectionalWLSResidual
      • quantlab.factor.kunquant_cs.CrossSectionalWeightedMean
      • quantlab.factor.kunquant_cs.CrossSectionalWinsorize
      • quantlab.factor.kunquant_cs.CrossSectionalZScore
      • quantlab.factor.kunquant_cs.RenormalizedCombine
    • quantlab.factor.kunquant_ts
      • quantlab.factor.kunquant_ts.CMRA
      • quantlab.factor.kunquant_ts.EWAlpha
      • quantlab.factor.kunquant_ts.EWBeta
      • quantlab.factor.kunquant_ts.EWCov
      • quantlab.factor.kunquant_ts.EWMean
      • quantlab.factor.kunquant_ts.EWResidualStd
      • quantlab.factor.kunquant_ts.EWSum
      • quantlab.factor.kunquant_ts.EWVar
      • quantlab.factor.kunquant_ts.WindowedZScore
    • quantlab.factor.polars
      • quantlab.factor.polars.FactorPolars
    • quantlab.factor.predefined
      • quantlab.factor.predefined.alpha101
        • quantlab.factor.predefined.alpha101.Alpha101SpotKline
        • quantlab.factor.predefined.alpha101.Alpha101Stock
      • quantlab.factor.predefined.alpha158
        • quantlab.factor.predefined.alpha158.Alpha158SpotKline
        • quantlab.factor.predefined.alpha158.Alpha158Stock
      • quantlab.factor.predefined.alternative_alpha
        • quantlab.factor.predefined.alternative_alpha.AlternativeAlpha
        • quantlab.factor.predefined.alternative_alpha.AlternativeAlphaParameters
      • quantlab.factor.predefined.barra
        • quantlab.factor.predefined.barra.BarraStyle
        • quantlab.factor.predefined.barra.BarraStyleParameters
      • quantlab.factor.predefined.benchmark_beta
        • quantlab.factor.predefined.benchmark_beta.BenchmarkBeta
        • quantlab.factor.predefined.benchmark_beta.rolling_beta
      • quantlab.factor.predefined.daily_anomaly_alpha
        • quantlab.factor.predefined.daily_anomaly_alpha.DailyAnomalyAlpha
        • quantlab.factor.predefined.daily_anomaly_alpha.acquirer_payments
      • quantlab.factor.predefined.fundamental_alpha
        • quantlab.factor.predefined.fundamental_alpha.FundamentalAlpha
        • quantlab.factor.predefined.fundamental_alpha.FundamentalAlphaParameters
        • quantlab.factor.predefined.fundamental_alpha.fill_flows
        • quantlab.factor.predefined.fundamental_alpha.report_lags
        • quantlab.factor.predefined.fundamental_alpha.value_on_dates
      • quantlab.factor.predefined.intraday
        • quantlab.factor.predefined.intraday.CompositePart
        • quantlab.factor.predefined.intraday.IntradayAverage
        • quantlab.factor.predefined.intraday.IntradayComposite
        • quantlab.factor.predefined.intraday.IntradayParameters
        • quantlab.factor.predefined.intraday.IntradayStats
        • quantlab.factor.predefined.intraday.session_inputs
      • quantlab.factor.predefined.literature_alpha
        • quantlab.factor.predefined.literature_alpha.LiteratureAlpha
        • quantlab.factor.predefined.literature_alpha.LiteratureAlphaParameters
      • quantlab.factor.predefined.market
        • quantlab.factor.predefined.market.MarketFeatures
      • quantlab.factor.predefined.membership_cap_weight
        • quantlab.factor.predefined.membership_cap_weight.MembershipCapWeight
      • quantlab.factor.predefined.membership_mask
        • quantlab.factor.predefined.membership_mask.MembershipMaskedFactor
      • quantlab.factor.predefined.momentum
        • quantlab.factor.predefined.momentum.Momentum
      • quantlab.factor.predefined.neutralized
        • quantlab.factor.predefined.neutralized.NeutralizedFactor
      • quantlab.factor.predefined.residual_momentum
        • quantlab.factor.predefined.residual_momentum.ResidualMomentumFF3
        • quantlab.factor.predefined.residual_momentum.ResidualMomentumParameters
        • quantlab.factor.predefined.residual_momentum.compound_onto_bars
        • quantlab.factor.predefined.residual_momentum.read_fama_french
      • quantlab.factor.predefined.roster
        • quantlab.factor.predefined.roster.RosterFactor
      • quantlab.factor.predefined.short_horizon
        • quantlab.factor.predefined.short_horizon.ShortHorizonAlpha
      • quantlab.factor.predefined.start_clipped
        • quantlab.factor.predefined.start_clipped.StartClippedFactor
    • quantlab.factor.view
      • quantlab.factor.view.FactorView
  • quantlab.label
    • quantlab.label.config
      • quantlab.label.config.ForwardConfig
    • quantlab.label.forward
      • quantlab.label.forward.Forward
    • quantlab.label.predefined
      • quantlab.label.predefined.fret
        • quantlab.label.predefined.fret.BinaryReturn
        • quantlab.label.predefined.fret.Return
        • quantlab.label.predefined.fret.Volatility
      • quantlab.label.predefined.membership_mask
        • quantlab.label.predefined.membership_mask.MembershipMaskedLabel
        • quantlab.label.predefined.membership_mask.MembershipMaskedLabelConfig
  • quantlab.model
    • quantlab.model.base
      • quantlab.model.base.BaseModel
      • quantlab.model.base.record_training_reads
    • quantlab.model.collected_panel
      • quantlab.model.collected_panel.CollectedPanel
      • quantlab.model.collected_panel.as_feature_dtype
      • quantlab.model.collected_panel.sorted_panel
      • quantlab.model.collected_panel.to_array
    • quantlab.model.config
      • quantlab.model.config.ModelConfig
      • quantlab.model.config.PredictorViewConfig
    • quantlab.model.ensemble
      • quantlab.model.ensemble.BaseEnsemble
      • quantlab.model.ensemble.average_predictions
      • quantlab.model.ensemble.member_correlation
    • quantlab.model.evaluation
      • quantlab.model.evaluation.Segments
      • quantlab.model.evaluation.cross_sectional_ic
      • quantlab.model.evaluation.cross_sectional_ic_series
      • quantlab.model.evaluation.cross_sectional_rank_ic
      • quantlab.model.evaluation.cross_sectional_rank_ic_series
      • quantlab.model.evaluation.evaluate
      • quantlab.model.evaluation.ic_panel_metrics
      • quantlab.model.evaluation.information_ratio
      • quantlab.model.evaluation.mae
      • quantlab.model.evaluation.mse
      • quantlab.model.evaluation.r2
      • quantlab.model.evaluation.rank_autocorrelation_series
      • quantlab.model.evaluation.regression_panel_metrics
      • quantlab.model.evaluation.rmse
      • quantlab.model.evaluation.scores_volatility_level
      • quantlab.model.evaluation.volatility_level_metrics
    • quantlab.model.library_model
      • quantlab.model.library_model.LibraryModel
      • quantlab.model.library_model.Rows
    • quantlab.model.predefined
      • quantlab.model.predefined.catboost_model
        • quantlab.model.predefined.catboost_model.CatBoostRegressor
      • quantlab.model.predefined.double_ensemble
        • quantlab.model.predefined.double_ensemble.DoubleEnsembleBoosters
        • quantlab.model.predefined.double_ensemble.DoubleEnsembleRegressor
        • quantlab.model.predefined.double_ensemble.pct_rank
        • quantlab.model.predefined.double_ensemble.sample_weights
        • quantlab.model.predefined.double_ensemble.select_features
      • quantlab.model.predefined.gats
        • quantlab.model.predefined.gats.GATsNet
        • quantlab.model.predefined.gats.GATsRegressor
      • quantlab.model.predefined.lgbm
        • quantlab.model.predefined.lgbm.LGBMRegressor
      • quantlab.model.predefined.linear
        • quantlab.model.predefined.linear.LinearRegressor
        • quantlab.model.predefined.linear.gram
        • quantlab.model.predefined.linear.lasso_gram
      • quantlab.model.predefined.master
        • quantlab.model.predefined.master.AttentionBlock
        • quantlab.model.predefined.master.Gate
        • quantlab.model.predefined.master.MASTERNet
        • quantlab.model.predefined.master.MASTERRegressor
        • quantlab.model.predefined.master.PositionalEncoding
        • quantlab.model.predefined.master.TemporalAttention
      • quantlab.model.predefined.membership_mask
        • quantlab.model.predefined.membership_mask.MembershipMaskConfig
        • quantlab.model.predefined.membership_mask.MembershipMaskedPredictor
      • quantlab.model.predefined.mlp
        • quantlab.model.predefined.mlp.MLPNet
        • quantlab.model.predefined.mlp.MLPRegressor
      • quantlab.model.predefined.model_ensemble
        • quantlab.model.predefined.model_ensemble.ModelEnsemble
        • quantlab.model.predefined.model_ensemble.ModelEnsembleConfig
      • quantlab.model.predefined.realmlp
        • quantlab.model.predefined.realmlp.RealMLPRegressor
      • quantlab.model.predefined.recorded
        • quantlab.model.predefined.recorded.RecordedPredictor
        • quantlab.model.predefined.recorded.RecordedPredictorConfig
      • quantlab.model.predefined.rnn
        • quantlab.model.predefined.rnn.ALSTMNet
        • quantlab.model.predefined.rnn.ALSTMRegressor
        • quantlab.model.predefined.rnn.GRURegressor
        • quantlab.model.predefined.rnn.LSTMRegressor
        • quantlab.model.predefined.rnn.RNNNet
      • quantlab.model.predefined.seed_ensemble
        • quantlab.model.predefined.seed_ensemble.SeedEnsemble
        • quantlab.model.predefined.seed_ensemble.SeedEnsembleConfig
      • quantlab.model.predefined.smoothed
        • quantlab.model.predefined.smoothed.SmoothedPredictor
        • quantlab.model.predefined.smoothed.SmoothedPredictorConfig
      • quantlab.model.predefined.tcn
        • quantlab.model.predefined.tcn.Chomp1d
        • quantlab.model.predefined.tcn.TCNNet
        • quantlab.model.predefined.tcn.TCNRegressor
        • quantlab.model.predefined.tcn.TemporalBlock
      • quantlab.model.predefined.transformer
        • quantlab.model.predefined.transformer.LocalformerEncoder
        • quantlab.model.predefined.transformer.LocalformerNet
        • quantlab.model.predefined.transformer.LocalformerRegressor
        • quantlab.model.predefined.transformer.PositionalEncoding
        • quantlab.model.predefined.transformer.TransformerNet
        • quantlab.model.predefined.transformer.TransformerRegressor
      • quantlab.model.predefined.xgb
        • quantlab.model.predefined.xgb.XGBoostRegressor
        • quantlab.model.predefined.xgb.boosters_on_cpu
        • quantlab.model.predefined.xgb.ccc_loss_metric
        • quantlab.model.predefined.xgb.ccc_objective
        • quantlab.model.predefined.xgb.pooled_ccc_loss
        • quantlab.model.predefined.xgb.record_feature_importance
      • quantlab.model.predefined.xgb_td
        • quantlab.model.predefined.xgb_td.XGBTDRegressor
    • quantlab.model.split
      • quantlab.model.split.Fold
      • quantlab.model.split.in_sample_window
      • quantlab.model.split.purge_segments
      • quantlab.model.split.split_ranges
      • quantlab.model.split.walk_forward_folds
    • quantlab.model.torch_data
      • quantlab.model.torch_data.Batch
      • quantlab.model.torch_data.CrossSectionDataset
      • quantlab.model.torch_data.IndexBatches
      • quantlab.model.torch_data.SymbolSequenceDataset
      • quantlab.model.torch_data.TrainingPanel
      • quantlab.model.torch_data.batch_loader
      • quantlab.model.torch_data.prefetch
    • quantlab.model.torch_model
      • quantlab.model.torch_model.TorchModel
    • quantlab.model.torch_training
      • quantlab.model.torch_training.TrainLossThreshold
      • quantlab.model.torch_training.cs_rank_norm
      • quantlab.model.torch_training.cs_zscore
      • quantlab.model.torch_training.drop_extreme
      • quantlab.model.torch_training.masked_mse
    • quantlab.model.training_target
      • quantlab.model.training_target.TrainingTargetMixin
    • quantlab.model.view
      • quantlab.model.view.PredictorView
    • quantlab.model.walk_forward_training
      • quantlab.model.walk_forward_training.WalkForwardTrainable
      • quantlab.model.walk_forward_training.cv_mean_metrics
      • quantlab.model.walk_forward_training.fold_config
      • quantlab.model.walk_forward_training.train_walk_forward
  • quantlab.risk
    • quantlab.risk.attribution
      • quantlab.risk.attribution.attribution_summary
      • quantlab.risk.attribution.factor_attribution
    • quantlab.risk.base
      • quantlab.risk.base.FactorRiskForecast
      • quantlab.risk.base.FactorRiskModel
      • quantlab.risk.base.ReturnCovariance
      • quantlab.risk.base.RiskStore
      • quantlab.risk.base.covered_factors
    • quantlab.risk.bias
      • quantlab.risk.bias.bias_statistics
      • quantlab.risk.bias.risk_model_bias_statistics
    • quantlab.risk.config
      • quantlab.risk.config.FactorRiskConfig
      • quantlab.risk.config.Use4RiskConfig
    • quantlab.risk.predefined
      • quantlab.risk.predefined.use4
        • quantlab.risk.predefined.use4.Use4RiskModel
  • quantlab.portfolio
    • quantlab.portfolio.approximate
      • quantlab.portfolio.approximate.LowRankCovariance
      • quantlab.portfolio.approximate.PanelPrices
      • quantlab.portfolio.approximate.PanelSolution
      • quantlab.portfolio.approximate.Stopping
      • quantlab.portfolio.approximate.estimate_all
      • quantlab.portfolio.approximate.implementation
    • quantlab.portfolio.base
      • quantlab.portfolio.base.CovarianceEstimate
      • quantlab.portfolio.base.CovarianceEstimator
      • quantlab.portfolio.base.Decision
      • quantlab.portfolio.base.DecisionPanel
      • quantlab.portfolio.base.ExpectedReturnModel
      • quantlab.portfolio.base.InputDeclaration
      • quantlab.portfolio.base.LowRankCovarianceEstimate
      • quantlab.portfolio.base.PortfolioConstructor
      • quantlab.portfolio.base.PortfolioContext
    • quantlab.portfolio.config
      • quantlab.portfolio.config.ActiveRiskConfig
      • quantlab.portfolio.config.BlackLittermanConfig
      • quantlab.portfolio.config.FactorReturnViewConfig
      • quantlab.portfolio.config.FactorRiskStoreEstimatorConfig
      • quantlab.portfolio.config.GrinoldExpectedReturnConfig
      • quantlab.portfolio.config.LedoitWolfEstimatorConfig
      • quantlab.portfolio.config.MarketReturnViewConfig
      • quantlab.portfolio.config.MeanVarianceConfig
      • quantlab.portfolio.config.PredictionExpectedReturnConfig
      • quantlab.portfolio.config.RawExpectedReturnConfig
      • quantlab.portfolio.config.RelativeFactorReturnViewConfig
      • quantlab.portfolio.config.ReturnViewConfig
      • quantlab.portfolio.config.TopNConfig
      • quantlab.portfolio.config.TopkDropoutConfig
      • quantlab.portfolio.config.UnscaledZScoreExpectedReturnConfig
      • quantlab.portfolio.config.ZScoreExpectedReturnConfig
    • quantlab.portfolio.decision_inputs
      • quantlab.portfolio.decision_inputs.DecisionInputs
      • quantlab.portfolio.decision_inputs.PanelReads
    • quantlab.portfolio.predefined
      • quantlab.portfolio.predefined.active_risk
        • quantlab.portfolio.predefined.active_risk.ActiveRiskOptimizer
      • quantlab.portfolio.predefined.approximate
        • quantlab.portfolio.predefined.approximate.black_litterman
        • quantlab.portfolio.predefined.approximate.covariance
        • quantlab.portfolio.predefined.approximate.mean_variance
        • quantlab.portfolio.predefined.approximate.top_n
        • quantlab.portfolio.predefined.approximate.topk_dropout
      • quantlab.portfolio.predefined.black_litterman
        • quantlab.portfolio.predefined.black_litterman.BlackLittermanOptimizer
        • quantlab.portfolio.predefined.black_litterman.FactorReturnView
        • quantlab.portfolio.predefined.black_litterman.MarketReturnView
        • quantlab.portfolio.predefined.black_litterman.RelativeFactorReturnView
        • quantlab.portfolio.predefined.black_litterman.ReturnView
      • quantlab.portfolio.predefined.expected_return
        • quantlab.portfolio.predefined.expected_return.GrinoldExpectedReturn
        • quantlab.portfolio.predefined.expected_return.PredictionExpectedReturn
        • quantlab.portfolio.predefined.expected_return.RawExpectedReturn
        • quantlab.portfolio.predefined.expected_return.UnscaledZScoreExpectedReturn
        • quantlab.portfolio.predefined.expected_return.ZScoreExpectedReturn
      • quantlab.portfolio.predefined.factor_risk
        • quantlab.portfolio.predefined.factor_risk.FactorRiskStoreEstimator
      • quantlab.portfolio.predefined.ledoit_wolf
        • quantlab.portfolio.predefined.ledoit_wolf.LedoitWolfEstimator
        • quantlab.portfolio.predefined.ledoit_wolf.shrunk_low_rank
      • quantlab.portfolio.predefined.mean_variance
        • quantlab.portfolio.predefined.mean_variance.MeanVarianceInputs
        • quantlab.portfolio.predefined.mean_variance.MeanVarianceOptimizer
      • quantlab.portfolio.predefined.top_n
        • quantlab.portfolio.predefined.top_n.TopNConstructor
      • quantlab.portfolio.predefined.topk_dropout
        • quantlab.portfolio.predefined.topk_dropout.TopkDropoutConstructor
  • quantlab.backtest
    • quantlab.backtest.approximate
      • quantlab.backtest.approximate.ApproximateAccount
      • quantlab.backtest.approximate.ApproximateBacktest
    • quantlab.backtest.base
      • quantlab.backtest.base.BacktestResult
      • quantlab.backtest.base.BaseBacktester
      • quantlab.backtest.base.CVBacktestResult
      • quantlab.backtest.base.MarketSpec
      • quantlab.backtest.base.Predictor
      • quantlab.backtest.base.SimulationResult
      • quantlab.backtest.base.attribution_score_label
      • quantlab.backtest.base.benchmark_display_name
      • quantlab.backtest.base.label_specs
    • quantlab.backtest.config
      • quantlab.backtest.config.ApproximateBacktestConfig
      • quantlab.backtest.config.BacktestConfig
      • quantlab.backtest.config.CrossSectionBacktestConfig
      • quantlab.backtest.config.WeightsBacktestConfig
    • quantlab.backtest.engine_vectorbt
      • quantlab.backtest.engine_vectorbt.VectorBtBacktester
    • quantlab.backtest.live
      • quantlab.backtest.live.LivePrediction
      • quantlab.backtest.live.input_stores
      • quantlab.backtest.live.last_bar
      • quantlab.backtest.live.mirror_new_bars
      • quantlab.backtest.live.predict_live_bar
      • quantlab.backtest.live.ranged_stores
    • quantlab.backtest.predefined
      • quantlab.backtest.predefined.us_equity
        • quantlab.backtest.predefined.us_equity.USEquityApproximateBacktest
        • quantlab.backtest.predefined.us_equity.USEquityCrossectionSelectStockVectorBt
      • quantlab.backtest.predefined.weights
        • quantlab.backtest.predefined.weights.WeightsVectorBt
  • quantlab.api
    • quantlab.api.analyze_factors
    • quantlab.api.backtest
    • quantlab.api.compute_factors
    • quantlab.api.forward_returns
  • API reference
  • quantlab.dataset
  • quantlab.dataset.sharadar
  • quantlab.dataset.sharadar.permatickers
  • quantlab.dataset.sharadar.permatickers.related_spans

quantlab.dataset.sharadar.permatickers.related_spans#

quantlab.dataset.sharadar.permatickers.related_spans(vendor_root, code)[source]#

Return the former tickers TICKERS’ relatedtickers shows, with the security’s price span.

relatedtickers lists, space-separated, a security’s former tickers and also its related securities (other share classes, a SPAC’s units, predecessors), most of them other securities’ tickers. Only a token the security’s current ticker is followed by a number (NSTR of NSTR1) counts: TICKERS appends one when it renames a security whose ticker another took over, so the token was this security’s. It is dated from the security’s first to the day after its last price (open-ended without one), as the rename is not dated.

Parameters:
vendor_rootstr or Path

<download-dir>/sharadar.

codestr

The table whose TICKERS rows are read ("sep").

Returns:
dict

{(former ticker, permaticker): (start, end)}.

Examples

>>> related_spans("/data/downloads/sharadar", "sep")[("NSTR", 173730)]
(datetime.date(2006, 5, 8), datetime.date(2009, 7, 21))

previous

quantlab.dataset.sharadar.permatickers.map_raw_table

next

quantlab.dataset.sharadar.permatickers.ticker_changes

On this page
  • related_spans()
Show Source

© Copyright 2026, Zhaorong Dai.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.23.0.