tensorflow Namespace Reference

Classes
class	NoThreadPool
struct	Options
struct	SessionCache
class	TBBThreadPool

Typedefs
typedef std::pair< std::string, Tensor >	NamedTensor
typedef std::vector< NamedTensor >	NamedTensorList

Enumerations
enum	Backend {   Backend::cpu, Backend::cuda, Backend::rocm, Backend::intel,   Backend::best }

Functions
bool	checkEmptyInputs (const NamedTensorList &inputs)
bool	closeSession (Session *&session)
bool	closeSession (const Session *&session)
Session *	createSession ()
Session *	createSession (Options &options)
Session *	createSession (const MetaGraphDef *metaGraphDef, const std::string &exportDir, Options &options)
Session *	createSession (const GraphDef *graphDef)
Session *	createSession (const GraphDef *graphDef, Options &options)
GraphDef *	loadGraphDef (const std::string &pbFile)
MetaGraphDef *	loadMetaGraph (const std::string &exportDir, const std::string &tag, Options &Options)
MetaGraphDef *	loadMetaGraphDef (const std::string &exportDir, const std::string &tag=kSavedModelTagServe)
MetaGraphDef *	loadMetaGraphDef (const std::string &exportDir, const std::string &tag, Options &options)
void	run (Session *session, const NamedTensorList &inputs, const std::vector< std::string > &outputNames, std::vector< Tensor > *outputs, const thread::ThreadPoolOptions &threadPoolOptions)
void	run (const Session *session, const NamedTensorList &inputs, const std::vector< std::string > &outputNames, std::vector< Tensor > *outputs, const thread::ThreadPoolOptions &threadPoolOptions)
void	run (Session *session, const NamedTensorList &inputs, const std::vector< std::string > &outputNames, std::vector< Tensor > *outputs, thread::ThreadPoolInterface *threadPool)
void	run (const Session *session, const NamedTensorList &inputs, const std::vector< std::string > &outputNames, std::vector< Tensor > *outputs, thread::ThreadPoolInterface *threadPool)
void	run (Session *session, const NamedTensorList &inputs, const std::vector< std::string > &outputNames, std::vector< Tensor > *outputs, const std::string &threadPoolName="no_threads")
void	run (const Session *session, const NamedTensorList &inputs, const std::vector< std::string > &outputNames, std::vector< Tensor > *outputs, const std::string &threadPoolName="no_threads")
void	run (Session *session, const std::vector< std::string > &outputNames, std::vector< Tensor > *outputs, const std::string &threadPoolName="no_threads")
void	run (const Session *session, const std::vector< std::string > &outputNames, std::vector< Tensor > *outputs, const std::string &threadPoolName="no_threads")
void	setLogging (const std::string &level="3")

Typedef Documentation

NamedTensor

typedef std::pair<std::string, Tensor> tensorflow::NamedTensor

Definition at line 30 of file TensorFlow.h.

NamedTensorList

typedef std::vector<NamedTensor> tensorflow::NamedTensorList

Definition at line 31 of file TensorFlow.h.

Enumeration Type Documentation

Backend

enum tensorflow::Backend

strong

Enumerator
cpu
cuda
rocm
intel
best

Definition at line 28 of file TensorFlow.h.

{ cpu, cuda, rocm, intel, best };

Function Documentation

checkEmptyInputs()

bool tensorflow::checkEmptyInputs

(

const NamedTensorList &

inputs

)

Definition at line 259 of file TensorFlow.cc.

References input, and PixelMapPlotter::inputs.

Referenced by run().

                                                       {
    // check for empty tensors in the inputs
    bool isEmpty = false;
    for (const auto& input : inputs) {
      // Checking using the shape
      if (input.second.shape().num_elements() == 0) {
        isEmpty = true;
        break;
      }
    }
    return isEmpty;
  }

closeSession() [1/2]

bool tensorflow::closeSession

(

Session *&

session

)

Definition at line 234 of file TensorFlow.cc.

References mps_update::status.

