API Reference
Complete reference for the SPIRES C API defined in spires.h. All public symbols are listed below, grouped by category.
Status Codes
| Symbol | Description |
|---|---|
spires_status | Return code enum used by most API functions. |
Enums
| Symbol | Description |
|---|---|
spires_connectivity_type | Network topology selector (random, small-world, scale-free). |
spires_neuron_type | Neuron model selector (LIF variants and fractional-order models). |
Configuration
| Symbol | Description |
|---|---|
spires_reservoir_config | Struct that fully specifies a reservoir before creation. |
Lifecycle
| Symbol | Description |
|---|---|
spires_reservoir_create | Allocate and initialize a reservoir from a configuration struct. |
spires_reservoir_destroy | Free all memory associated with a reservoir. |
spires_reservoir_reset | Reset neuron states to zero without reallocating. |
Stepping
| Symbol | Description |
|---|---|
spires_step | Advance the reservoir by one timestep given an input vector. |
spires_run | Drive the reservoir with an entire input time series. |
Training
| Symbol | Description |
|---|---|
spires_train_ridge | Batch-train output weights via ridge regression. |
spires_train_online | Update output weights with one online learning step. |
State Access
| Symbol | Description |
|---|---|
spires_copy_reservoir_state | Return a heap-allocated copy of the current neuron state vector. |
spires_read_reservoir_state | Copy the current neuron state into a caller-provided buffer. |
spires_compute_output | Compute the readout output from the current reservoir state. |
Introspection
| Symbol | Description |
|---|---|
spires_num_neurons | Return the number of neurons in the reservoir. |
spires_num_inputs | Return the number of input channels. |
spires_num_outputs | Return the number of output channels. |
Optimizer
| Symbol | Description |
|---|---|
spires_optimize | Run the AGILE hyperparameter optimizer over a data set. |
spires_opt_budget | Struct defining a single budget stage for the optimizer. |
spires_opt_score | Struct controlling the scoring metric and regularization. |
spires_opt_result | Struct returned by the optimizer containing the best configuration found. |
Last updated on