A dataset configuration object is used to create or load a dataset.
It is a JSON object that looks like this:
{
"id": <id>,
"type": <type>,
"params": {
<params>
}
}
id
is a string that defines the URL at which the dataset will be available via the REST APItype
is a string that specified the dataset's type (see below)params
is an object that configures the dataset, and whose contents will vary according to the typeNot all three of these fields are required in all contexts:
id
and type
must be specified
id
is specified, MLDB will assume this is a pre-existing dataset and will try to load it (an error will ensue if it doesn't already exist)type
is specified, MLDB will assume that the dataset doesn't exist yet and will try to create it (an error will ensue if it already exists)
type
is specified without id
, an id will be auto-generatedtype
is specified with id
, the dataset will be created with the specified id
unless a dataset already exists with that idtype
is specified, then a corresponding params
function must be specified if the type requires itThe following types of datasets are available:
Type | Description | Doc |
---|---|---|
beh | Memory-mappable dataset type to efficiently store behavioural data | [doc] |
beh.binary | Memory-mappable dataset type to efficiently store binary valued behavioural data | [doc] |
beh.binary.mutable | Recordable dataset designed to store binary valued behavioral data | [doc] |
beh.mutable | Recordable dataset designed to store behavioral data | [doc] |
embedding | Dataset to record a set of coordinates per row | [doc] |
merged | Merges together several datasets into one virtual dataset | [doc] |
mongodb.dataset | Dataset type that forwards records to a MongoDB database | [doc] |
mongodb.record | Dataset type that forwards records to a MongoDB database | [doc] |
sampled | Dataset that samples another dataset | [doc] |
sparse.mutable | Sparse dataset which can be recorded to | [doc] |
sqliteSparse | SQLite-backed fully consistent, persistent, mutable sparse database | [doc] |
tabular | Dense dataset which can be recorded to | [doc] |
transposed | Dataset that interchanges rows and columns | [doc] |
union | Unify together several datasets | [doc] |