#include <TFCSGANLWTNNHandler.h>

Inheritance diagram for TFCSGANLWTNNHandler:

Collaboration diagram for TFCSGANLWTNNHandler:

Public Types
typedef std::map< std::string, std::map< std::string, double > >	NetworkInputs
	Format for network inputs. More...

typedef std::map< std::string, double >	NetworkOutputs
	Format for network outputs. More...

Public Member Functions
	TFCSGANLWTNNHandler (const std::string &inputFile)
	TFCSGANLWTNNHandler constructor. More...

	TFCSGANLWTNNHandler (const TFCSGANLWTNNHandler &copy_from)
	TFCSGANLWTNNHandler copy constructor. More...

NetworkOutputs	compute (NetworkInputs const &inputs) const override
	Function to pass values to the network. More...

std::vector< std::string >	getOutputLayers () const override
	List the names of the outputs. More...

	VNetworkLWTNN (const VNetworkLWTNN &copy_from)
	VNetworkLWTNN copy constructor. More...

void	writeNetToTTree (TTree &tree) override
	Save the network to a TTree. More...

virtual void	writeNetToTTree (TTree &tree)=0
	Save the network to a TTree. More...

void	writeNetToTTree (TFile &root_file, std::string const &tree_name=m_defaultTreeName)
	Save the network to a TTree. More...

void	writeNetToTTree (std::string const &root_name, std::string const &tree_name=m_defaultTreeName)
	Save the network to a TTree. More...

void	writeNetToTTree (TFile &root_file, std::string const &tree_name=m_defaultTreeName)
	Save the network to a TTree. More...

void	writeNetToTTree (std::string const &root_name, std::string const &tree_name=m_defaultTreeName)
	Save the network to a TTree. More...

void	deleteAllButNet () override
	Get rid of any memory objects that arn't needed to run the net. More...

	VNetworkBase ()
	VNetworkBase default constructor. More...

	VNetworkBase (const std::string &inputFile)
	VNetworkBase constructor. More...

	VNetworkBase (const VNetworkBase &copy_from)
	VNetworkBase copy constructor. More...

bool	isFile () const
	Check if the argument inputFile is the path of a file on disk. More...

bool	msgLvl (const MSG::Level lvl) const
	Check whether the logging system is active at the provided verbosity level. More...

MsgStream &	msg () const
	Return a stream for sending messages directly (no decoration) More...

MsgStream &	msg (const MSG::Level lvl) const
	Return a decorated starting stream for sending messages. More...

MSG::Level	level () const
	Retrieve output level. More...

virtual void	setLevel (MSG::Level lvl)
	Update outputlevel. More...

Static Public Member Functions
static std::string	representNetworkInputs (NetworkInputs const &inputs, int maxValues=3)
	String representation of network inputs. More...

static std::string	representNetworkOutputs (NetworkOutputs const &outputs, int maxValues=3)
	String representation of network outputs. More...

static bool	isFile (std::string const &inputFile)
	Check if a string is the path of a file on disk. More...

static std::string	startMsg (MSG::Level lvl, const std::string &file, int line)
	Make a message to decorate the start of logging. More...

Static Public Attributes
static const std::string	m_defaultTreeName = "onnxruntime_session"
	Default name for the TTree to save in. More...

Protected Member Functions
void	setupNet () override
	Perform actions that prepare network for use. More...

virtual void	print (std::ostream &strm) const override
	Write a short description of this net to the string stream. More...

void	setupPersistedVariables () override
	Perform actions that prep data to create the net. More...

bool	isRootFile (std::string const &filename="") const
	Check if a string is possibly a root file path. More...

void	removePrefixes (NetworkOutputs &outputs) const
	Remove any common prefix from the outputs. More...

void	removePrefixes (std::vector< std::string > &output_names) const
	Remove any common prefix from the outputs. More...

Protected Attributes
std::string	m_json
	String containing json input file. More...

std::string	m_inputFile
	Path to the file describing the network, including filename. More...

Private Member Functions
	ClassDefOverride (TFCSGANLWTNNHandler, 6)

void	fillJson (std::string const &tree_name=m_defaultTreeName)
	Fill out m_json from a file provided to the constructor. More...

