Ivory
MODULE

IVORY.CALLBACKS.RESULTS

</>

A container to store training, validation and test results.

Classes
  • Results — Results callback stores training, validation and test results.</>
  • BatchResults — Results callback stores training, validation and test results.</>
Functions
class

ivory.callbacks.results.Results()

</>
Bases
ivory.core.collections.Dict ivory.core.state.State

Results callback stores training, validation and test results.

Each result is ivory.core.collections.Dict type that has index, output, and target array.

To get target array of validation, use

target = results.val.target
Attributes
  • index —
  • output —
  • target —
  • test (Dict) — Test results.
  • train (Dict) — Train results.
  • val (Dict) — Validation results.
Methods
  • mean() (Results) — Returns a reduced Results instance aveaged by index.</>
method

mean() → Results

</>

Returns a reduced Results instance aveaged by index.

class

ivory.callbacks.results.BatchResults()

</>
Bases
ivory.callbacks.results.Results ivory.core.collections.Dict ivory.core.state.State

Results callback stores training, validation and test results.

Each result is ivory.core.collections.Dict type that has index, output, and target array.

To get target array of validation, use

target = results.val.target
Attributes
  • index —
  • indexes —
  • output —
  • outputs —
  • target —
  • targets —
  • test (Dict) — Test results.
  • train (Dict) — Train results.
  • val (Dict) — Validation results.
Methods
  • mean() (Results) — Returns a reduced Results instance aveaged by index.</>
method

mean() → Results

</>

Returns a reduced Results instance aveaged by index.

function

ivory.callbacks.results.concatenate(iterable, callback=None, modes=('val', 'test'), reduction='none') → Results

</>

Returns a concatenated Results.

Parameters
  • iterable (iterable of Results) — Iterable of Results instance.
  • callback (callable, optional) — Called for each Results. Must take (mode, index, output, target) arguments and return a tuple of ('index', output, target).
  • modes (iterable of str) — Specify modes to concatenate.
  • reduction (str, optional) — Reduction. none or mean.