tensorflow::Options Struct Reference

#include <TensorFlow.h>

Public Member Functions
Backend	getBackend () const
int	getNThreads () const
SessionOptions &	getSessionOptions ()
	Options (Backend backend)
	Options ()
void	setBackend (Backend backend=Backend::cpu)
void	setThreading (int nThreads=1)

Public Attributes
Backend	_backend
int	_nThreads
SessionOptions	_options

Detailed Description

Definition at line 33 of file TensorFlow.h.

Constructor & Destructor Documentation

Options() [1/2]

tensorflow::Options::Options ( Backend  backend )

inline

Definition at line 38 of file TensorFlow.h.

                             : _nThreads{1}, _backend{backend} {
      setThreading(_nThreads);
      setBackend(_backend);
    };

Options() [2/2]

tensorflow::Options::Options ( )

inline

Definition at line 43 of file TensorFlow.h.

              : _nThreads{1}, _backend{Backend::cpu} {
      setThreading(_nThreads);
      setBackend(_backend);
    };

Member Function Documentation

getBackend()

Backend tensorflow::Options::getBackend ( ) const

inline

Definition at line 57 of file TensorFlow.h.

References _backend.

{ return _backend; };

getNThreads()

int tensorflow::Options::getNThreads ( ) const

inline

Definition at line 56 of file TensorFlow.h.

References _nThreads.

{ return _nThreads; };

getSessionOptions()

SessionOptions& tensorflow::Options::getSessionOptions ( )

inline

Definition at line 55 of file TensorFlow.h.

References _options.

{ return _options; };

setBackend()

void tensorflow::Options::setBackend

(

Backend

backend = Backend::cpu

)

Definition at line 22 of file TensorFlow.cc.

References _options, cms::Exception::addContext(), HLT_2024v13_cff::backend, tensorflow::best, tensorflow::cpu, tensorflow::cuda, tensorflow::intel, edm::ResourceInformation::nvidiaDriverVersion(), tensorflow::rocm, and edm::errors::UnavailableAccelerator.

                                          {
    /*
     * The TensorFlow backend configures the available devices using options provided in the sessionOptions proto.
     * // Options from https://github.com/tensorflow/tensorflow/blob/c53dab9fbc9de4ea8b1df59041a5ffd3987328c3/tensorflow/core/protobuf/config.proto
     *
     * If the device_count["GPU"] = 0 GPUs are not used. 
     * The visible_device_list configuration is used to map the `visible` devices (from CUDA_VISIBLE_DEVICES) to `virtual` devices.
     * If Backend::cpu is request, the GPU device is disallowed by device_count configuration.
     * If Backend::cuda is request:
     *  - if ResourceInformation shows an available Nvidia GPU device:
     *     the device is used with memory_growth configuration (not allocating all cuda memory at once).
     *  - if no device is present: an exception is raised.
     */

    edm::Service<edm::ResourceInformation> ri;
    if (backend == Backend::cpu) {
      // disable GPU usage
      (*_options.config.mutable_device_count())["GPU"] = 0;
      _options.config.mutable_gpu_options()->set_visible_device_list("");
    }
    // NVidia GPU
    else if (backend == Backend::cuda) {
      if (not ri->nvidiaDriverVersion().empty()) {
        // Check if one GPU device is visible to TF
        // If not, an exception is raised --> this can happen in case of driver version mismatch
        // or missing CUDA support in TF compilation
        if ((*_options.config.mutable_device_count())["GPU"] == 0) {
          edm::Exception ex(edm::errors::UnavailableAccelerator);
          ex << "Cuda backend requested, NVIDIA GPU visible to cmssw, but not visible to TensorFlow in the job";
          ex.addContext("Calling tensorflow::setBackend()");
          throw ex;
        }
        // Take only the first GPU in the CUDA_VISIBLE_DEVICE list
        (*_options.config.mutable_device_count())["GPU"] = 1;
        _options.config.mutable_gpu_options()->set_visible_device_list("0");
        // Do not allocate all the memory on the GPU at the beginning.
        _options.config.mutable_gpu_options()->set_allow_growth(true);
      } else {
        edm::Exception ex(edm::errors::UnavailableAccelerator);
        ex << "Cuda backend requested, but no NVIDIA GPU available in the job";
        ex.addContext("Calling tensorflow::setBackend()");
        throw ex;
      }
    }
    // ROCm and Intel GPU are still not supported
    else if ((backend == Backend::rocm) || (backend == Backend::intel)) {
      edm::Exception ex(edm::errors::UnavailableAccelerator);
      ex << "ROCm/Intel GPU backend requested, but TF is not compiled yet for this platform";
      ex.addContext("Calling tensorflow::setBackend()");
      throw ex;
    }
    // Get NVidia GPU if possible or fallback to CPU
    else if (backend == Backend::best) {
      // Check if a Nvidia GPU is availabl
      if (not ri->nvidiaDriverVersion().empty()) {
        // Take only the first GPU in the CUDA_VISIBLE_DEVICE list
        (*_options.config.mutable_device_count())["GPU"] = 1;
        _options.config.mutable_gpu_options()->set_visible_device_list("0");
        // Do not allocate all the memory on the GPU at the beginning.
        _options.config.mutable_gpu_options()->set_allow_growth(true);
      } else {
        // Just CPU support
        (*_options.config.mutable_device_count())["GPU"] = 0;
        _options.config.mutable_gpu_options()->set_visible_device_list("");
      }
    }
  }

setThreading()

void tensorflow::Options::setThreading

(

int

nThreads = 1

)

Definition at line 15 of file TensorFlow.cc.

References _nThreads, and _options.

                                         {
    _nThreads = nThreads;
    // set number of threads used for intra and inter operation communication
    _options.config.set_intra_op_parallelism_threads(nThreads);
    _options.config.set_inter_op_parallelism_threads(nThreads);
  }

Member Data Documentation

_backend

Backend tensorflow::Options::_backend

Definition at line 35 of file TensorFlow.h.

Referenced by getBackend().

_nThreads

int tensorflow::Options::_nThreads

Definition at line 34 of file TensorFlow.h.

Referenced by getNThreads(), and setThreading().

_options

SessionOptions tensorflow::Options::_options

Definition at line 36 of file TensorFlow.h.

Referenced by getSessionOptions(), setBackend(), and setThreading().