Modules not auto-generating a cfi file in cfi-python currently present in the HLT menu (Run 3 and Phase 2)

[mmusich]

Disclaimer: this issue is mostly for documentation purposes.
TSG has started to investigate possible replacements of the current Configuration DB model for storing HLT menus in view of the Phase 2 upgrade.
One of the possibilities that was discussed, is to fetch the list of configurable parameters uniquely from the auto-generated configuration fragment files that the fillDescriptions mechanism provides in cmssw.
At the moment, this is unfortunately not possible as not all the plugins used at HLT have a viable fillDescriptions implementation that is both :

1. providing default values for all the top level parameters.
2. generating a cfi file in the cfi-python folder (to be parsed instead of other cfi files in the python directory), see addDefault vs addWithDefaultLabel.

In the recent past I have opened a series of PRs to bring the list of outstanding modules down: #47017, #47045, #47079, #47107, #47136, #47191 and #47224, but few remain to be addressed, especially those that either:

• have complicated class inheritance structure (e.g. using algorithm factories)
• take branching decisions (ifValues and similar) to populate the defaults of certain parameters depending on the value of others (see also discussion at add fillDescriptions to several plugins used at HLT (4/N) #47107 (comment) and following).

As of any IB more recent that CMSSW_15_0_X_2025-02-05-1100, the following script can be used to identify such modules in the Run 3 menu:

• BTagProbabilityToDiscriminator
• CSCChannelMapperESProducer
• CSCIndexerESProducer
• CaloTopologyBuilder
• CaloTowersCreator
• CandIPProducer
• CandSecondaryVertexProducer
• DTRecHitProducer
• DTRecSegment4DProducer
• DetIdAssociatorESProducer
• ESRecHitProducer
• EcalSeverityLevelESProducer
• EmptyESSource
• GsfMaterialEffectsESProducer
• HcalChannelPropertiesEP
• HcalTimeSlewEP
• JetTagProducer
• MuonIdProducer
• PropagatorWithMaterialESProducer
• RPCRecHitProducer
• SecondaryVertexProducer
• SeedGeneratorFromRegionHitsEDProducer
• SiPixelTemplateDBObjectESProducer
• SiStripBackPlaneCorrectionDepESProducer
• SiStripLorentzAngleDepESProducer
• SoftLepton
• StripCPEESProducer
• TSGFromL2Muon
• TrackIPProducer
• TrajectoryCleanerESProducer

While the following script can be used to identify such modules in the Phase 2 menu:

• CSCChannelMapperESProducer
• CSCIndexerESProducer
• CaloTowersCreator
• CandIPProducer
• CandSecondaryVertexProducer
• DTRecHitProducer
• DTRecSegment4DProducer
• DetIdAssociatorESProducer
• EcalSeverityLevelESProducer
• EmptyESSource
• GsfMaterialEffectsESProducer
• HBHEPhase1Reconstructor
• HGCalRecHitProducer
• HcalChannelPropertiesEP
• MuonIdProducer
• PFCandidateFwdPtrProducer
• PropagatorWithMaterialESProducer
• RPCRecHitProducer
• TrajectoryCleanerESProducer

I would appreciate if there was some help from contacts from the reconstruction group to address (or discuss) the remaining ones (especially the ones associated to the Phase 2 menu, which is our ultimate goal).

Cc:
@cms-sw/hlt-l2 @fwyzard @Sam-Harper

[cmsbuild]

cms-bot internal usage

[cmsbuild]

A new Issue was created by @mmusich.

@Dr15Jones, @antoniovilela, @makortel, @mandrenguyen, @rappoccio, @sextonkennedy, @smuzaffar can you please review it and eventually sign/assign? Thanks.

cms-bot commands are listed here

[Dr15Jones]

So the new way fillDescriptions works is it generates a file in cfipython/*/<SubSystem>/<Package>/ directory named <ModuleType>.py which contains a function named which can be used to generate an instance of the proper cms. type for the module which declares the parameter names/types for all the parameters.

If a addDefaultWithLabel is used, then fillDescriptions also writes a _cfi.py file which loads the .py python package and uses the new function to generate the class instance.

Therefore it is not necessary to add addDefault or addDefaultWithLabel to all fillDescriptions to do what you want. Instead, you can use the .py files.

[mmusich]

Instead, you can use the .py files.

(Maybe) fine. Though several modules in the list above are still lacking any configuration validation, which I guess it means there are no parameters in such .py files.

[fwyzard]

So the new way fillDescriptions works is it generates a file in cfipython/*/<SubSystem>/<Package>/ directory named <ModuleType>.py which contains a function named which can be used to generate an instance of the proper cms. type for the module which declares the parameter names/types for all the parameters.

just curious, what happens if a module has multiple possible configurations ?

[Dr15Jones]

just curious, what happens if a module has multiple possible configurations ?

The different _cfi.py files still import the package but then only change the values of parameters which differ from the 'default'.

E.g.

     from Foo.Bar.modules import FiiProducer

     fii = FiiProducer( value = 3.2)

[makortel]

assign hlt,alca,geometry,reconstruction,upgrade

[cmsbuild]

New categories assigned: hlt,alca,geometry,reconstruction,upgrade

@atpathak,@bsunanda,@civanch,@consuegs,@Dr15Jones,@jfernan2,@kpedro88,@makortel,@mandrenguyen,@Martin-Grunewald,@mdhildreth,@mmusich,@Moanwar,@perrotta,@srimanob,@subirsarkar you have been requested to review this Pull request/Issue and eventually sign? Thanks