std::string	readStringFromTTree (TTree &tree)
	Get json string from TTree. More...

void	writeStringToTTree (TTree &tree, std::string json_string)
	Get json string from TTree. More...

	ClassDef (VNetworkBase, 1)

Private Attributes
std::unique_ptr< lwt::LightweightGraph >	m_lwtnn_graph
	The network that we are wrapping here. More...

std::vector< std::string >	m_outputLayers
	Do not persistify. More...

std::string *	m_input = nullptr
	Do not persistify. More...

std::string	m_printable_name
	Stores a printable identifyer for the net. More...

std::string	m_nm
	Message source name. More...

Static Private Attributes
static boost::thread_specific_ptr< MsgStream > m_msg_tls	ATLAS_THREAD_SAFE
	Do not persistify! More...

Detailed Description

Class for a neural network read in the LWTNN format. Derived from the abstract base class VNetworkBase such that it can be used interchangably with it's sibling class, TFCSONNXHandler, TFCSGANLWTNNHandler, TFCSSimpleLWTNNHandler.

Frustratingly, LightweightNeuralNetwork and LightweightGraph from lwtnn do not have a common ancestor, they could be connected with the bridge pattern, but that is more complex that currently required. This one handles the graph case, TFCSSimpleLWTNNHandler is for the non-graph case.

The LoadNetwork function has VNetworkBase as it's return type so that it can make a run-time decision about which derived class to use, based on the file name presented.

Definition at line 37 of file TFCSGANLWTNNHandler.h.

Member Typedef Documentation

◆ NetworkInputs

typedef std::map<std::string, std::map<std::string, double> > VNetworkBase::NetworkInputs

inherited

Format for network inputs.

The doubles are the values to be passed into the network. Strings in the outer map identify the input node, which must corrispond to the names of the nodes as read from the description of the network found by the constructor. Strings in the inner map identify the part of the input node, for some networks these must be simple integers, in string form, as parts of nodes do not always have the ability to carry real string labels.

Definition at line 90 of file VNetworkBase.h.

◆ NetworkOutputs

typedef std::map<std::string, double> VNetworkBase::NetworkOutputs

inherited

Format for network outputs.

The doubles are the values generated by the network. Strings identify which node this value came from, and when nodes have multiple values, are suffixed with a number to indicate which part of the node they came from. So in multi-value nodes the format becomes "<node_name>_<part_n>"

Definition at line 100 of file VNetworkBase.h.

Constructor & Destructor Documentation

◆ TFCSGANLWTNNHandler() [1/2]

TFCSGANLWTNNHandler::TFCSGANLWTNNHandler ( const std::string & inputFile )

explicit

TFCSGANLWTNNHandler constructor.

Calls setupPersistedVariables and setupNet.

Parameters

inputFile file-path on disk (with file name) of a readable lwtnn file containing a json format description of the network to be constructed, or the json itself as a string.

Definition at line 15 of file TFCSGANLWTNNHandler.cxx.

     : VNetworkLWTNN(inputFile) {
   ATH_MSG_DEBUG("Setting up from inputFile.");
   setupPersistedVariables();
   TFCSGANLWTNNHandler::setupNet();
 };

◆ TFCSGANLWTNNHandler() [2/2]

TFCSGANLWTNNHandler::TFCSGANLWTNNHandler ( const TFCSGANLWTNNHandler & copy_from )

TFCSGANLWTNNHandler copy constructor.

Will copy the variables that would be generated by setupPersistedVariables and setupNet.

Parameters

copy_from existing network that we are copying

Definition at line 22 of file TFCSGANLWTNNHandler.cxx.

     : VNetworkLWTNN(copy_from) {
   // Cannot take copies of lwt::LightweightGraph
   // (copy constructor disabled)
   ATH_MSG_DEBUG("Making a new m_lwtnn_graph for copied network");
   std::stringstream json_stream(m_json);
   const lwt::GraphConfig config = lwt::parse_json_graph(json_stream);
   m_lwtnn_graph = std::make_unique<lwt::LightweightGraph>(config);
   m_outputLayers = copy_from.m_outputLayers;
 };

Member Function Documentation

◆ ClassDef()

VNetworkBase::ClassDef	(	VNetworkBase	,
		1
	)

privateinherited

