Skip to main content

Apply

In SuperDuperDB there are three fundamental base components which you'll use for almost all functionality:

In addition there is an overarching component:

which in some sense "rules them all"

Whenever you wish to apply AI to your data, you will instantiate one of more of these, and "apply" these to your connection:

db.apply(component)

Base components​

Model​

A Model is a wrapper around a standard ML/ AI model. It may contain additional functionality, such as pre- and post-processing, and encoding/ decoding data into/ from the correct type required by the database.

db.apply(model) tells SuperDuperDB to store the model and its metadata in the system.

If additional configurations, such as training parameters, are added to the Model then the db.apply command will also train the component on data in SuperDuperDB.

Read more about Model here.

Listener​

A Listener wraps a Model. The db.apply(listener) tells SuperDuperDB to "listen" for incoming data and to compute outputs on those data, saving them back in SuperDuperDB.

Read more about Listener here.

VectorIndex​

A VectorIndex wraps one or two Listener components, and tells SuperDuperDB that the outputs computed, should be made searchable via vector-search queries.

Read more about VectorIndex here.

Connecting component: Stack​

A Stack of AI functionality is a combination of multiple Model, Listener, and VectorIndex components which may be "applied" in one pass to your data via SuperDuperDB.

On db.add(stack) SuperDuperDB performs the heavy lifting of deciding which components need to be applied first, which need to be modified on incoming data, and which outputs need to be made searchable.

Read more about Stack here.

View applied components​

Use db.show to view components.

View all components:

>>> db.show()
[
  {'type_id': 'model', 'identifier': 'my-model'},
  {'type_id': 'model', 'identifier': 'my-other-model'}
]

View all components of a certain type:

>>> db.show('<type_id>')
['my-model', 'my-other-model']

View all versions of a particular component:

>>> db.show('<type_id>', '<component_identifier>')
[0, 1, 2, 3]

Reloading applied components​

When components are applied with db.apply(component), the component is provided with a version, which may be optionally used to reload the component. By default the latest version is reloaded:

reloaded = db.load('<type_id>', '<component_identifier>')
reloaded = db.load('<type_id>', '<component_identifier>', <version>)

For example to reload a model, identified by 'my-model', the first version added:

reloaded_model = db.load('model', 'my-model', 0)

Read more​

Read more about the "apply" API here.