org.nd4j.linalg.memory.provider

Class BasicWorkspaceManager

java.lang.Object

org.nd4j.linalg.memory.provider.BasicWorkspaceManager

All Implemented Interfaces:

MemoryWorkspaceManager

public abstract class BasicWorkspaceManager
extends Object
implements MemoryWorkspaceManager

Workspace manager implementation. Please note, this class is supposed to be used via Nd4j.getWorkspaceManager(), to provide consistency between different threads within given JVM process

Author:

[email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BasicWorkspaceManager.WorkspaceDeallocatorThread

Field Summary

Fields

Modifier and Type	Field and Description
protected ThreadLocal<Map<String,MemoryWorkspace>>	backingMap
protected AtomicLong	counter
protected org.nd4j.linalg.primitives.SynchronizedObject<DebugMode>	debugMode
protected WorkspaceConfiguration	defaultConfiguration
static String	WorkspaceDeallocatorThreadName Deprecated.

Constructor Summary

Constructors

Constructor and Description
BasicWorkspaceManager()
BasicWorkspaceManager(WorkspaceConfiguration defaultConfiguration)

Method Summary

Modifier and Type	Method and Description
boolean	anyWorkspaceActiveForCurrentThread()
boolean	checkIfWorkspaceExists(String id) This method checks, if Workspace with a given Id was created before this call
boolean	checkIfWorkspaceExistsAndActive(String id)
void	destroyAllWorkspacesForCurrentThread() This method destroys all workspaces allocated in current thread
void	destroyWorkspace() This method destroy default workspace, if any
void	destroyWorkspace(MemoryWorkspace workspace) This method destroys given workspace
protected void	ensureThreadExistense()
List<MemoryWorkspace>	getAllWorkspacesForCurrentThread()
List<String>	getAllWorkspacesIdsForCurrentThread()
MemoryWorkspace	getAndActivateWorkspace() This method gets & activates default workspace
MemoryWorkspace	getAndActivateWorkspace(String id) This method gets & activates workspace with a given Id
MemoryWorkspace	getAndActivateWorkspace(WorkspaceConfiguration configuration, String id) This method gets & activates default with a given configuration and Id
DebugMode	getDebugMode()
String	getUUID() Returns globally unique ID
MemoryWorkspace	getWorkspaceForCurrentThread() This method will return workspace with default configuration and default id.
MemoryWorkspace	getWorkspaceForCurrentThread(String id)
protected void	pickReference(MemoryWorkspace workspace)
void	printAllocationStatisticsForCurrentThread() This method prints out basic statistics for workspaces allocated in current thread
MemoryWorkspace	scopeOutOfWorkspaces() This method temporary opens block out of any workspace scope.
void	setDebugMode(DebugMode mode)
void	setDefaultWorkspaceConfiguration(WorkspaceConfiguration configuration) This method allows to specify "Default" configuration, that will be used in signatures which do not have WorkspaceConfiguration argument
void	setWorkspaceForCurrentThread(MemoryWorkspace workspace)
void	setWorkspaceForCurrentThread(MemoryWorkspace workspace, String id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

createNewWorkspace, createNewWorkspace, createNewWorkspace, createNewWorkspace, getWorkspaceForCurrentThread

Field Detail

counter

protected AtomicLong counter

defaultConfiguration

protected WorkspaceConfiguration defaultConfiguration

backingMap

protected ThreadLocal<Map<String,MemoryWorkspace>> backingMap

debugMode

protected org.nd4j.linalg.primitives.SynchronizedObject<DebugMode> debugMode

WorkspaceDeallocatorThreadName

@Deprecated
public static final String WorkspaceDeallocatorThreadName

Deprecated.

See Also:

Constant Field Values

Constructor Detail

BasicWorkspaceManager

public BasicWorkspaceManager()

BasicWorkspaceManager

public BasicWorkspaceManager(@NonNull
                             WorkspaceConfiguration defaultConfiguration)

Method Detail

getUUID

public String getUUID()

Returns globally unique ID

Specified by:

getUUID in interface MemoryWorkspaceManager

Returns:

setDefaultWorkspaceConfiguration

public void setDefaultWorkspaceConfiguration(@NonNull
                                             WorkspaceConfiguration configuration)

This method allows to specify "Default" configuration, that will be used in signatures which do not have WorkspaceConfiguration argument

Specified by:

setDefaultWorkspaceConfiguration in interface MemoryWorkspaceManager

Parameters:

configuration -

getWorkspaceForCurrentThread

public MemoryWorkspace getWorkspaceForCurrentThread()

This method will return workspace with default configuration and default id.

Specified by:

getWorkspaceForCurrentThread in interface MemoryWorkspaceManager

Returns:

getWorkspaceForCurrentThread

public MemoryWorkspace getWorkspaceForCurrentThread(@NonNull
                                                    String id)

Specified by:

getWorkspaceForCurrentThread in interface MemoryWorkspaceManager

getDebugMode

public DebugMode getDebugMode()

Specified by:

getDebugMode in interface MemoryWorkspaceManager

setDebugMode

public void setDebugMode(DebugMode mode)

Specified by:

setDebugMode in interface MemoryWorkspaceManager

pickReference

protected void pickReference(MemoryWorkspace workspace)

setWorkspaceForCurrentThread

public void setWorkspaceForCurrentThread(MemoryWorkspace workspace)

Specified by:

setWorkspaceForCurrentThread in interface MemoryWorkspaceManager

setWorkspaceForCurrentThread

public void setWorkspaceForCurrentThread(@NonNull
                                         MemoryWorkspace workspace,
                                         @NonNull
                                         String id)

Specified by:

setWorkspaceForCurrentThread in interface MemoryWorkspaceManager

destroyWorkspace

public void destroyWorkspace(MemoryWorkspace workspace)

This method destroys given workspace

Specified by:

destroyWorkspace in interface MemoryWorkspaceManager

Parameters:

workspace -

destroyWorkspace

public void destroyWorkspace()

This method destroy default workspace, if any

Specified by:

destroyWorkspace in interface MemoryWorkspaceManager

destroyAllWorkspacesForCurrentThread

public void destroyAllWorkspacesForCurrentThread()

This method destroys all workspaces allocated in current thread

Specified by:

destroyAllWorkspacesForCurrentThread in interface MemoryWorkspaceManager

ensureThreadExistense

protected void ensureThreadExistense()

getAndActivateWorkspace

public MemoryWorkspace getAndActivateWorkspace()

This method gets & activates default workspace

Specified by:

getAndActivateWorkspace in interface MemoryWorkspaceManager

Returns:

getAndActivateWorkspace

public MemoryWorkspace getAndActivateWorkspace(@NonNull
                                               String id)

This method gets & activates workspace with a given Id

Specified by:

getAndActivateWorkspace in interface MemoryWorkspaceManager

Parameters:

id -

Returns:

getAndActivateWorkspace

public MemoryWorkspace getAndActivateWorkspace(@NonNull
                                               WorkspaceConfiguration configuration,
                                               @NonNull
                                               String id)

This method gets & activates default with a given configuration and Id

Specified by:

getAndActivateWorkspace in interface MemoryWorkspaceManager

Parameters:

configuration -

id -

Returns:

checkIfWorkspaceExists

public boolean checkIfWorkspaceExists(@NonNull
                                      String id)

This method checks, if Workspace with a given Id was created before this call

Specified by:

checkIfWorkspaceExists in interface MemoryWorkspaceManager

Parameters:

id -

Returns:

checkIfWorkspaceExistsAndActive

public boolean checkIfWorkspaceExistsAndActive(@NonNull
                                               String id)

Specified by:

checkIfWorkspaceExistsAndActive in interface MemoryWorkspaceManager

scopeOutOfWorkspaces

public MemoryWorkspace scopeOutOfWorkspaces()

This method temporary opens block out of any workspace scope.

PLEASE NOTE: Do not forget to close this block.

Specified by:

scopeOutOfWorkspaces in interface MemoryWorkspaceManager

Returns:

printAllocationStatisticsForCurrentThread

public void printAllocationStatisticsForCurrentThread()

This method prints out basic statistics for workspaces allocated in current thread

Specified by:

printAllocationStatisticsForCurrentThread in interface MemoryWorkspaceManager

getAllWorkspacesIdsForCurrentThread

public List<String> getAllWorkspacesIdsForCurrentThread()

Specified by:

getAllWorkspacesIdsForCurrentThread in interface MemoryWorkspaceManager

getAllWorkspacesForCurrentThread

public List<MemoryWorkspace> getAllWorkspacesForCurrentThread()

Specified by:

getAllWorkspacesForCurrentThread in interface MemoryWorkspaceManager

anyWorkspaceActiveForCurrentThread

public boolean anyWorkspaceActiveForCurrentThread()

Specified by:

anyWorkspaceActiveForCurrentThread in interface MemoryWorkspaceManager