Nd4jWorkspace (nd4j-api 1.0.0-beta API)

java.lang.Object
- org.nd4j.linalg.memory.abstracts.Nd4jWorkspace

All Implemented Interfaces:

AutoCloseable, MemoryWorkspace
```
public abstract class Nd4jWorkspace
extends Object
implements MemoryWorkspace
```
Basic implementation for MemoryWorkspace interface, further extended in corresponding backends

Author:

raver119@gmail.com

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Nd4jWorkspace.GarbageWorkspaceReference
- Nested classes/interfaces inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace
  MemoryWorkspace.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`Nd4jWorkspace.GarbageWorkspaceReference`

Field Summary

Fields
Modifier and Type	Field and Description
`protected MemoryWorkspace`	`borrowingWorkspace`
`protected AtomicLong`	`currentSize`
`protected AtomicLong`	`cycleAllocations`
`protected AtomicLong`	`cyclesCount`
`protected int`	`deviceId`
`protected AtomicLong`	`deviceOffset`
`protected AtomicLong`	`disabledCounter`
`protected List<PointersPair>`	`externalAllocations`
`protected AtomicInteger`	`externalCount`
`protected AtomicLong`	`generationId`
`protected String`	`guid`
`protected AtomicLong`	`hostOffset`
`protected String`	`id`
`protected AtomicLong`	`initialBlockSize`
`protected AtomicBoolean`	`isBorrowed`
`protected AtomicBoolean`	`isDebug`
`protected AtomicBoolean`	`isInit`
`protected AtomicBoolean`	`isLearning`
`protected AtomicBoolean`	`isOpen`
`protected AtomicBoolean`	`isOver`
`protected AtomicBoolean`	`isUsed`
`protected AtomicLong`	`lastCycleAllocations`
`protected AtomicLong`	`maxCycle`
`protected MemoryManager`	`memoryManager`
`protected Queue<PointersPair>`	`pinnedAllocations`
`protected AtomicLong`	`pinnedAllocationsSize`
`protected AtomicInteger`	`pinnedCount`
`protected MemoryWorkspace`	`previousWorkspace`
`protected AtomicBoolean`	`resetPlanned`
`protected static long`	`SAFETY_OFFSET`
`protected AtomicLong`	`spilledAllocationsSize`
`protected AtomicLong`	`stepsCount`
`protected int`	`stepsNumber`
`protected AtomicInteger`	`tagScope`
`protected File`	`tempFile`
`protected Long`	`threadId`
`protected AtomicBoolean`	`trimmedMode`
`protected AtomicLong`	`trimmedStep`
`protected PointersPair`	`workspace`
`protected WorkspaceConfiguration`	`workspaceConfiguration`
`protected MemoryWorkspace.Type`	`workspaceType`

Fields inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace
DEFAULT_ID

Constructor Summary

Constructors
Constructor and Description

Nd4jWorkspace(WorkspaceConfiguration configuration)

Nd4jWorkspace(WorkspaceConfiguration configuration, String workspaceId)

