add filldescriptions for clients and producers

Author: kpedro88

Brainwave/interface/TFClientLocal.h

@@ -12,12 +12,19 @@
 #include "tensorflow/core/graph/default_device.h"
 #include "tensorflow/core/public/session.h"
 
+//forward declaration
+namespace edm {
+	class ParameterSetDescription;
+}
+
 class TFClientLocal : public SonicClientSync<tensorflow::Tensor> {
 	public:
 		//constructor
 		TFClientLocal(const edm::ParameterSet& params);
 		//destructor
 		~TFClientLocal();
+		//for fillDescriptions
+		static void fillPSetDescription(edm::ParameterSetDescription& iDesc);
 
 	protected:
 		void predictImpl() override;

Brainwave/interface/TFClientRemote.h

@@ -12,10 +12,17 @@
 #include "tensorflow/core/framework/tensor.h"
 #include "tensorflow/core/util/command_line_flags.h"
 
+//forward declaration
+namespace edm {
+	class ParameterSetDescription;
+}
+
 class TFClientRemote : public SonicClientPseudoAsync<tensorflow::Tensor> {
 	public:
 		//constructors (timeout in seconds)
 		TFClientRemote(const edm::ParameterSet& params);
+		//for fillDescriptions
+		static void fillPSetDescription(edm::ParameterSetDescription& iDesc);
 
 	protected:
 		void predictImpl() override;

Brainwave/plugins/JetImageProducer.cc

@@ -10,6 +10,8 @@
 #include "SonicCMS/Brainwave/interface/TFClientLocal.h"
 #include "FWCore/Framework/interface/Event.h"
 #include "FWCore/ParameterSet/interface/ParameterSet.h"
+#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
+#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
 #include "FWCore/Framework/interface/EventSetup.h"
 #include "FWCore/Framework/interface/ESHandle.h"
 #include "FWCore/Framework/interface/Frameworkfwd.h"
@@ -110,6 +112,17 @@ class JetImageProducer : public SonicEDProducer<Client>
 			findTopN(iOutput);
 		}
 
+		//to ensure distinct cfi names - specialized below
+		static std::string getCfiName();
+		static void fillDescriptions(edm::ConfigurationDescriptions & descriptions) {
+			edm::ParameterSetDescription desc;
+			Client::fillPSetDescription(desc);
+			desc.add<edm::InputTag>("JetTag",edm::InputTag("slimmedJetsAK8"));
+			desc.add<unsigned>("topN",5);
+			desc.add<std::string>("imageList");
+			descriptions.add(getCfiName(),desc);
+		}
+
 	private:
 		void findTopN(const tensorflow::Tensor& scores) const {
 			auto score_list = scores.flat<float>();
@@ -143,5 +156,8 @@ class JetImageProducer : public SonicEDProducer<Client>
 typedef JetImageProducer<TFClientRemote> JetImageProducerRemote;
 typedef JetImageProducer<TFClientLocal> JetImageProducerLocal;
 
+template<> std::string JetImageProducerRemote::getCfiName() { return "JetImageProducerRemote"; }
+template<> std::string JetImageProducerLocal::getCfiName() { return "JetImageProducerLocal"; }
+
 DEFINE_FWK_MODULE(JetImageProducerRemote);
 DEFINE_FWK_MODULE(JetImageProducerLocal);

Brainwave/src/TFClientLocal.cc

@@ -1,8 +1,10 @@
 #include "FWCore/MessageLogger/interface/MessageLogger.h"
+#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
 #include "PhysicsTools/TensorFlow/interface/TensorFlow.h"
 #include "SonicCMS/Brainwave/interface/TFClientLocal.h"
 
 #include <sstream>
+#include <string>
 #include <chrono>
 
 #include "tensorflow/core/graph/default_device.h"
@@ -13,6 +15,13 @@ TFClientLocal::TFClientLocal(const edm::ParameterSet& params) : SonicClientSync<
 	createSessions();
 }
 
+void TFClientLocal::fillPSetDescription(edm::ParameterSetDescription& iDesc) {
+	edm::ParameterSetDescription descClient;
+	descClient.add<std::string>("featurizer");
+	descClient.add<std::string>("classifier");
+	iDesc.add<edm::ParameterSetDescription>("Client",descClient);
+}
+
 void TFClientLocal::loadModel(const std::string& featurizer_file, const std::string& classifier_file) {
     // load the graph 
     std::stringstream msg;

Brainwave/src/TFClientRemote.cc

@@ -1,4 +1,5 @@
 #include "FWCore/MessageLogger/interface/MessageLogger.h"
+#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
 #include "SonicCMS/Brainwave/interface/TFClientRemote.h"
 
 #include <sstream>
@@ -80,3 +81,13 @@ TFClientRemote::TFClientRemote(const edm::ParameterSet& params) :
 	timeout_(params.getParameter<unsigned>("timeout")),
 	inputTensorName_(params.getParameter<std::string>("inputTensorName"))
 { }
+
+void TFClientRemote::fillPSetDescription(edm::ParameterSetDescription& iDesc) {
+	edm::ParameterSetDescription descClient;
+	descClient.add<std::string>("address");
+	descClient.add<unsigned>("port");
+	descClient.add<unsigned>("timeout");
+	descClient.add<std::string>("inputTensorName","Placeholder:0");
+	iDesc.add<edm::ParameterSetDescription>("Client",descClient);
+}
+

Core/README.md

@@ -22,6 +22,12 @@ class MyProducer : public SonicEDProducer<Client>
 		void produce(edm::Event& iEvent, edm::EventSetup const& iSetup, Output const& iOutput) override {
 			//convert client output to event data format
 		}
+		static void fillDescriptions(edm::ConfigurationDescriptions & descriptions) {
+			edm::ParameterSetDescription desc;
+			Client::fillPSetDescription(desc);
+			//add producer-specific parameters
+			descriptions.add("MyProducer",desc);
+		}
 };
 
 DEFINE_FWK_MODULE(MyProducer);
@@ -37,6 +43,7 @@ process.MyProducer = cms.EDProducer("MyProducer",
     )
 )
 ```
+These parameters can be prepopulated and validated by the client using `fillDescriptions` (see below).
 
 Example producers can be found in the `plugins` folders of the other packages in this repository.
 
@@ -60,6 +67,8 @@ class MyClient : public SonicClient*<Input,Output> {
 	public:
 		MyClient(const edm::ParameterSet& params);
 
+		static void fillPSetDescription(edm::ParameterSetDescription& iDesc);
+
 	protected:
 		void predictImpl() override;
 };
@@ -77,4 +86,13 @@ The generic `SonicClient*` should be replaced with one of the available modes:
 In addition, as indicated, the input and output data types must be specified.
 (If both types are the same, only the input type needs to be specified.)
 
+The client can also provide a static method `fillPSetDescription` to populate its parameters in the `fillDescriptions` for the producers that use the client:
+```cpp
+void MyClient::fillPSetDescription(edm::ParameterSetDescription& iDesc) {
+	edm::ParameterSetDescription descClient;
+	//add parameters
+	iDesc.add<edm::ParameterSetDescription>("Client",descClient);
+}
+```
+
 Example client code can be found in the `interface` and `src` directories of the other packages in this repository.

TensorRT/interface/TRTClient.h

@@ -2,6 +2,7 @@
 #define SonicCMS_TensorRT_TRTClient
 
 #include "FWCore/ParameterSet/interface/ParameterSet.h"
+#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
 #include "SonicCMS/Core/interface/SonicClientSync.h"
 #include "SonicCMS/Core/interface/SonicClientPseudoAsync.h"
 #include "SonicCMS/Core/interface/SonicClientAsync.h"
@@ -27,6 +28,19 @@ class TRTClient : public Client {
 		unsigned noutput() const { return noutput_; }
 		unsigned batchSize() const { return batchSize_; }
 
+		//for fillDescriptions
+		static void fillPSetDescription(edm::ParameterSetDescription& iDesc) {
+			edm::ParameterSetDescription descClient;
+			descClient.add<unsigned>("ninput");
+			descClient.add<unsigned>("noutput");
+			descClient.add<unsigned>("batchSize");
+			descClient.add<std::string>("address");
+			descClient.add<unsigned>("port");
+			descClient.add<unsigned>("timeout");
+			descClient.add<std::string>("modelName");
+			iDesc.add<edm::ParameterSetDescription>("Client",descClient);
+		}
+
 	protected:
 		void predictImpl() override;
 

TensorRT/plugins/HcalProducer.cc

@@ -7,6 +7,8 @@
 #include "SonicCMS/TensorRT/interface/TRTClient.h"
 #include "FWCore/Framework/interface/Event.h"
 #include "FWCore/ParameterSet/interface/ParameterSet.h"
+#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
+#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
 #include "FWCore/Framework/interface/EventSetup.h"
 #include "FWCore/Framework/interface/Frameworkfwd.h"
 #include "FWCore/Framework/interface/MakerMacros.h"
@@ -46,6 +48,15 @@ class HcalProducer : public SonicEDProducer<Client>
 		}
 		~HcalProducer() override {}
 
+		//to ensure distinct cfi names - specialized below
+		static std::string getCfiName();
+		static void fillDescriptions(edm::ConfigurationDescriptions & descriptions) {
+			edm::ParameterSetDescription desc;
+			Client::fillPSetDescription(desc);
+			desc.add<unsigned>("topN",5);
+			descriptions.add(getCfiName(),desc);
+		}
+
 	private:
 		using SonicEDProducer<Client>::client_;
 		//Just putting something in for the hell of it
@@ -78,6 +89,10 @@ typedef HcalProducer<TRTClientSync> HcalProducerSync;
 typedef HcalProducer<TRTClientAsync> HcalProducerAsync;
 typedef HcalProducer<TRTClientPseudoAsync> HcalProducerPseudoAsync;
 
+template<> std::string HcalProducerSync::getCfiName() { return "HcalProducerSync"; }
+template<> std::string HcalProducerAsync::getCfiName() { return "HcalProducerAsync"; }
+template<> std::string HcalProducerPseudoAsync::getCfiName() { return "HcalProducerPseudoAsync"; }
+
 DEFINE_FWK_MODULE(HcalProducerSync);
 DEFINE_FWK_MODULE(HcalProducerAsync);
 DEFINE_FWK_MODULE(HcalProducerPseudoAsync);

TensorRT/plugins/JetImageProducer.cc

@@ -9,6 +9,8 @@
 #include "SonicCMS/TensorRT/interface/TRTClient.h"
 #include "FWCore/Framework/interface/Event.h"
 #include "FWCore/ParameterSet/interface/ParameterSet.h"
+#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
+#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
 #include "FWCore/Framework/interface/EventSetup.h"
 #include "FWCore/Framework/interface/ESHandle.h"
 #include "FWCore/Framework/interface/Frameworkfwd.h"
@@ -103,6 +105,17 @@ class JetImageProducer : public SonicEDProducer<Client>
 		}
 		~JetImageProducer() override {}
 
+		//to ensure distinct cfi names - specialized below
+		static std::string getCfiName();
+		static void fillDescriptions(edm::ConfigurationDescriptions & descriptions) {
+			edm::ParameterSetDescription desc;
+			Client::fillPSetDescription(desc);
+			desc.add<edm::InputTag>("JetTag",edm::InputTag("slimmedJetsAK8"));
+			desc.add<unsigned>("topN",5);
+			desc.add<std::string>("imageList");
+			descriptions.add(getCfiName(),desc);
+		}
+
 	private:
 		using SonicEDProducer<Client>::client_;
 		void findTopN(const std::vector<float>& scores, unsigned n=5) const {
@@ -138,6 +151,10 @@ typedef JetImageProducer<TRTClientSync> JetImageProducerSync;
 typedef JetImageProducer<TRTClientAsync> JetImageProducerAsync;
 typedef JetImageProducer<TRTClientPseudoAsync> JetImageProducerPseudoAsync;
 
+template<> std::string JetImageProducerSync::getCfiName() { return "JetImageProducerSync"; }
+template<> std::string JetImageProducerAsync::getCfiName() { return "JetImageProducerAsync"; }
+template<> std::string JetImageProducerPseudoAsync::getCfiName() { return "JetImageProducerPseudoAsync"; }
+
 DEFINE_FWK_MODULE(JetImageProducerSync);
 DEFINE_FWK_MODULE(JetImageProducerAsync);
 DEFINE_FWK_MODULE(JetImageProducerPseudoAsync);