Reference API

conn2res.tasks - Task dataset fetchers

Functionality for fetching task datasets

conn2res.tasks.NeuroGymTask(*args, **kwargs)	Class for generating task datasets from the Neurogym repository
conn2res.tasks.ReservoirPyTask(*args, **kwargs)	Class for generating task datasets from the ReservoirPy repository
conn2res.tasks.Conn2ResTask(*args, **kwargs)	Class for generating task datasets from the ReservoirPy repository

conn2res.connectivity - Connectivity data handling

Functionality for connectivity matrix

conn2res.connectivity.Conn([filename, ...])

Class that represents a connectivity matrix representing either weighted or unweighted connectivity data

conn2res.reservoir - Reservoir objects

Functionality for simulating reservoirs

conn2res.reservoir.Reservoir(w)	Class that represents a general Reservoir object
conn2res.reservoir.EchoStateNetwork(*args[, ...])	Class that represents an Echo State Network
conn2res.reservoir.MemristiveReservoir(w, ...)	Class that represents a general Memristive Reservoir
conn2res.reservoir.MSSNetwork([vA, vB, tc, ...])	Class that represents a Metastable Switch Memristive network (see Nugent and Molter, 2014 for details)

conn2res.readout - Readout module

Functionality to train readout module

conn2res.readout.Readout([estimator, y])

_summary_

conn2res.readout.train_test_split(*args[, ...])	Splits data into training and test sets according to 'frac_train'
conn2res.readout.select_model(y)	_summary_
conn2res.readout.regressor(*args, **kwargs)	_summary_
conn2res.readout.classifier(*args, **kwargs)	_summary_
conn2res.readout.multioutput_regressor(...)	_summary_
conn2res.readout.multioutput_classifier(...)	_summary_
conn2res.readout.multiclass_classifier(...)	_summary_

conn2res.performance - Performance metrics

Functions to measure learning performance

conn2res.performance.r2_score(y_true, y_pred)	Coefficient of determination of the regression R^2.
conn2res.performance.mean_squared_error(...)	Mean squared error.
conn2res.performance.root_mean_squared_error(...)	Root mean squared error.
conn2res.performance.mean_absolute_error(...)	Mean absolute error.
conn2res.performance.corrcoef(y_true, y_pred)	Pearson's correlation coefficient.
conn2res.performance.accuracy_score(y_true, ...)	Accuracy score.
conn2res.performance.balanced_accuracy_score(...)	Balance accuracy score.
conn2res.performance.f1_score(y_true, y_pred)	F1-score.
conn2res.performance.precision_score(y_true, ...)	Precision score.
conn2res.performance.recall_score(y_true, y_pred)	Recall score.

conn2res.plotting - Plotting functions

Plotting functions

conn2res.plotting.transform_data(data[, ...])	#TODO _summary_
conn2res.plotting.plot_iodata(x, y[, ...])	Plot input (x) and output (y) data.
conn2res.plotting.plot_reservoir_states(x, ...)	Plot simulated reservoir states.
conn2res.plotting.plot_diagnostics(x, y, ...)	Plot decision function of readout module.
conn2res.plotting.plot_performance(df[, x, ...])	Plot performance curve.
conn2res.plotting.plot_phase_space(x, y[, ...])	Plot phase space diagram