Constructors
Constructor and Description
`Nd4jWorkspace(WorkspaceConfiguration configuration)`
`Nd4jWorkspace(WorkspaceConfiguration configuration, String workspaceId)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`PagedPointer`	`alloc(long requiredMemory, DataBuffer.Type type, boolean initialize)`
`PagedPointer`	`alloc(long requiredMemory, MemoryKind kind, DataBuffer.Type type, boolean initialize)`
`protected abstract void`	`clearExternalAllocations()`
`protected abstract void`	`clearPinnedAllocations(boolean extended)`
`void`	`close()`
`void`	`destroyWorkspace()`
`void`	`destroyWorkspace(boolean extended)` This method basically deallocates workspace memory
`void`	`enableDebug(boolean reallyEnable)` This method enabled debugging mode for this workspace
`static void`	`fillFile(File file, long length)`
`void`	`free(org.bytedeco.javacpp.Pointer pointer)`
`long`	`getCurrentSize()` This method returns current amount of memory allocated for workspace.
`long`	`getCyclesCount()`
`long`	`getDeviceOffset()` This method returns current device memory offset within workspace
`long`	`getGenerationId()`
`long`	`getHostOffset()` This method returns current host memory offset within workspace
`long`	`getInitialBlockSize()` This method returns number of bytes for first block of circular workspace.
`long`	`getLastCycleAllocations()` This method returns number of bytes allocated during last full cycle
`long`	`getMaxCycleAllocations()` This method returns number of bytes of biggest cycle
`int`	`getNumberOfExternalAllocations()` This method returns number of spilled allocations, that can be purged at the end of block
`int`	`getNumberOfPinnedAllocations()` This method returns number of pinned allocations, they can be purged after 2 steps.
`MemoryWorkspace`	`getParentWorkspace()` This method returns parent Workspace, if any.
`long`	`getPinnedSize()` This method returns number of bytes in pinned allocations.
`long`	`getSpilledSize()` This method returns number of bytes in spilled allocations.
`long`	`getStepNumber()` This method returns step number.
`long`	`getThisCycleAllocations()` This method returns number of bytes allocated during THIS cycle
`MemoryWorkspace.Type`	`getWorkspaceType()`
`protected void`	`init()`
`void`	`initializeWorkspace()`
`boolean`	`isScopeActive()` This method returns True if scope was opened, and not closed yet.
`MemoryWorkspace`	`notifyScopeBorrowed()` This method TEMPORARY enters this workspace, without reset applied
`MemoryWorkspace`	`notifyScopeEntered()`
`MemoryWorkspace`	`notifyScopeLeft()` This method is shortcut to close() method
`void`	`reset()` This method reset host/device offsets within workspace PLEASE NOTE: Never call this method unless you realize all consequences
`protected abstract void`	`resetWorkspace()`
`MemoryWorkspace`	`tagOutOfScopeUse()`
`void`	`toggleWorkspaceUse(boolean isEnabled)` This method allows to temporary disable this workspace, and issue allocations directly.
`String`	`toString()`

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

Methods inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace
getDeviceId, getId, getThreadId, getWorkspaceConfiguration, setPreviousWorkspace

- Field Detail
  - deviceId
```
protected int deviceId
```
  - threadId
```
protected Long threadId
```
  - workspaceType
```
protected MemoryWorkspace.Type workspaceType
```
  - SAFETY_OFFSET
```
protected static final long SAFETY_OFFSET
```
    See Also:
    
    Constant Field Values
  - id
```
protected String id
```
  - currentSize
```
protected AtomicLong currentSize
```
  - hostOffset
```
protected AtomicLong hostOffset
```
  - deviceOffset
```
protected AtomicLong deviceOffset
```
  - workspace
```
protected PointersPair workspace
```
  - memoryManager
```
protected MemoryManager memoryManager
```
  - isLearning
```
protected AtomicBoolean isLearning
```
  - isUsed
```
protected AtomicBoolean isUsed
```
  - disabledCounter
```
protected AtomicLong disabledCounter
```
  - cyclesCount
```
protected AtomicLong cyclesCount
```
  - stepsCount
```
protected AtomicLong stepsCount
```
  - stepsNumber
```
protected int stepsNumber
```
  - lastCycleAllocations
```
protected AtomicLong lastCycleAllocations
```
  - cycleAllocations
```
protected AtomicLong cycleAllocations
```
  - spilledAllocationsSize
```
protected AtomicLong spilledAllocationsSize
```
  - pinnedAllocationsSize
```
protected AtomicLong pinnedAllocationsSize
```
  - maxCycle
```
protected AtomicLong maxCycle
```
  - resetPlanned
```
protected AtomicBoolean resetPlanned
```
  - isOpen
```
protected AtomicBoolean isOpen
```
  - isInit
```
protected AtomicBoolean isInit
```
  - isOver
```
protected AtomicBoolean isOver
```
  - isBorrowed
```
protected AtomicBoolean isBorrowed
```
  - tagScope
```
protected AtomicInteger tagScope
```
  - isDebug
```
protected AtomicBoolean isDebug
```
  - externalCount
```
protected AtomicInteger externalCount
```
  - pinnedCount
```
protected AtomicInteger pinnedCount
```
  - trimmedMode
```
protected AtomicBoolean trimmedMode
```
  - trimmedStep
```
protected AtomicLong trimmedStep
```
  - workspaceConfiguration
```
protected final WorkspaceConfiguration workspaceConfiguration
```
  - externalAllocations
```
protected List<PointersPair> externalAllocations
```
  - pinnedAllocations
```
protected Queue<PointersPair> pinnedAllocations
```
  - previousWorkspace
```
protected MemoryWorkspace previousWorkspace
```
  - borrowingWorkspace
```
protected MemoryWorkspace borrowingWorkspace
```
  - initialBlockSize
```
protected AtomicLong initialBlockSize
```
  - guid
```
protected String guid
```
  - tempFile
```
protected File tempFile
```
  - generationId
```
protected AtomicLong generationId
```
- Constructor Detail
  - Nd4jWorkspace
```
public Nd4jWorkspace(@NonNull
                     WorkspaceConfiguration configuration)
