BaseParameterUpdater (deeplearning4j 1.0.0-beta7 API)

java.lang.Object
- org.nd4j.parameterserver.updater.BaseParameterUpdater

All Implemented Interfaces:

ParameterServerUpdater

Direct Known Subclasses:

SoftSyncParameterUpdater, SynchronousParameterUpdater, TimeDelayedParameterUpdater
```
public abstract class BaseParameterUpdater
extends Object
implements ParameterServerUpdater
```
Base class for the parameter updater handling things such as update storage and basic operations like reset and number of updates

Author:

Adam Gibson

Field Summary

Fields
Modifier and Type Field and Description

protected NDArrayHolder ndArrayHolder

protected UpdateStorage updateStorage

Fields
Modifier and Type	Field and Description
`protected NDArrayHolder`	`ndArrayHolder`
`protected UpdateStorage`	`updateStorage`

Constructor Summary

Constructors
Constructor and Description
`BaseParameterUpdater()` Initializes this updater with `InMemoryUpdateStorage`
`BaseParameterUpdater(UpdateStorage updateStorage)` Initialize this updater with a custom update storage
`BaseParameterUpdater(UpdateStorage updateStorage, NDArrayHolder ndArrayHolder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isAsync()` Returns true if the given updater is async or synchronous updates
`boolean`	`isReady()` Returns true if the updater is ready for a new array
`NDArrayHolder`	`ndArrayHolder()` Get the ndarray holder for this updater
`int`	`numUpdates()` Num updates passed through the updater
`void`	`reset()` Reset internal counters such as number of updates accumulated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nd4j.parameterserver.updater.ParameterServerUpdater
partialUpdate, requiredUpdatesForPass, shouldReplicate, status, toJson, update, update

- Field Detail
  - updateStorage
```
protected UpdateStorage updateStorage
```
  - ndArrayHolder
```
protected NDArrayHolder ndArrayHolder
```
- Constructor Detail
  - BaseParameterUpdater
```
public BaseParameterUpdater(UpdateStorage updateStorage,
                            NDArrayHolder ndArrayHolder)
```
  - BaseParameterUpdater
```
public BaseParameterUpdater(UpdateStorage updateStorage)
```
    Initialize this updater with a custom update storage
    
    Parameters:
    
    updateStorage - the update storage to use
  - BaseParameterUpdater
```
public BaseParameterUpdater()
```
    Initializes this updater with InMemoryUpdateStorage
- Method Detail
  - isReady
```
public boolean isReady()
```
    Returns true if the updater is ready for a new array
    
    Specified by:
    
    isReady in interface ParameterServerUpdater
    
    Returns:
  - isAsync
```
public boolean isAsync()
```
    Returns true if the given updater is async or synchronous updates
    
    Specified by:
    
    isAsync in interface ParameterServerUpdater
    
    Returns:
    
    true if the given updater is async or synchronous updates
  - ndArrayHolder
```
public NDArrayHolder ndArrayHolder()
```
    Get the ndarray holder for this updater
    
    Specified by:
    
    ndArrayHolder in interface ParameterServerUpdater
    
    Returns:
    
    the ndarray holder for this updater
  - reset
```
public void reset()
```
    Reset internal counters such as number of updates accumulated.
    
    Specified by:
    
    reset in interface ParameterServerUpdater
  - numUpdates
```
public int numUpdates()
```
    Num updates passed through the updater
    
    Specified by:
    
    numUpdates in interface ParameterServerUpdater
    
    Returns:
    
    the number of updates

Class BaseParameterUpdater

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.nd4j.parameterserver.updater.ParameterServerUpdater

Field Detail

updateStorage

ndArrayHolder

Constructor Detail

BaseParameterUpdater

BaseParameterUpdater

BaseParameterUpdater

Method Detail

isReady

isAsync

ndArrayHolder

reset

numUpdates