Referenced by closeSession(), tensorflow::SessionCache::closeSession(), DTOccupancyTestML::dqmEndLuminosityBlock(), GEDPhotonProducer::endStream(), GsfElectronProducer::endStream(), L2TauNNProducerAlpaka::globalEndJob(), L2TauNNProducer::globalEndJob(), BaseMVACache::~BaseMVACache(), BJetTFCache::~BJetTFCache(), reco::DeepSCGraphEvaluation::~DeepSCGraphEvaluation(), deep_tau::DeepTauCache::~DeepTauCache(), DisplacedRegionSeedingVertexProducer::~DisplacedRegionSeedingVertexProducer(), PtAssignmentEngineDxy::~PtAssignmentEngineDxy(), TfGraphDefWrapper::~TfGraphDefWrapper(), and TSGForOIDNN::~TSGForOIDNN().

                                       {
    if (session == nullptr) {
      return true;
    }

    // close and delete the session
    Status status = session->Close();
    delete session;

    // reset the pointer
    session = nullptr;

    return status.ok();
  }

closeSession() [2/2]

bool tensorflow::closeSession

(

const Session *&

session

)

Definition at line 249 of file TensorFlow.cc.

References closeSession(), and alignCSCRings::s.

                                             {
    auto s = const_cast<Session*>(session);
    bool state = closeSession(s);

    // reset the pointer
    session = nullptr;

    return state;
  }

createSession() [1/5]

Session * tensorflow::createSession

(

)

Definition at line 137 of file TensorFlow.cc.

Referenced by BaseMVACache::BaseMVACache(), BJetTFCache::BJetTFCache(), PtAssignmentEngineDxy::configure(), createSession(), tensorflow::SessionCache::createSession(), deep_tau::DeepTauCache::DeepTauCache(), DisplacedRegionSeedingVertexProducer::DisplacedRegionSeedingVertexProducer(), DTOccupancyTestML::dqmEndLuminosityBlock(), egammaTools::EgammaDNNHelper::getSessions(), HGCalConcentratorAutoEncoderImpl::HGCalConcentratorAutoEncoderImpl(), L2TauNNProducerAlpaka::initializeGlobalCache(), L2TauNNProducer::initializeGlobalCache(), reco::DeepSCGraphEvaluation::initTensorFlowGraphAndSession(), TfGraphDefProducer::produce(), and TSGForOIDNN::TSGForOIDNN().

                           {
    Options default_options{};
    return createSession(default_options);
  }

createSession() [2/5]

Session * tensorflow::createSession

(

Options &

options

)

Definition at line 142 of file TensorFlow.cc.

References Exception, and mps_update::status.

                                           {
    // objects to create the session
    Status status;

    // create a new, empty session
    Session* session = nullptr;
    status = NewSession(options.getSessionOptions(), &session);
    if (!status.ok()) {
      throw cms::Exception("InvalidSession") << "error while creating session: " << status.ToString();
    }

    return session;
  }

createSession() [3/5]

Session * tensorflow::createSession	(	const MetaGraphDef *	metaGraphDef,
		const std::string &	exportDir,
		Options &	options
	)

Definition at line 156 of file TensorFlow.cc.

References createSession(), cms::soa::RestrictQualify::Default, Exception, convertSQLiteXML::ok, mps_update::status, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                                         {
    // check for valid pointer
    if (metaGraphDef == nullptr) {
      throw cms::Exception("InvalidMetaGraphDef") << "error while creating session: metaGraphDef is nullptr";
    }

    // check that the graph has nodes
    if (metaGraphDef->graph_def().node_size() <= 0) {
      throw cms::Exception("InvalidMetaGraphDef") << "error while creating session: graphDef has no nodes";
    }

    Session* session = createSession(options);

    // add the graph def from the meta graph
    Status status;
    status = session->Create(metaGraphDef->graph_def());
    if (!status.ok()) {
      throw cms::Exception("InvalidMetaGraphDef")
          << "error while attaching metaGraphDef to session: " << status.ToString();
    }

    // restore variables using the variable and index files in the export directory
    // first, find names and paths
    std::string varFileTensorName = metaGraphDef->saver_def().filename_tensor_name();
    std::string restoreOpName = metaGraphDef->saver_def().restore_op_name();
    std::string varDir = io::JoinPath(exportDir, kSavedModelVariablesDirectory);
    std::string indexFile = io::JoinPath(varDir, MetaFilename(kSavedModelVariablesFilename));
    std::string varFile = io::JoinPath(varDir, kSavedModelVariablesFilename);

    // when the index file is missing, there's nothing to do
    if (!Env::Default()->FileExists(indexFile).ok()) {
      return session;
    }

    // create a tensor to store the variable file
    Tensor varFileTensor(DT_STRING, TensorShape({}));
    varFileTensor.scalar<tensorflow::tstring>()() = varFile;

    // run the restore op
    status = session->Run({{varFileTensorName, varFileTensor}}, {}, {restoreOpName}, nullptr);
    if (!status.ok()) {
      throw cms::Exception("InvalidSession") << "error while restoring variables in session: " << status.ToString();
    }

    return session;
  }