```
  - Nd4jWorkspace
```
public Nd4jWorkspace(@NonNull
                     WorkspaceConfiguration configuration,
                     @NonNull
                     String workspaceId)
```
- Method Detail
  - getWorkspaceType
```
public MemoryWorkspace.Type getWorkspaceType()
```
    Specified by:
    
    getWorkspaceType in interface MemoryWorkspace
  - fillFile
```
public static void fillFile(File file,
                            long length)
                     throws Exception
```
    Throws:
    
    Exception
  - getGenerationId
```
public long getGenerationId()
```
    Specified by:
    
    getGenerationId in interface MemoryWorkspace
  - getStepNumber
```
public long getStepNumber()
```
    This method returns step number. Viable only in circular mode.
    
    Returns:
  - getSpilledSize
```
public long getSpilledSize()
```
    This method returns number of bytes in spilled allocations.
    
    Returns:
  - getPinnedSize
```
public long getPinnedSize()
```
    This method returns number of bytes in pinned allocations.
    
    Returns:
  - getInitialBlockSize
```
public long getInitialBlockSize()
```
    This method returns number of bytes for first block of circular workspace.
    
    Returns:
  - getParentWorkspace
```
public MemoryWorkspace getParentWorkspace()
```
    This method returns parent Workspace, if any. Null if there's none.
    
    Specified by:
    
    getParentWorkspace in interface MemoryWorkspace
    
    Returns:
  - getDeviceOffset
```
public long getDeviceOffset()
```
    This method returns current device memory offset within workspace
    
    Returns:
  - getHostOffset
```
public long getHostOffset()
```
    This method returns current host memory offset within workspace
    
    Returns:
  - getCurrentSize
```
public long getCurrentSize()
```
    This method returns current amount of memory allocated for workspace. PLEASE NOTE: It shows only amount of HOST memory. If current backend assumes DEVICE/HOST memory pair, DEVICE memory will probably have the same size, but won't be accounted in this value.
    
    Specified by:
    
    getCurrentSize in interface MemoryWorkspace
    
    Returns:
  - init
```
protected void init()
```
  - alloc
```
public PagedPointer alloc(long requiredMemory,
                          DataBuffer.Type type,
                          boolean initialize)
```
    Specified by:
    
    alloc in interface MemoryWorkspace
  - enableDebug
```
public void enableDebug(boolean reallyEnable)
```
    This method enabled debugging mode for this workspace
    
    Specified by:
    
    enableDebug in interface MemoryWorkspace
    
    Parameters:
    
    reallyEnable -
  - alloc
```
public PagedPointer alloc(long requiredMemory,
                          MemoryKind kind,
                          DataBuffer.Type type,
                          boolean initialize)
```
    Specified by:
    
    alloc in interface MemoryWorkspace
  - free
```
public void free(org.bytedeco.javacpp.Pointer pointer)
```
  - initializeWorkspace
```
public void initializeWorkspace()
```
    Specified by:
    
    initializeWorkspace in interface MemoryWorkspace
  - getNumberOfExternalAllocations
```
public int getNumberOfExternalAllocations()
```
    This method returns number of spilled allocations, that can be purged at the end of block
    
    Returns:
  - getNumberOfPinnedAllocations
```
public int getNumberOfPinnedAllocations()
```
    This method returns number of pinned allocations, they can be purged after 2 steps. PLEASE NOTE: This method can return non-zero calues only for circular workspace mode
    
    Returns:
  - destroyWorkspace
```
public void destroyWorkspace()
```
    Specified by:
    
    destroyWorkspace in interface MemoryWorkspace
  - destroyWorkspace
```
public void destroyWorkspace(boolean extended)
```
    This method basically deallocates workspace memory
    
    Specified by:
    
    destroyWorkspace in interface MemoryWorkspace
    
    Parameters:
    
    extended -
  - notifyScopeBorrowed
```
public MemoryWorkspace notifyScopeBorrowed()
```
    This method TEMPORARY enters this workspace, without reset applied
    
    Specified by:
    
    notifyScopeBorrowed in interface MemoryWorkspace
    
    Returns:
  - getCyclesCount
```
public long getCyclesCount()
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface MemoryWorkspace
  - clearPinnedAllocations