◆ ClassDefOverride()

TFCSGANLWTNNHandler::ClassDefOverride	(	TFCSGANLWTNNHandler	,
		6
	)

private

◆ compute()

TFCSGANLWTNNHandler::NetworkOutputs TFCSGANLWTNNHandler::compute ( TFCSGANLWTNNHandler::NetworkInputs const & inputs ) const

overridevirtual

Function to pass values to the network.

This function hides variations in the formated needed by different network libraries, providing a uniform input and output type.

Parameters

inputs values to be evaluated by the network

Returns: the output of the network

See also: VNetworkBase::NetworkInputs; VNetworkBase::NetworkOutputs

Implements VNetworkBase.

Definition at line 69 of file TFCSGANLWTNNHandler.cxx.

                                                           {
   ATH_MSG_DEBUG("Running computation on LWTNN graph network");
   NetworkInputs local_copy = inputs;
   if (inputs.find("Noise") != inputs.end()) {
     // Graphs from EnergyAndHitsGANV2 have the local_copy encoded as Noise =
     // node_0 and mycond = node_1
     auto noiseNode = local_copy.extract("Noise");
     noiseNode.key() = "node_0";
     local_copy.insert(std::move(noiseNode));
     auto mycondNode = local_copy.extract("mycond");
     mycondNode.key() = "node_1";
     local_copy.insert(std::move(mycondNode));
   }
   // now we can compute
   TFCSGANLWTNNHandler::NetworkOutputs outputs =
       m_lwtnn_graph->compute(local_copy);
   removePrefixes(outputs);
   ATH_MSG_DEBUG("Computation on LWTNN graph network done, returning.");
   return outputs;
 };

◆ deleteAllButNet()

void VNetworkLWTNN::deleteAllButNet ( )

overridevirtualinherited

Get rid of any memory objects that arn't needed to run the net.

Minimise memory usage by deleting nay inputs that are no longer required to run the compute function. Will prevent the net from being saved, if you need to call writeNetToTTree that must happen before this is called.

Implements VNetworkBase.

Definition at line 87 of file VNetworkLWTNN.cxx.

                                     {
   ATH_MSG_DEBUG("Replacing m_inputFile with unknown");
   m_inputFile.assign("unknown");
   m_inputFile.shrink_to_fit();
   ATH_MSG_DEBUG("Emptying the m_json string");
   m_json.clear();
   m_json.shrink_to_fit();
   ATH_MSG_VERBOSE("m_json now has capacity "
                   << m_json.capacity() << ". m_inputFile now has capacity "
                   << m_inputFile.capacity()
                   << ". m_printable_name now has capacity "
                   << m_printable_name.capacity());
 };

◆ fillJson()

void VNetworkLWTNN::fillJson ( std::string const & tree_name = m_defaultTreeName )

privateinherited

Fill out m_json from a file provided to the constructor.

Provided the string provided as inputFile to the constructor is a known file type (root or json) this function retreives the json string itself and puts it into m_json.

Parameters

tree_name TTree name to check in when reading root files.

Definition at line 52 of file VNetworkLWTNN.cxx.

                                                        {
   ATH_MSG_VERBOSE("Trying to fill the m_json variable");
   if (this->isRootFile()) {
     ATH_MSG_VERBOSE("Treating input file as a root file");
     TFile tfile(this->m_inputFile.c_str(), "READ");
     TTree *tree = (TTree *)tfile.Get(tree_name.c_str());
     std::string found = this->readStringFromTTree(*tree);
     ATH_MSG_DEBUG("Read json from root file, length " << found.length());
     m_json = found;
   } else {
     ATH_MSG_VERBOSE("Treating input file as a text json file");
     // The input file is read into a stringstream
     std::ifstream input(m_inputFile);
     std::ostringstream sstr;
     sstr << input.rdbuf();
     m_json = sstr.str();
     input.close();
     ATH_MSG_DEBUG("Read json from text file");
   }
 }

◆ getOutputLayers()

std::vector< std::string > TFCSGANLWTNNHandler::getOutputLayers ( ) const

overridevirtual

List the names of the outputs.

Outputs are stored in an NetworkOutputs object which is indexed by strings. This function returns the list of all strings that will index the outputs.