createSession() [4/5]

Session * tensorflow::createSession

(

const GraphDef *

graphDef

)

Definition at line 203 of file TensorFlow.cc.

References createSession().

                                                   {
    Options default_options{};
    return createSession(graphDef, default_options);
  }

createSession() [5/5]

Session * tensorflow::createSession	(	const GraphDef *	graphDef,
		Options &	options
	)

Definition at line 208 of file TensorFlow.cc.

References createSession(), Exception, and mps_update::status.

                                                                     {
    // check for valid pointer
    if (graphDef == nullptr) {
      throw cms::Exception("InvalidGraphDef") << "error while creating session: graphDef is nullptr";
    }

    // check that the graph has nodes
    if (graphDef->node_size() <= 0) {
      throw cms::Exception("InvalidGraphDef") << "error while creating session: graphDef has no nodes";
    }

    // create a new, empty session
    Session* session = createSession(options);

    // add the graph def
    Status status;
    status = session->Create(*graphDef);

    // check for success
    if (!status.ok()) {
      throw cms::Exception("InvalidSession") << "error while attaching graphDef to session: " << status.ToString();
    }

    return session;
  }

loadGraphDef()

GraphDef * tensorflow::loadGraphDef

(

const std::string &

pbFile

)

Definition at line 120 of file TensorFlow.cc.

References cms::soa::RestrictQualify::Default, Exception, and mps_update::status.

Referenced by BaseMVACache::BaseMVACache(), PtAssignmentEngineDxy::configure(), tensorflow::SessionCache::createSession(), deep_tau::DeepTauCache::DeepTauCache(), DisplacedRegionSeedingVertexProducer::DisplacedRegionSeedingVertexProducer(), DTOccupancyTestML::dqmEndLuminosityBlock(), HGCalConcentratorAutoEncoderImpl::HGCalConcentratorAutoEncoderImpl(), L2TauNNProducerAlpaka::initializeGlobalCache(), L2TauNNProducer::initializeGlobalCache(), reco::DeepSCGraphEvaluation::initTensorFlowGraphAndSession(), egammaTools::EgammaDNNHelper::initTensorFlowGraphs(), TfGraphDefProducer::produce(), and TSGForOIDNN::TSGForOIDNN().

                                                  {
    // objects to load the graph
    Status status;

    // load it
    GraphDef* graphDef = new GraphDef();
    status = ReadBinaryProto(Env::Default(), pbFile, graphDef);

    // check for success
    if (!status.ok()) {
      throw cms::Exception("InvalidGraphDef")
          << "error while loading graphDef from '" << pbFile << "': " << status.ToString();
    }

    return graphDef;
  }

loadMetaGraph()

MetaGraphDef * tensorflow::loadMetaGraph	(	const std::string &	exportDir,
		const std::string &	tag,
		Options &	Options
	)

Definition at line 113 of file TensorFlow.cc.

References loadMetaGraphDef(), and makeGlobalPositionRcd_cfg::tag.

                                                                                                  {
    edm::LogInfo("PhysicsTools/TensorFlow")
        << "tensorflow::loadMetaGraph() is deprecated, use tensorflow::loadMetaGraphDef() instead";

    return loadMetaGraphDef(exportDir, tag, options);
  }

loadMetaGraphDef() [1/2]

MetaGraphDef * tensorflow::loadMetaGraphDef	(	const std::string &	exportDir,
		const std::string &	tag = kSavedModelTagServe
	)

Definition at line 91 of file TensorFlow.cc.

References makeGlobalPositionRcd_cfg::tag.

Referenced by loadMetaGraph().

                                                                                   {
    Options default_options{};
    return loadMetaGraphDef(exportDir, tag, default_options);
  }

loadMetaGraphDef() [2/2]

MetaGraphDef * tensorflow::loadMetaGraphDef	(	const std::string &	exportDir,
		const std::string &	tag,
		Options &	options
	)

Definition at line 96 of file TensorFlow.cc.

