diff options
| -rw-r--r-- | src/README.md | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md index 5d0dcb0..48a0c5b 100644 --- a/src/README.md +++ b/src/README.md @@ -61,4 +61,130 @@ and generating plots. # Internal header files +## crossbar_generator.h +Handles generation of the SPICE netlist used to simulate the memristive crossbar. + +* **Crossbar_Config struct** + * Stores the configuration needed to generate a crossbar netlist + * members + * size_t rows + * size_t columns + * const double *input_series + * size_t num_samples + * const double *initial_resistance + * double load_resistance + * const char *model_path + * const char *subcircuit_name + * double time_step + * double stop_time + * int print_state_nodes + +* **generate_crossbar() (int)** + * Generates the SPICE crossbar netlist using the passed Crossbar_Config + * parameters + * const char *output_filename + * const Crossbar_Config *config + + +## spires_interface.h + +Handles communication between SPIRES and the crossbar simulation, including +collecting reservoir states and mapping trained weights to resistances. + +* **Reservoir_State_Matrix struct** + * Stores the collected reservoir states in a flat row-major array + * members + * size_t num_samples + * size_t num_features + * double *states + +* **conductance_mapping struct** + * Stores the values used to map software readout weights to crossbar + conductances and later decode the crossbar outputs + * members + * double g_min + * double g_max + * double alpha + * double max_abs_weight + +* **collect_reservoir_states() (int)** + * Runs the input series through the SPIRES reservoir and saves the state of + every neuron at every timestep + * parameters + * spires_reservoir *reservoir + * const double *input_series + * size_t series_length + * Reservoir_State_Matrix *result + +* **convert_weights_to_resistances() (int)** + * Converts the trained SPIRES readout weights into differential-pair + resistances for the crossbar + * parameters + * const spires_reservoir *reservoir + * size_t num_neurons + * size_t num_outputs + * double r_on + * double r_off + * double **resistances_out + * conductance_mapping *mapping + +* **train_reservoir() (int)** + * Wrapper around SPIRES ridge regression training + * parameters + * spires_reservoir *reservoir + * double *input_series + * double *target_series + * size_t series_length + * double lambda + +* **free_reservoir_state_matrix() (void)** + * Frees the memory allocated for a Reservoir_State_Matrix + * parameters + * Reservoir_State_Matrix *matrix + + +## read_crossbar.h + +Handles running ngspice, reading the generated simulation data, and decoding the +crossbar voltages back into software predictions. + +* **Crossbar_Output_Matrix struct** + * Stores the output voltages read from the ngspice simulation + * members + * size_t num_samples + * size_t num_outputs + * double *time + * double *voltages + +* **run_ngspice() (int)** + * Runs ngspice in batch mode on the generated crossbar netlist + * parameters + * const char *crossbar_path + +* **read_crossbar() (int)** + * Reads the ngspice output data file into a Crossbar_Output_Matrix + * parameters + * const char *data_path + * size_t num_outputs + * Crossbar_Output_Matrix *result + +* **convert_output_to_software() (int)** + * Decodes the differential-pair crossbar voltages back into the equivalent + software readout predictions + * parameters + * size_t num_neurons + * size_t num_outputs + * size_t num_timesteps + * const double *voltages + * const double *resistances + * double load_resistance + * const conductance_mapping *mapping + * const double *row_voltages + * double spike_amplitude + * double *decoded_outputs + +* **free_crossbar_output_matrix() (void)** + * Frees the memory allocated for a Crossbar_Output_Matrix + * parameters + * Crossbar_Output_Matrix *result |