Implements VNetworkBase.

Definition at line 63 of file TFCSGANLWTNNHandler.cxx.

                                                                 {
   return m_outputLayers;
 };

◆ isFile() [1/2]

bool VNetworkBase::isFile ( ) const

inherited

Check if the argument inputFile is the path of a file on disk.

Determines if the string that was passed to the constructor as inputFile corrisponds to tha path of a file that can be read on the disk.

Returns: is it a readable file on disk

Definition at line 117 of file VNetworkBase.cxx.

117 { return isFile(m_inputFile); };

◆ isFile() [2/2]

bool VNetworkBase::isFile ( std::string const & inputFile )

staticinherited

Check if a string is the path of a file on disk.

Determines if a string corrisponds to tha path of a file that can be read on the disk.

Parameters

inputFile name of the pottential file

Returns: is it a readable file on disk

Definition at line 119 of file VNetworkBase.cxx.

                                                     {
   if (FILE *file = std::fopen(inputFile.c_str(), "r")) {
     std::fclose(file);
     return true;
   } else {
     return false;
   };
 };

◆ isRootFile()

bool VNetworkBase::isRootFile ( std::string const & filename = "" ) const

protectedinherited

Check if a string is possibly a root file path.

Just checks if the string ends in .root as there are almost no reliable rules for file paths.

Parameters

inputFile name of the pottential file if blank, m_inputFile is used.

Returns: is it the path of a root file

Definition at line 101 of file VNetworkBase.cxx.

                                                              {
   const std::string *to_check = &filename;
   if (filename.length() == 0) {
     to_check = &this->m_inputFile;
     ATH_MSG_DEBUG("No file name given, so using m_inputFile, " << m_inputFile);
   };
   const std::string ending = ".root";
   const int ending_len = ending.length();
   const int filename_len = to_check->length();
   if (filename_len < ending_len) {
     return false;
   }
   return (0 ==
           to_check->compare(filename_len - ending_len, ending_len, ending));
 };

◆ level()

MSG::Level ISF_FCS::MLogging::level ( ) const

inlineinherited

Retrieve output level.

Definition at line 201 of file MLogging.h.

201 { return msg().level(); }

◆ msg() [1/2]

MsgStream & ISF_FCS::MLogging::msg ( ) const

inlineinherited

Return a stream for sending messages directly (no decoration)

Definition at line 231 of file MLogging.h.

                                       {
   MsgStream *ms = m_msg_tls.get();
   if (!ms) {
     ms = new MsgStream(Athena::getMessageSvc(), m_nm);
     m_msg_tls.reset(ms);
   }
   return *ms;
 }

◆ msg() [2/2]

MsgStream & ISF_FCS::MLogging::msg ( const MSG::Level lvl ) const

inlineinherited

Return a decorated starting stream for sending messages.

Definition at line 240 of file MLogging.h.

                                                         {
   return msg() << lvl;
 }

◆ msgLvl()

bool ISF_FCS::MLogging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Check whether the logging system is active at the provided verbosity level.

Definition at line 222 of file MLogging.h.

                                                      {
   if (msg().level() <= lvl) {
     msg() << lvl;
     return true;
   } else {
     return false;
   }
 }

◆ print()

void VNetworkLWTNN::print ( std::ostream & strm ) const

overrideprotectedvirtualinherited

Write a short description of this net to the string stream.

Outputs a printable name, which maybe a file name, or a note specifying that the file has been provided from memory.

Parameters

strm	output parameter, to which the description will be written.

Reimplemented from VNetworkBase.

Definition at line 44 of file VNetworkLWTNN.cxx.

                                                 {
   strm << m_printable_name;
 };

◆ readStringFromTTree()

std::string VNetworkLWTNN::readStringFromTTree ( TTree & tree )

privateinherited

Get json string from TTree.

Given a TTree object, retrive the json string from the standard branch. This is used to retrive a network previously saved using writeNetToTTree.

Parameters

tree	TTree with the json saved inside.

Definition at line 73 of file VNetworkLWTNN.cxx.

                                                         {
   std::string found = std::string();
   std::string *to_found = &found;
   tree.SetBranchAddress("lwtnn_json", &to_found);
   tree.GetEntry(0);
   return found;
 };