References Exception, mps_update::status, and makeGlobalPositionRcd_cfg::tag.

                                                                                                     {
    // objects to load the graph
    Status status;
    RunOptions runOptions;
    SavedModelBundle bundle;

    // load the model
    status = LoadSavedModel(options.getSessionOptions(), runOptions, exportDir, {tag}, &bundle);
    if (!status.ok()) {
      throw cms::Exception("InvalidMetaGraphDef")
          << "error while loading metaGraphDef from '" << exportDir << "': " << status.ToString();
    }

    // return a copy of the graph
    return new MetaGraphDef(bundle.meta_graph_def);
  }

run() [1/8]

void tensorflow::run	(	Session *	session,
		const NamedTensorList &	inputs,
		const std::vector< std::string > &	outputNames,
		std::vector< Tensor > *	outputs,
		const thread::ThreadPoolOptions &	threadPoolOptions
	)

Definition at line 272 of file TensorFlow.cc.

References checkEmptyInputs(), Exception, PixelMapPlotter::inputs, jetsAK4_CHS_cff::outputNames, PatBasicFWLiteJetAnalyzer_Selector_cfg::outputs, and mps_update::status.

Referenced by PtAssignmentEngineDxy::call_tensorflow_dxy(), MkFitOutputConverter::computeDNNs(), ticl::PatternRecognitionbyCLUE3D< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyCA< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyFastJet< TILES >::energyRegressionAndID(), TrackstersMergeProducerV3::energyRegressionAndID(), TrackstersMergeProducer::energyRegressionAndID(), egammaTools::EgammaDNNHelper::evaluate(), reco::DeepSCGraphEvaluation::evaluate(), TSGForOIDNN::evaluateClassifier(), TauNNId::EvaluateNN(), BJetId::EvaluateNN(), TSGForOIDNN::evaluateRegressor(), DisplacedRegionSeedingVertexProducer::getDiscriminatorValue(), DeepTauId::getPartialPredictions(), DeepTauId::getPredictionsV2(), L2TauNNProducerAlpaka::getTauScore(), L2TauNNProducer::getTauScore(), DeepMETProducer::produce(), BaseMVAValueMapProducer< pat::Muon >::produce(), run(), DTOccupancyTestML::runOccupancyTest(), DeepCoreSeedGenerator::SeedEvaluation(), and HGCalConcentratorAutoEncoderImpl::select().

                                                             {
    if (session == nullptr) {
      throw cms::Exception("InvalidSession") << "cannot run empty session";
    }

    // create empty run options
    RunOptions runOptions;

    // Check if the inputs are empty
    if (checkEmptyInputs(inputs))
      return;

    // run and check the status
    Status status = session->Run(runOptions, inputs, outputNames, {}, outputs, nullptr, threadPoolOptions);
    if (!status.ok()) {
      throw cms::Exception("InvalidRun") << "error while running session: " << status.ToString();
    }
  }

run() [2/8]

void tensorflow::run ( const Session *  session, const NamedTensorList &  inputs, const std::vector< std::string > &  outputNames, std::vector< Tensor > *  outputs, const thread::ThreadPoolOptions &  threadPoolOptions  )

inline

Definition at line 122 of file TensorFlow.h.

References PixelMapPlotter::inputs, jetsAK4_CHS_cff::outputNames, PatBasicFWLiteJetAnalyzer_Selector_cfg::outputs, and run().

                                                                    {
    // TF takes a non-const session in the run call which is, however, thread-safe and logically
    // const, thus const_cast is consistent
    run(const_cast<Session*>(session), inputs, outputNames, outputs, threadPoolOptions);
  }

run() [3/8]

void tensorflow::run	(	Session *	session,
		const NamedTensorList &	inputs,
		const std::vector< std::string > &	outputNames,
		std::vector< Tensor > *	outputs,
		thread::ThreadPoolInterface *	threadPool
	)

Definition at line 295 of file TensorFlow.cc.

References PixelMapPlotter::inputs, jetsAK4_CHS_cff::outputNames, PatBasicFWLiteJetAnalyzer_Selector_cfg::outputs, and run().

                                                  {
    // create thread pool options
    thread::ThreadPoolOptions threadPoolOptions;
    threadPoolOptions.inter_op_threadpool = threadPool;
    threadPoolOptions.intra_op_threadpool = threadPool;

    // run
    run(session, inputs, outputNames, outputs, threadPoolOptions);
  }

run() [4/8]

void tensorflow::run ( const Session *  session, const NamedTensorList &  inputs, const std::vector< std::string > &  outputNames, std::vector< Tensor > *  outputs, thread::ThreadPoolInterface *  threadPool  )

inline

Definition at line 142 of file TensorFlow.h.

