API reference

• engine: Differentiable engine
• functional: Functions and functionals
  • activation: Activation functions
  • cmass: Centre of mass
  • connectopy: Connectopic manifolds
  • cov: Covariances and correlations
  • fourier: Frequency-domain filter
  • graph: Graphs and networks
  • interpolate: Interpolation and imputation
  • kernel: Parameterised kernels
  • matrix: Matrix operations
  • residualise
  • semidefinite: Positive semidefinite cone
  • sparse: Sparse matrix operations
  • sphere: Spherical coordinates
  • sylo: Sylo function
  • symmap: Symmetric matrix maps
  • tsconv: Time series convolution
  • utils: Miscellaneous
  • window: Random windowing
• init: Initialisation schemes
  • atlas: Atlas initialisation
  • atlasmixins: Atlas mixins
  • base: Base initialisations
  • deltaplus
  • dirichlet
  • freqfilter: Frequency band init
  • iirfilter: IIR filter init
  • laplace
  • mapparam: Mapped parameters and parameter maps
  • mpbl
  • semidefinite
  • sylo
  • toeplitz
• loss: Loss and regularisation
  • Loss: Base class for scalar-valued losses
  • ParameterisedLoss: Extensible class for custom parameterised losses
  • MSELoss: Mean squared error
  • NormedLoss: Normed parameter regularisation
  • identity: Identity function
  • zero: Zero function
  • difference: Elementwise difference
  • constraint_violation: Soft constraints
  • unilateral_loss: Unilateral penalties
  • hinge_loss: SVM hinge loss
  • smoothness: Backwards differences
  • bimodal_symmetric: Minimal distance from 2 modes
  • det_gram: Gramian determinant
  • log_det_gram: Gram log-determinant loss
  • entropy: Categorical entropy
  • kl_divergence: Kullback-Leibler divergence
  • js_divergence: Jensen-Shannon divergence
  • bregman_divergence: Bregman divergences
  • equilibrium: Equilibrium loss
  • second_moment: Second moments
  • auto_tol: Significance tolerance
  • batch_corr: Batch-axis correlation
  • qcfc: QC-FC measures and loss
  • reference_tether: Spatial tether to reference points
  • interhemispheric_tether: Inter-hemispheric tethering loss
  • compactness: Compactness
  • dispersion: Vector dispersion
  • multivariate_kurtosis: Time series stationarity
  • connectopy: Generalised connectopy
  • modularity: Relaxed modularity
  • sum_scalarise: Sum scalarisation
  • mean_scalarise: Mean scalarisation
  • meansq_scalarise: Squared mean scalarisation
  • max_scalarise: Maximum-value scalarisation
  • norm_scalarise: Norm scalarisation
  • vnorm_scalarise: Vector norm scalarisation
  • wmean_scalarise: Weighted mean scalarisation
  • selfwmean_scalarise: Self-weighted mean scalarisation
  • LossApply: Selectively apply loss to parameters
  • LossScheme: Scheme for multiple losses
• neuro: Neuroscience data utilities
  • synth: Data synthesis
• nn: Neural network modules
  • activation: Activation functions as modules
  • atlas: Atlas layers
  • cov: Covariance modules
  • freqfilter: Frequency-domain filter layer
  • iirfilter: IIR filter layer
  • interpolate: Interpolation layers
  • recombinator
  • Residualise
  • semidefinite
  • SPDNoise
  • SVM
  • sylo
  • vertcom: Vertex compression
  • WindowAmplifier