Skip to content

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.


See Also

run_experiment

Run a backtest experiment with the provided configuration.

query_strategy_runs

Return every per-strategy result for a given experiment.


Example

>>> from backtide.storage import query_experiments

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

                 id                 name  ... best_sharpe n_strategies
0  e647e8b213b44f6e  Apple and Microsoft  ...    0.739076            1
1  d94eed792875472b      test experiment  ...    0.609946            1
2  761ffb497cf34aba      Test experiment  ...    0.607657            3

[3 rows x 10 columns]