query_experiments

function backtide.storage.query_experiments(experiment_id=None, search=None, limit=None)

Return stored experiments, optionally filtered by id and/or a search string.

The search parameter does a case-insensitive substring match on experiment name and tags. When both experiment_id and search are given they are combined with AND semantics. Rows are returned ordered by started_at desc, so limit=3 returns the last 3 experiments.

Parameters	experiment_id : str \| list[str] \| None, default=None One or more experiment ids to filter on. `None` (default) ignores this filter. search : str \| None, default=None Substring matched against experiment name and tags. `None` returns every experiment. limit : int \| None, default=None Maximum number of rows to return. `None` means no limit.
Returns	pd.DataFrame \| pl.DataFrame One row per experiment.

Example

>>> from backtide.storage import query_experiments

>>> df = query_experiments()
>>> print(df.head())

                 id             name icon  ...   status best_sharpe  n_strategies
0  bc4e9165fe114ceb         a413448d       ...  Success    0.742765             1
1  4decc2558b7e43cd  test experiment       ...  Success    0.609767             1
2  1a39ea4724a549a0  Test experiment       ...  Success    0.611857             3

[3 rows x 10 columns]