Coverage for mlos_bench/mlos_bench/storage/sql/__init__.py: 100%

1# 

2# Copyright (c) Microsoft Corporation. 

3# Licensed under the MIT License. 

4# 

5"""Interfaces to the SQL-based storage backends for mlos_bench using `SQLAlchemy 

6<https://www.sqlalchemy.org/>`_. 

7 

8In general any SQL system supported by SQLAlchemy can be used, but the default is a 

9local SQLite instance. 

10 

11Although the schema is defined (and printable) by the 

12:py:mod:`mlos_bench.storage.sql.schema` module so direct queries are possible, users 

13are expected to interact with the data using the 

14:py:class:`~mlos_bench.storage.sql.experiment_data.ExperimentSqlData` and 

15:py:class:`~mlos_bench.storage.sql.trial_data.TrialSqlData` interfaces, which can be 

16obtained from the initial :py:class:`.SqlStorage` instance obtained by 

17:py:func:`mlos_bench.storage.storage_factory.from_config`. 

18 

19Examples 

20-------- 

21TODO: Add example usage. 

22 

23Notes 

24----- 

25See the `mlos_bench/config/storage 

26<https://github.com/microsoft/MLOS/tree/main/mlos_bench/mlos_bench/config/storage>`_ 

27tree for some configuration examples. 

28""" 

29from mlos_bench.storage.sql.storage import SqlStorage 

30 

31__all__ = [ 

32 "SqlStorage", 

33]