Reference

# Module `core.NetworkParam`

Encapsulates network parameters.

## Functions

NetworkParam.new_number (name, tooltip, get, set, min, max) | Creates a new NumberParam.
NetworkParam.new_option (name, tooltip, get, set, options) | Creates a new OptionParam.
NetworkParam.new_readonly (name, tooltip, get) | Creates a new ReadOnlyParam.

## Tables

NumberParam | Representation of a training parameter
OptionParam | Representation of a training parameter
ReadOnlyParam | Representation of a network read-only parameter

## Functions

NetworkParam.new_number (name, tooltip, get, set, min, max)
  Creates a new NumberParam.

  ### Parameters

  - name: Human-readable name of the parameter
  - tooltip: Description of the parameter
  - get: The getter function
  - set: The setter function
  - min: Lower bound of the param value
  - max: Upper bound of the param value

  ### Return value:

  New NumberParam
NetworkParam.new_option (name, tooltip, get, set, options)
  Creates a new OptionParam.

  ### Parameters

  - name: Human-readable name of the parameter
  - tooltip: Description of the parameter
  - get: The getter function
  - set: The setter function
  - options: A (shared, will not be copied) table in the form { {names}, {values} } with the possible options

  ### Return value:

  New OptionParam
NetworkParam.new_readonly (name, tooltip, get)
  Creates a new ReadOnlyParam.

  ### Parameters

  - name: Human-readable name of the parameter
  - tooltip: Description of the parameter
  - get: The getter function

  ### Return value:

  New ReadOnlyParam

## Tables

NumberParam
  Representation of a training parameter

  ### Parameters

  - type: Type of the parameter ("number")
  - name: The (human-readable) name of the parameter
  - tooltip: Description of the parameter
  - get: The getter function (acts on a fann.Net object)
  - set: The setter function (acts on a fann.Net object)
  - min: Lower bound of the param value
  - max: Upper bound of the param value
OptionParam
  Representation of a training parameter

  ### Parameters

  - type: Type of the parameter ("option")
  - name: The (human-readable) name of the parameter
  - tooltip: Description of the parameter
  - get: The getter function (acts on a fann.Net object)
  - set: The setter function (acts on a fann.Net object)
  - values: Table with {name, value} for the valid options
ReadOnlyParam
  Representation of a network read-only parameter

  ### Parameters

  - type: Type of the parameter ("readonly")
  - name: The (human-readable) name of the parameter
  - tooltip: Description of the parameter
  - get: The getter function (acts on a fann.Net object)