◆ removePrefixes() [1/2]

void VNetworkBase::removePrefixes ( VNetworkBase::NetworkOutputs & outputs ) const

protectedinherited

Remove any common prefix from the outputs.

Parameters

outputs The outputs, changed in place.

Definition at line 151 of file VNetworkBase.cxx.

                                                                            {
   std::vector<std::string> output_layers;
   for (auto const &output : outputs)
     output_layers.push_back(output.first);
   const int length = GetPrefixLength(output_layers);
   for (std::string layer_name : output_layers) {
     // remove this output
     auto nodeHandle = outputs.extract(layer_name);
     // change the key
     nodeHandle.key() = layer_name.substr(length);
     // replace the output
     outputs.insert(std::move(nodeHandle));
   }
 };

◆ removePrefixes() [2/2]

void VNetworkBase::removePrefixes ( std::vector< std::string > & output_names ) const

protectedinherited

Remove any common prefix from the outputs.

Parameters

outputs The output names, changed in place.

Definition at line 144 of file VNetworkBase.cxx.

                                               {
   const int length = GetPrefixLength(output_names);
   for (long unsigned int i = 0; i < output_names.size(); i++)
     output_names[i] = output_names[i].substr(length);
 };

◆ representNetworkInputs()

std::string VNetworkBase::representNetworkInputs	(	VNetworkBase::NetworkInputs const &	inputs,
		int	maxValues = `3`
	)

staticinherited

String representation of network inputs.

Create a string that summarises a set of network inputs. Gives basic dimensions plus a few values, up to the maxValues

Parameters

inputs	values to be evaluated by the network
maxValues	maximum number of values to include in the representaiton

Returns: string represetning the inputs

Definition at line 37 of file VNetworkBase.cxx.

                                                     {
   std::string representation =
       "NetworkInputs, outer size " + std::to_string(inputs.size());
   int valuesIncluded = 0;
   for (const auto &outer : inputs) {
     representation += "\n key->" + outer.first + "; ";
     for (const auto &inner : outer.second) {
       representation += inner.first + "=" + std::to_string(inner.second) + ", ";
       ++valuesIncluded;
       if (valuesIncluded > maxValues)
         break;
     };
     if (valuesIncluded > maxValues)
       break;
   };
   representation += "\n";
   return representation;
 };

◆ representNetworkOutputs()

std::string VNetworkBase::representNetworkOutputs	(	VNetworkBase::NetworkOutputs const &	outputs,
		int	maxValues = `3`
	)

staticinherited

String representation of network outputs.

Create a string that summarises a set of network outputs. Gives basic dimensions plus a few values, up to the maxValues

Parameters

outputs	output of the network
maxValues	maximum number of values to include in the representaiton

Returns: string represetning the outputs

Definition at line 57 of file VNetworkBase.cxx.

                                                               {
   std::string representation =
       "NetworkOutputs, size " + std::to_string(outputs.size()) + "; \n";
   int valuesIncluded = 0;
   for (const auto &item : outputs) {
     representation += item.first + "=" + std::to_string(item.second) + ", ";
     ++valuesIncluded;
     if (valuesIncluded > maxValues)
       break;
   };
   representation += "\n";
   return representation;
 };

◆ setLevel()

void ISF_FCS::MLogging::setLevel ( MSG::Level lvl )

virtualinherited

Update outputlevel.

Definition at line 105 of file MLogging.cxx.

                                     {
   lvl = (lvl >= MSG::NUM_LEVELS) ? MSG::ALWAYS
         : (lvl < MSG::NIL)       ? MSG::NIL
                                  : lvl;
   msg().setLevel(lvl);
 }

◆ setupNet()

void TFCSGANLWTNNHandler::setupNet ( )

overrideprotectedvirtual

Perform actions that prepare network for use.

Will be called in the streamer or class constructor after the inputs have been set (either automaically by the streamer or by setupPersistedVariables in the constructor). Does not delete any resources used.

Implements VNetworkBase.

