sf_quant.research.get_signal_distribution

sf_quant.research.get_signal_distribution(signal: DataFrame, column: str = 'signal') → None

Plot the distribution of a signal column as a histogram.

Parameters

signalpl.DataFrame

DataFrame containing the signal column

columnstr, default “signal”

Name of the column to plot

Examples

>>> import polars as pl
>>> import sf_quant.research as sfr
>>> signal_df = pl.DataFrame({
...     'signal': [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0]
... })
>>> sfr.signal_distribution(signal_df, column='signal')
# Displays a histogram plot of the signal values