package owl-base

  1. Overview
  2. Docs
package owl-base
Legend:
Library
Module
Module type
Parameter
Class
Class type
type neuron_typ = {
  1. mutable axis : int;
  2. mutable beta : t;
  3. mutable gamma : t;
  4. mutable mu : t;
  5. mutable var : t;
  6. mutable decay : t;
  7. mutable training : bool;
  8. mutable in_shape : int array;
  9. mutable out_shape : int array;
}

Neuron type definition.

val create : ?training:bool -> ?decay:float -> ?mu:arr -> ?var:arr -> int -> neuron_typ

Create the neuron.

val connect : int array -> neuron_typ -> unit

Connect this neuron to others in a neural network.

val init : neuron_typ -> unit

Initialise the neuron and its parameters.

val reset : neuron_typ -> unit

Reset the parameters in a neuron.

val mktag : int -> neuron_typ -> unit

Tag the neuron, used by ``Algodiff`` module.

val mkpar : neuron_typ -> t array

Assemble all the parameters in an array, used by ``Optimise`` module.

val mkpri : neuron_typ -> t array

Assemble all the primial values in an array, used by ``Optimise`` module.

val mkadj : neuron_typ -> t array

Assemble all the adjacent values in an array, used by ``Optimise`` module.

val update : neuron_typ -> t array -> unit

Update parameters in a neuron, used by ``Optimise`` module.

val copy : neuron_typ -> neuron_typ

Make a deep copy of the neuron and its parameters.

val run : t -> neuron_typ -> t

Execute the computation in this neuron.

val to_string : neuron_typ -> string

Convert the neuron to its string representation. The string is often a summary of the parameters defined in the neuron.

val to_name : unit -> string

Return the name of the neuron.