```
protected abstract void clearPinnedAllocations(boolean extended)
```
  - clearExternalAllocations
```
protected abstract void clearExternalAllocations()
```
  - notifyScopeEntered
```
public MemoryWorkspace notifyScopeEntered()
```
    Specified by:
    
    notifyScopeEntered in interface MemoryWorkspace
  - reset
```
public void reset()
```
    This method reset host/device offsets within workspace PLEASE NOTE: Never call this method unless you realize all consequences
  - resetWorkspace
```
protected abstract void resetWorkspace()
```
  - notifyScopeLeft
```
public MemoryWorkspace notifyScopeLeft()
```
    This method is shortcut to close() method
    
    Specified by:
    
    notifyScopeLeft in interface MemoryWorkspace
    
    Returns:
  - toggleWorkspaceUse
```
public void toggleWorkspaceUse(boolean isEnabled)
```
    This method allows to temporary disable this workspace, and issue allocations directly.
    
    Specified by:
    
    toggleWorkspaceUse in interface MemoryWorkspace
    
    Parameters:
    
    isEnabled -
  - getLastCycleAllocations
```
public long getLastCycleAllocations()
```
    This method returns number of bytes allocated during last full cycle
    
    Specified by:
    
    getLastCycleAllocations in interface MemoryWorkspace
    
    Returns:
  - getThisCycleAllocations
```
public long getThisCycleAllocations()
```
    This method returns number of bytes allocated during THIS cycle
    
    Specified by:
    
    getThisCycleAllocations in interface MemoryWorkspace
    
    Returns:
  - getMaxCycleAllocations
```
public long getMaxCycleAllocations()
```
    This method returns number of bytes of biggest cycle
    
    Specified by:
    
    getMaxCycleAllocations in interface MemoryWorkspace
    
    Returns:
  - isScopeActive
```
public boolean isScopeActive()
```
    This method returns True if scope was opened, and not closed yet.
    
    Specified by:
    
    isScopeActive in interface MemoryWorkspace
    
    Returns:
  - tagOutOfScopeUse
```
public MemoryWorkspace tagOutOfScopeUse()
```
    Specified by:
    
    tagOutOfScopeUse in interface MemoryWorkspace
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Nd4jWorkspace

Nested Class Summary

Nested classes/interfaces inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace

Field Summary

Fields inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace

Field Detail

deviceId

threadId

workspaceType

SAFETY_OFFSET

id

currentSize

hostOffset

deviceOffset

workspace

memoryManager

isLearning

isUsed

disabledCounter

cyclesCount

stepsCount

stepsNumber

lastCycleAllocations

cycleAllocations

spilledAllocationsSize

pinnedAllocationsSize

maxCycle

resetPlanned

isOpen

isInit

isOver

isBorrowed

tagScope

isDebug

externalCount

pinnedCount

trimmedMode

trimmedStep

workspaceConfiguration

externalAllocations

pinnedAllocations

previousWorkspace

borrowingWorkspace

initialBlockSize

guid

tempFile

generationId

Constructor Detail

Nd4jWorkspace

Nd4jWorkspace

Method Detail

getWorkspaceType

fillFile

getGenerationId

getStepNumber

getSpilledSize

getPinnedSize

getInitialBlockSize

getParentWorkspace

getDeviceOffset

getHostOffset

getCurrentSize

init

alloc

enableDebug

alloc

free

initializeWorkspace

getNumberOfExternalAllocations

getNumberOfPinnedAllocations

destroyWorkspace

destroyWorkspace

notifyScopeBorrowed

getCyclesCount

close

clearPinnedAllocations