Definition at line 33 of file TFCSGANLWTNNHandler.cxx.

                                    {
   // Backcompatability, previous versions stored this in m_input
   if (m_json.length() == 0 && m_input != nullptr) {
     m_json = *m_input;
     delete m_input;
     m_input = nullptr;
   }
   // build the graph
   ATH_MSG_VERBOSE("m_json has size " << m_json.length());
   ATH_MSG_DEBUG("m_json starts with  " << m_json.substr(0, 10));
   ATH_MSG_VERBOSE("Reading the m_json string stream into a graph network");
   std::stringstream json_stream(m_json);
   const lwt::GraphConfig config = lwt::parse_json_graph(json_stream);
   m_lwtnn_graph = std::make_unique<lwt::LightweightGraph>(config);
   // Get the output layers
   ATH_MSG_VERBOSE("Getting output layers for neural network");
   for (auto node : config.outputs) {
     const std::string node_name = node.first;
     const lwt::OutputNodeConfig node_config = node.second;
     for (const std::string & label : node_config.labels) {
       ATH_MSG_VERBOSE("Found output layer called " << node_name << "_"
                                                    << label);
       m_outputLayers.push_back(node_name + "_" + label);
     }
   };
   ATH_MSG_VERBOSE("Removing prefix from stored layers.");
   removePrefixes(m_outputLayers);
   ATH_MSG_VERBOSE("Finished output nodes.");
 };

◆ setupPersistedVariables()

void VNetworkLWTNN::setupPersistedVariables ( )

overrideprotectedvirtualinherited

Perform actions that prep data to create the net.

Will be called in the base class constructor before calling setupNet, but not in the streamer. It sets any variables that the sreamer would persist when saving or loading to file.

Implements VNetworkBase.

Definition at line 30 of file VNetworkLWTNN.cxx.

                                             {
   if (this->isFile(m_inputFile)) {
     ATH_MSG_DEBUG("Making an LWTNN network using a file on disk, "
                   << m_inputFile);
     m_printable_name = m_inputFile;
     fillJson();
   } else {
     ATH_MSG_DEBUG("Making an LWTNN network using a json in memory, length "
                   << m_inputFile.length());
     m_printable_name = "JSON from memory";
     m_json = m_inputFile;
   };
 };

◆ startMsg()

std::string ISF_FCS::MLogging::startMsg	(	MSG::Level	lvl,
		const std::string &	file,
		int	line
	)

staticinherited

Make a message to decorate the start of logging.

Print a message for the start of logging.

Definition at line 116 of file MLogging.cxx.

                                                                           {
   int col1_len = 20;
   int col2_len = 5;
   int col3_len = 10;
   auto last_slash = file.find_last_of('/');
   int path_len = last_slash == std::string::npos ? 0 : last_slash;
   int trim_point = path_len;
   int total_len = file.length();
   if (total_len - path_len > col1_len)
     trim_point = total_len - col1_len;
   std::string trimmed_name = file.substr(trim_point);
   const char *LevelNames[MSG::NUM_LEVELS] = {
       "NIL", "VERBOSE", "DEBUG", "INFO", "WARNING", "ERROR", "FATAL", "ALWAYS"};
   std::string level = LevelNames[lvl];
   std::string level_string = std::string("(") + level + ") ";
   std::stringstream output;
   output << std::setw(col1_len) << std::right << trimmed_name << ":"
          << std::setw(col2_len) << std::left << line << std::setw(col3_len)
          << std::right << level_string;
   return output.str();
 }

◆ VNetworkBase() [1/3]

VNetworkBase::VNetworkBase

inherited

VNetworkBase default constructor.

For use in streamers.

Definition at line 45 of file VNetworkBase.cxx.

16 : m_inputFile("unknown"){};

◆ VNetworkBase() [2/3]

VNetworkBase::VNetworkBase

explicitinherited

VNetworkBase constructor.

Only saves inputFile to m_inputFile; Inherting classes should call setupPersistedVariables and setupNet in constructor;

Parameters

inputFile file-path on disk (with file name) of a readable file containing a description of the network to be constructed or the content of the file.

Definition at line 59 of file VNetworkBase.cxx.

     : m_inputFile(inputFile) {
   ATH_MSG_DEBUG("Constructor called with inputFile");
 };

◆ VNetworkBase() [3/3]

VNetworkBase::VNetworkBase

inherited

VNetworkBase copy constructor.