References PixelMapPlotter::inputs, jetsAK4_CHS_cff::outputNames, PatBasicFWLiteJetAnalyzer_Selector_cfg::outputs, and run().

                                                         {
    // TF takes a non-const session in the run call which is, however, thread-safe and logically
    // const, thus const_cast is consistent
    run(const_cast<Session*>(session), inputs, outputNames, outputs, threadPool);
  }

run() [5/8]

void tensorflow::run	(	Session *	session,
		const NamedTensorList &	inputs,
		const std::vector< std::string > &	outputNames,
		std::vector< Tensor > *	outputs,
		const std::string &	threadPoolName = "no_threads"
	)

Definition at line 309 of file TensorFlow.cc.

References Exception, PixelMapPlotter::inputs, tensorflow::NoThreadPool::instance(), tensorflow::TBBThreadPool::instance(), jetsAK4_CHS_cff::outputNames, PatBasicFWLiteJetAnalyzer_Selector_cfg::outputs, and run().

                                            {
    // lookup the thread pool and forward the call accordingly
    if (threadPoolName == "no_threads") {
      run(session, inputs, outputNames, outputs, &NoThreadPool::instance());
    } else if (threadPoolName == "tbb") {
      // the TBBTreadPool singleton should be already initialized before with a number of threads
      run(session, inputs, outputNames, outputs, &TBBThreadPool::instance());
    } else if (threadPoolName == "tensorflow") {
      run(session, inputs, outputNames, outputs, nullptr);
    } else {
      throw cms::Exception("UnknownThreadPool")
          << "thread pool implementation'" << threadPoolName << "' unknown, use 'no_threads', 'tbb', or 'tensorflow'";
    }
  }

run() [6/8]

void tensorflow::run ( const Session *  session, const NamedTensorList &  inputs, const std::vector< std::string > &  outputNames, std::vector< Tensor > *  outputs, const std::string &  threadPoolName = "no_threads"  )

inline

Definition at line 162 of file TensorFlow.h.

References PixelMapPlotter::inputs, jetsAK4_CHS_cff::outputNames, PatBasicFWLiteJetAnalyzer_Selector_cfg::outputs, and run().

                                                                  {
    // TF takes a non-const session in the run call which is, however, thread-safe and logically
    // const, thus const_cast is consistent
    run(const_cast<Session*>(session), inputs, outputNames, outputs, threadPoolName);
  }

run() [7/8]

void tensorflow::run	(	Session *	session,
		const std::vector< std::string > &	outputNames,
		std::vector< Tensor > *	outputs,
		const std::string &	threadPoolName = "no_threads"
	)

Definition at line 328 of file TensorFlow.cc.

References jetsAK4_CHS_cff::outputNames, PatBasicFWLiteJetAnalyzer_Selector_cfg::outputs, and run().

                                            {
    run(session, {}, outputNames, outputs, threadPoolName);
  }

run() [8/8]

void tensorflow::run ( const Session *  session, const std::vector< std::string > &  outputNames, std::vector< Tensor > *  outputs, const std::string &  threadPoolName = "no_threads"  )

inline

Definition at line 181 of file TensorFlow.h.

References jetsAK4_CHS_cff::outputNames, PatBasicFWLiteJetAnalyzer_Selector_cfg::outputs, and run().

                                                                  {
    // TF takes a non-const session in the run call which is, however, thread-safe and logically
    // const, thus const_cast is consistent
    run(const_cast<Session*>(session), outputNames, outputs, threadPoolName);
  }

setLogging()

void tensorflow::setLogging

(

const std::string &

level = "3"

)

Definition at line 81 of file TensorFlow.cc.

References personalPlayback::level.

Referenced by reco::DeepSCGraphEvaluation::DeepSCGraphEvaluation(), DTOccupancyTestML::dqmEndLuminosityBlock(), HGCalConcentratorAutoEncoderImpl::HGCalConcentratorAutoEncoderImpl(), L1NNTauProducer::initializeGlobalCache(), L2TauNNProducerAlpaka::initializeGlobalCache(), L2TauNNProducer::initializeGlobalCache(), and TSGForOIDNN::TSGForOIDNN().

                                          {
    /*
     * 0 = all messages are logged (default behavior)
     * 1 = INFO messages are not printed
     * 2 = INFO and WARNING messages are not printed
     * 3 = INFO, WARNING, and ERROR messages are not printed
     */
    setenv("TF_CPP_MIN_LOG_LEVEL", level.c_str(), 0);
  }