Struct burn::data::dataset::SqliteDataset

pub struct SqliteDataset<I> { /* private fields */ }

This struct represents a dataset where all items are stored in an SQLite database. Each instance of this struct corresponds to a specific table within the SQLite database, and allows for interaction with the data stored in the table in a structured and typed manner.

The SQLite database must contain a table with the same name as the split field. This table should have a primary key column named row_id, which is used to index the rows in the table. The row_id should start at 1, while the corresponding dataset index should start at 0, i.e., row_id = index + 1.

Table columns can be represented in two ways:

1. The table can have a column for each field in the I struct. In this case, the column names in the table should match the field names of the I struct. The field names can be a subset of column names and can be in any order.

For the supported field types, refer to:

• Serialization field types
• SQLite data types

2. The fields in the I struct can be serialized into a single column item in the table. In this case, the table should have a single column named item of type BLOB. This is useful when the I struct contains complex fields that cannot be mapped to a SQLite type, such as nested structs, vectors, etc. The serialization is done using MessagePack.

Note: The code automatically figures out which of the above two cases is applicable, and uses the appropriate method to read the data from the table.

Implementations

impl<I> SqliteDataset<I>

pub fn from_db_file<P>( db_file: P, split: &str, ) -> Result<SqliteDataset<I>, SqliteDatasetError>

where P: AsRef<Path>,

Initializes a SqliteDataset from a SQLite database file and a split name.

pub fn db_file(&self) -> PathBuf

Get the database file name.

pub fn split(&self) -> &str

Get the split name.

Trait Implementations

impl<I> Dataset<I> for SqliteDataset<I>

where I: Clone + Send + Sync + DeserializeOwned,

fn get(&self, index: usize) -> Option<I>

Get an item from the dataset.

fn len(&self) -> usize

Return the number of rows in the dataset.

fn is_empty(&self) -> bool

Checks if the dataset is empty.

fn iter(&self) -> DatasetIterator<'_, I>

where Self: Sized,

Returns an iterator over the dataset.

fn windows(&self, size: usize) -> WindowDataset<'_, I>

where Self: Sized,

Returns a new Dataset of all the windows of length size. The windows overlap. Is empty if the input Dataset is shorter than size.

impl<I> Debug for SqliteDataset<I>

where I: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.