Does not call setupPersistedVariables or setupNet but will pass on m_inputFile. Inherting classes should do whatever they need to move the variables created in the setup functions.

Parameters

copy_from existing network that we are copying

Definition at line 71 of file VNetworkBase.cxx.

   : MLogging(),
     m_inputFile (copy_from.m_inputFile)
 {
 };

◆ VNetworkLWTNN()

VNetworkLWTNN::VNetworkLWTNN

VNetworkLWTNN copy constructor.

Will copy the variables that would be generated by setupPersistedVariables and setupNet. Will fail if deleteAllButNet has already been called.

Parameters

copy_from existing network that we are copying

Definition at line 45 of file VNetworkLWTNN.cxx.

     : VNetworkBase(copy_from),
       m_json (copy_from.m_json),
       m_printable_name (copy_from.m_printable_name)
 {
   if (m_json.length() == 0) {
     throw std::invalid_argument(
         "Trying to copy a VNetworkLWTNN with length 0 m_json, probably "
         "deleteAllButNet was called on the object being coppied from.");
   };
 };

◆ writeNetToTTree() [1/6]

void VNetworkBase::writeNetToTTree

inherited

Save the network to a TTree.

All data required to recreate the network object is saved into a TTree. The format is not specified.

Parameters

root_name	The path of the file to save inside.
tree_name	The name of the TTree to save inside.

Definition at line 196 of file VNetworkBase.cxx.

                                                                {
   ATH_MSG_DEBUG("Making or updating file name " << root_name);
   TFile root_file(root_name.c_str(), "UPDATE");
   this->writeNetToTTree(root_file, tree_name);
   root_file.Close();
 };

◆ writeNetToTTree() [2/6]

void VNetworkBase::writeNetToTTree	(	std::string const &	root_name,
		std::string const &	tree_name = `m_defaultTreeName`
	)

inherited

Save the network to a TTree.

All data required to recreate the network object is saved into a TTree. The format is not specified.

Parameters

root_name	The path of the file to save inside.
tree_name	The name of the TTree to save inside.

Definition at line 93 of file VNetworkBase.cxx.

                                                                {
   ATH_MSG_DEBUG("Making or updating file name " << root_name);
   TFile root_file(root_name.c_str(), "UPDATE");
   this->writeNetToTTree(root_file, tree_name);
   root_file.Close();
 };

◆ writeNetToTTree() [3/6]

void VNetworkBase::writeNetToTTree

inherited

Save the network to a TTree.

All data required to recreate the network object is saved into a TTree. The format is not specified.

Parameters

root_file	The file to save inside.
tree_name	The name of the TTree to save inside.

Definition at line 184 of file VNetworkBase.cxx.

                                                                {
   ATH_MSG_DEBUG("Making tree name " << tree_name);
   root_file.cd();
   const std::string title = "onnxruntime saved network";
   TTree tree(tree_name.c_str(), title.c_str());
   this->writeNetToTTree(tree);
   root_file.Write();
 };

◆ writeNetToTTree() [4/6]

void VNetworkBase::writeNetToTTree	(	TFile &	root_file,
		std::string const &	tree_name = `m_defaultTreeName`
	)

inherited

Save the network to a TTree.

All data required to recreate the network object is saved into a TTree. The format is not specified.

Parameters

root_file	The file to save inside.
tree_name	The name of the TTree to save inside.

Definition at line 83 of file VNetworkBase.cxx.

                                                                {
   ATH_MSG_DEBUG("Making tree name " << tree_name);
   root_file.cd();
   const std::string title = "onnxruntime saved network";
   TTree tree(tree_name.c_str(), title.c_str());
   this->writeNetToTTree(tree);
   root_file.Write();
 };

◆ writeNetToTTree() [5/6]

void VNetworkLWTNN::writeNetToTTree ( TTree & tree )

overridevirtualinherited

Save the network to a TTree.

All data required to recreate the network object is saved into a TTree. The format is not specified.

Parameters

tree	The tree to save inside.

Implements VNetworkBase.

Definition at line 48 of file VNetworkLWTNN.cxx.

                                                {
   writeStringToTTree(tree, m_json);
 };

◆ writeNetToTTree() [6/6]

virtual void VNetworkBase::writeNetToTTree

inherited

Save the network to a TTree.

