ContextHolder (nd4j-jcublas-7.5 0.4-rc3.7 API)

java.lang.Object
- org.nd4j.linalg.jcublas.context.ContextHolder

```
public class ContextHolder
extends Object
```
A multithreaded version derived from the cuda launcher util by the authors of jcuda. This class handles managing cuda contexts across multiple devices and threads.

Author:

Adam Gibson

Field Summary

Fields
Modifier and Type Field and Description

static String DEVICES_TO_BAN

Fields
Modifier and Type	Field and Description
`static String`	`DEVICES_TO_BAN`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configure()` Configure the given information based on the device
`static CUdevice`	`createDevice(CUcontext context, int deviceNumber)` Create a context for the given device
`void`	`destroy()` Shutdown this instance
`int`	`deviceNum()` Get the number of devices
`DeviceConfiguration`	`getConf()` Get the configuration for the current device and thread
`DeviceConfiguration`	`getConf(int device)` Get the configuration the given device
`CUcontext`	`getContext()` Retrieve a context for use with the current thread and the given device
`CUcontext`	`getContext(int deviceToUse)` Retrieve a context for use with the current thread and the given device
`cudaStream_t`	`getCudaStream()` Get the stream for the current thread based on the device for the thread
`GpuInformation`	`getCurrentGpuInformation()` Returns the gpu diagnostics for the current thread
`int`	`getDeviceForThread()` Get the device number for a particular host thread
`Map<Integer,CUcontext>`	`getDeviceIDContexts()` Returns the available contexts based on device and thread name
`Map<Integer,CUdevice>`	`getDevices()` Returns the available devices delimited by device,thread
`GpuInformation`	`getGpuInfo(int device)` Returns the gpu diagnostics for the given device
`cublasHandle`	`getHandle()` Get the handle for the current thread
`org.apache.commons.pool2.ObjectPool<cublasHandle>`	`getHandlePool()`
`Map<Integer,GpuInformation>`	`getInfo()`
`GpuInformation`	`getInfoFor(int cUdevice)` Get the information for a particular device
`static ContextHolder`	`getInstance()` Singleton pattern
`MemoryStrategy`	`getMemoryStrategy()` Get the memory strategy for the current thread and device
`int`	`getNumThreads(Op op)`
`org.apache.commons.pool2.ObjectPool<cudaStream_t>`	`getOldStreamPool()`
`CUstream`	`getStream()` Get the stream for the current thread based on the device for the thread
`org.apache.commons.pool2.ObjectPool<CUstream>`	`getStreamPool()`
`Map<String,Integer>`	`getThreads()`
`void`	`setContext()`
`void`	`setNumDevices(int numDevices)`
`static void`	`syncStream()` Synchronized the stream.

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

- Field Detail
  - DEVICES_TO_BAN
```
public static final String DEVICES_TO_BAN
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static ContextHolder getInstance()
```
    Singleton pattern
    
    Returns:
    
    the instance for the context holder.
  - getHandlePool
```
public org.apache.commons.pool2.ObjectPool<cublasHandle> getHandlePool()
```
  - getStreamPool
```
public org.apache.commons.pool2.ObjectPool<CUstream> getStreamPool()
```
  - getOldStreamPool
```
public org.apache.commons.pool2.ObjectPool<cudaStream_t> getOldStreamPool()
```
  - getNumThreads
```
public int getNumThreads(Op op)
```
  - getThreads
```
public Map<String,Integer> getThreads()
```
  - deviceNum
```
public int deviceNum()
```
    Get the number of devices
    
    Returns:
    
    the number of devices
  - getConf
```
public DeviceConfiguration getConf()
```
    Get the configuration for the current device and thread
    
    Returns:
    
    the current configuration for the given device and thread
  - getMemoryStrategy
```
public MemoryStrategy getMemoryStrategy()
```
    Get the memory strategy for the current thread and device
    
    Returns:
  - configure
```
public void configure()
```
    Configure the given information based on the device
  - setNumDevices
```
public void setNumDevices(int numDevices)
```
  - getCurrentGpuInformation
```
public GpuInformation getCurrentGpuInformation()
```
    Returns the gpu diagnostics for the current thread
    
    Returns:
  - getGpuInfo
```
public GpuInformation getGpuInfo(int device)
```
    Returns the gpu diagnostics for the given device
    
    Parameters:
    
    device - the device to get the gpu diagnostics for
    
    Returns:
  - getInfo
```
public Map<Integer,GpuInformation> getInfo()
```
  - getConf
```
public DeviceConfiguration getConf(int device)
```
    Get the configuration the given device
    
    Parameters:
    
    device - the device to get the configuration for
    
    Returns:
    
    the device configuration
  - setContext
```
public void setContext()
```
  - syncStream
```
public static void syncStream()
```
    Synchronized the stream. This should be run after every operation.
  - getDeviceForThread
```
public int getDeviceForThread()
```
    Get the device number for a particular host thread
    
    Returns:
    
    the device for the given host thread
  - getHandle
```
public cublasHandle getHandle()
```
    Get the handle for the current thread
    
    Returns:
    
    the handle for the current thread
  - getContext
```
public CUcontext getContext()
```
    Retrieve a context for use with the current thread and the given device
    
    Returns:
    
    the context for the given device and thread
  - getCudaStream
```
public cudaStream_t getCudaStream()
```
    Get the stream for the current thread based on the device for the thread
    
    Returns:
    
    the stream for the device and thread
  - getStream
```
public CUstream getStream()
```
    Get the stream for the current thread based on the device for the thread
    
    Returns:
    
    the stream for the device and thread
  - getContext
```
public CUcontext getContext(int deviceToUse)
```
    Retrieve a context for use with the current thread and the given device
    
    Parameters:
    
    deviceToUse - the device to use
    
    Returns:
    
    the t
  - createDevice
```
public static CUdevice createDevice(CUcontext context,
                                    int deviceNumber)
```
    Create a context for the given device
    
    Parameters:
    
    context - the context to create
    
    deviceNumber - the device number to create the context for
    
    Returns:
    
    the created device
  - getInfoFor
```
public GpuInformation getInfoFor(int cUdevice)
```
    Get the information for a particular device
    
    Parameters:
    
    cUdevice - the device to get the info for
    
    Returns:
    
    the information for a particular device
  - getDevices
```
public Map<Integer,CUdevice> getDevices()
```
    Returns the available devices delimited by device,thread
    
    Returns:
    
    the available devices
  - getDeviceIDContexts
```
public Map<Integer,CUcontext> getDeviceIDContexts()
```
    Returns the available contexts based on device and thread name
    
    Returns:
    
    the context
  - destroy
```
public void destroy()
```
    Shutdown this instance

Class ContextHolder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEVICES_TO_BAN

Method Detail

getInstance

getHandlePool

getStreamPool

getOldStreamPool

getNumThreads

getThreads

deviceNum

getConf

getMemoryStrategy

configure

setNumDevices

getCurrentGpuInformation

getGpuInfo

getInfo

getConf

setContext

syncStream

getDeviceForThread

getHandle

getContext

getCudaStream

getStream

getContext

createDevice

getInfoFor

getDevices

getDeviceIDContexts

destroy