All data required to recreate the network object is saved into a TTree. The format is not specified.

Parameters

tree	The tree to save inside.

◆ writeStringToTTree()

void VNetworkLWTNN::writeStringToTTree	(	TTree &	tree,
		std::string	json_string
	)

privateinherited

Get json string from TTree.

Given a TTree object, retrive the json string from the standard branch. This is used to retrive a network previously saved using writeNetToTTree.

Parameters

tree	TTree with the json saved inside.

Definition at line 81 of file VNetworkLWTNN.cxx.

                                                                          {
   tree.Branch("lwtnn_json", &json_string);
   tree.Fill();
   tree.Write();
 };

Member Data Documentation

◆ ATLAS_THREAD_SAFE

boost::thread_specific_ptr<MsgStream> m_msg_tls ISF_FCS::MLogging::ATLAS_THREAD_SAFE

inlinestaticprivateinherited

Do not persistify!

MsgStream instance (a std::cout like with print-out levels)

Definition at line 215 of file MLogging.h.

◆ m_defaultTreeName

const std::string VNetworkBase::m_defaultTreeName = "onnxruntime_session"

inlinestaticinherited

Default name for the TTree to save in.

Definition at line 173 of file VNetworkBase.h.

◆ m_input

std::string* TFCSGANLWTNNHandler::m_input = nullptr

private

Do not persistify.

Just for backcompatability.

Definition at line 115 of file TFCSGANLWTNNHandler.h.

◆ m_inputFile

std::string VNetworkBase::m_inputFile

protectedinherited

Path to the file describing the network, including filename.

Definition at line 245 of file VNetworkBase.h.

◆ m_json

std::string VNetworkLWTNN::m_json

protectedinherited

String containing json input file.

Is needed to save the network with writeNetToTTree but not needed to run the network with compute. Is eraised by deleteAllButNet Should be persisted.

Definition at line 84 of file VNetworkLWTNN.h.

◆ m_lwtnn_graph

std::unique_ptr<lwt::LightweightGraph> TFCSGANLWTNNHandler::m_lwtnn_graph

private

The network that we are wrapping here.

Definition at line 105 of file TFCSGANLWTNNHandler.h.

◆ m_nm

std::string ISF_FCS::MLogging::m_nm

privateinherited

Message source name.

Definition at line 211 of file MLogging.h.

◆ m_outputLayers

std::vector<std::string> TFCSGANLWTNNHandler::m_outputLayers

private

Do not persistify.

List of names that index the output layer.

Definition at line 110 of file TFCSGANLWTNNHandler.h.

◆ m_printable_name

std::string VNetworkLWTNN::m_printable_name

privateinherited

Stores a printable identifyer for the net.

Not unique.

Definition at line 144 of file VNetworkLWTNN.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ NetworkInputs

◆ NetworkOutputs

Constructor & Destructor Documentation

◆ TFCSGANLWTNNHandler() [1/2]

◆ TFCSGANLWTNNHandler() [2/2]

Member Function Documentation

◆ ClassDef()

◆ ClassDefOverride()

◆ compute()

◆ deleteAllButNet()

◆ fillJson()

◆ getOutputLayers()

◆ isFile() [1/2]

◆ isFile() [2/2]

◆ isRootFile()

◆ level()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ print()

◆ readStringFromTTree()

◆ removePrefixes() [1/2]

◆ removePrefixes() [2/2]

◆ representNetworkInputs()

◆ representNetworkOutputs()

◆ setLevel()

◆ setupNet()

◆ setupPersistedVariables()

◆ startMsg()

◆ VNetworkBase() [1/3]

◆ VNetworkBase() [2/3]

◆ VNetworkBase() [3/3]

◆ VNetworkLWTNN()

◆ writeNetToTTree() [1/6]

◆ writeNetToTTree() [2/6]

◆ writeNetToTTree() [3/6]

◆ writeNetToTTree() [4/6]

◆ writeNetToTTree() [5/6]

◆ writeNetToTTree() [6/6]

◆ writeStringToTTree()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_defaultTreeName

◆ m_input

◆ m_inputFile

◆ m_json

◆ m_lwtnn_graph

◆ m_nm

◆ m_outputLayers

◆ m_printable_name