Alfoa/hybrid model for batching and ensemble model #2322

alfoa · 2024-05-18T04:01:38Z

Pull Request Description

What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)

What are the significant changes in functionality due to this change request?

The development here is addressing 2 issues:

LogicalModel/HybridModel can now be used within an EnsembleModel
LogicalModel/HybridModel can now be used with Samplers/Optimizers that work using the batching strategy (e.g. GeneticAlgorithm).

In addition, an utility factory has been added in the JobHandler to collect and record Job Ids that have been used during the simulation. For now it is used as error checker but in the future can be used as base-class for identifier creation.

For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

1. Review all computer code.
2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
4. Automated Tests should pass, including run_tests, pylint, manual building and xsd tests. If there are changes to Simulation.py or JobHandler.py the qsub tests must pass.
5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large test. If new development on the internal JobHandler parallel system is performed, a cluster test must be added setting, in XML block, the node <internalParallel> to True.
6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
8. If an analytic test is changed/added is the the analytic documentation updated/added?
9. If any test used as a basis for documentation examples (currently found in raven/tests/framework/user_guide and raven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.

…h those since I am here)

ravenframework/JobHandler.py

…github.com:idaholab/raven into alfoa/hybrid_model_for_batching_and_ensemble_model

alfoa · 2024-05-20T14:57:13Z

ravenframework/Models/EnsembleModel.py

@@ -136,7 +136,7 @@ def localInputAndChecks(self,xmlNode):
          self.raiseAnError(IOError, "Input XML node for Model" + modelName +" has not been inputted!")
        if len(self.modelsInputDictionary[modelName].values()) > allowedEntriesLen:
          self.raiseAnError(IOError, "TargetEvaluation, Input and metadataToTransfer XML blocks are the only XML sub-blocks allowed!")
-        if child.attrib['type'].strip() == "Code":
+        if child.attrib['type'].strip() in ["Code", 'HybridModel', 'LogicalModel']:


very ugly :(

It would be slightly less ugly if you used a set:

if child.attrib['type'].strip() in {"Code", 'HybridModel', 'LogicalModel'}:

alfoa · 2024-05-20T14:58:35Z

ravenframework/Models/EnsembleModel.py

@@ -267,6 +268,12 @@ def initialize(self,runInfo,inputs,initDict=None):

      # initialize model
      self.modelsDictionary[modelName]['Instance'].initialize(runInfo,inputInstancesForModel,initDict)
+      if modelType in ['HybridModel', 'LogicalModel']:


maybe should be replaced by issubclass(self.modelsDictionary[modelName]['Instance'], HybridModelBase)?

I think you suggestion will be better here.

ravenframework/Models/Model.py

Merge branch 'alfoa/hybrid_model_for_batching_and_ensemble_model' of github.com:idaholab/raven into alfoa/hybrid_model_for_batching_and_ensemble_model

ravenframework/JobHandler.py

alfoa · 2024-05-20T15:18:22Z

ravenframework/Models/EnsembleModel.py

@@ -136,7 +136,7 @@ def localInputAndChecks(self,xmlNode):
          self.raiseAnError(IOError, "Input XML node for Model" + modelName +" has not been inputted!")
        if len(self.modelsInputDictionary[modelName].values()) > allowedEntriesLen:
          self.raiseAnError(IOError, "TargetEvaluation, Input and metadataToTransfer XML blocks are the only XML sub-blocks allowed!")
-        if child.attrib['type'].strip() == "Code":
+        if child.attrib['type'].strip() in ["Code", 'HybridModel', 'LogicalModel']:
          self.createWorkingDir = True


It is ugly and in addition this creates a sub-working directory even if, for example, the Logical/hybrid models do not use a Code. In case of HybridModel/LogicalModel using only ExternalModels/ROMs, the subdirectory is created but will stay empty. Not very elegant. @joshua-cogliati-inl @wangcj05 any ideas on how to improve this?

@wangcj05 @joshua-cogliati-inl any ideas for this? I cannot find a better solution at this stage

Can we have a class attribute to indicate if there is a code associated with the Model? For example, In Hybrid Model/Logical/Ensemble Model, we define a self._isCodeAvail, and assign it to true when we detect a code in the Model. @alfoa

Hm, I am trying to fully understand why you need to create the directory? Just to check, it is needed if the Logical/hybrid models use a Code? (Congjian's idea sounds reasonable)

yes that's why. If there is a Code in the underlying Logical/Hybrid model (contained in the ensemble model) the subfolder is required.

@wangcj05 @joshua-cogliati-inl can you tell me how exactly you would like that flag to be coded? (I prefer not to take a code design decision (that might be needed to be modified) on my own)?

@wangcj05 @joshua-cogliati-inl FY: if you can send feedbacks within tomorrow I can try to address them before leaving on Friday. Otherwise it will need to wait till September.

tests/framework/hybridModel/test_logical_ensemble_model_and_code.xml

…e_model

…iers

ravenframework/JobHandler.py

…e LogicModel

moosebuild · 2024-05-20T22:26:23Z

Job Mingw Test on ab91508 : invalidated by @joshua-cogliati-inl

restarted civet

moosebuild · 2024-05-22T17:29:27Z

Job Precheck on 5230636 : invalidated by @alfoa

…rashes if there are variables that are not called to be optimized but are strings

ravenframework/Models/EnsembleModel.py

moosebuild · 2024-07-17T18:13:19Z

Job Mingw Test on b25a176 : invalidated by @joshua-cogliati-inl

failed scripts/establish_conda_env.sh: line 153: 21634 Segmentation fault

ravenframework/Models/HybridModels/HybridModelBase.py

…e_model

…github.com:idaholab/raven into alfoa/hybrid_model_for_batching_and_ensemble_model

joshua-cogliati-inl · 2024-07-29T19:47:48Z

ravenframework/Models/EnsembleModel.py

+      # start the job handler
+      self.localPollingThread = InterruptibleThread(target=self.localJobHandler.startLoop)
+      self.localPollingThread.daemon = True
+      self.localPollingThread.start()
+      # register function to kill the thread at the end of the execution
+      atexit.register(self.localPollingThread.kill)


Hm, pollingThread (both here and in Simulation.py) possibly should be inside JobHandler. That said, this is just mimicking how Simulation does this, so I am not sure if this needs to be fixed now.

Also, can the localPollingThread be killed sooner, rather than waiting for the program to exit?

@alfoa Could you address Josh's comment here.

added in a dedicated function that is executed at the end of the step

wangcj05

@alfoa I have some general comments for you to consider.

wangcj05 · 2024-08-01T04:37:47Z

ravenframework/CodeInterfaceClasses/SERPENT/SerpentInterface.py

+      nPoints = preVolumeCalc.attrib.get("nPoints")
+      if nPoints is not None:
+        self.nVolumePoints = utils.intConversion(utils.floatConversion(nPoints))
+        print(nPoints)


ravenframework/JobHandler.py

ravenframework/Models/Code.py

wangcj05 · 2024-08-01T04:56:30Z

ravenframework/Models/EnsembleModel.py

@@ -267,6 +268,12 @@ def initialize(self,runInfo,inputs,initDict=None):

      # initialize model
      self.modelsDictionary[modelName]['Instance'].initialize(runInfo,inputInstancesForModel,initDict)
+      if modelType in ['HybridModel', 'LogicalModel']:


I think you suggestion will be better here.

wangcj05 · 2024-08-01T05:00:54Z

ravenframework/Models/EnsembleModel.py

+      # start the job handler
+      self.localPollingThread = InterruptibleThread(target=self.localJobHandler.startLoop)
+      self.localPollingThread.daemon = True
+      self.localPollingThread.start()
+      # register function to kill the thread at the end of the execution
+      atexit.register(self.localPollingThread.kill)


@alfoa Could you address Josh's comment here.

wangcj05 · 2024-08-01T05:21:19Z

ravenframework/Models/EnsembleModel.py

      if not isThereACode:
        isThereACode = modelType == 'Code'
+


I would suggest we add these lines in Logical model and Hybrid model.

I addressed this as well.

…e_model

…del contains a code

alfoa · 2024-08-27T14:19:38Z

@wangcj05 @joshua-cogliati-inl I addressed all the comments.

wangcj05

changes look good.

@joshua-cogliati-inl Do you have other comments?

alfoa added 2 commits May 17, 2024 16:39

moving ahead fixing hybrid model and ensemble model (and batching wit…

1879ae4

…h those since I am here)

added test

1b78cd1

alfoa commented May 18, 2024

View reviewed changes

ravenframework/JobHandler.py Outdated Show resolved Hide resolved

alfoa added 3 commits May 17, 2024 22:02

Update ravenframework/JobHandler.py

fafedbb

identifiers

e8c57bb

Merge branch 'alfoa/hybrid_model_for_batching_and_ensemble_model' of …

d18282a

…github.com:idaholab/raven into alfoa/hybrid_model_for_batching_and_ensemble_model

alfoa commented May 20, 2024

View reviewed changes

ravenframework/Models/Model.py Outdated Show resolved Hide resolved

alfoa added 3 commits May 20, 2024 08:59

Update ravenframework/Models/Model.py

b09eacc

Added test

7114f63

t push

b131c8a

Merge branch 'alfoa/hybrid_model_for_batching_and_ensemble_model' of github.com:idaholab/raven into alfoa/hybrid_model_for_batching_and_ensemble_model

alfoa commented May 20, 2024

View reviewed changes

ravenframework/JobHandler.py Outdated Show resolved Hide resolved

alfoa commented May 20, 2024

View reviewed changes

ravenframework/JobHandler.py Outdated Show resolved Hide resolved

alfoa commented May 20, 2024

View reviewed changes

tests/framework/hybridModel/test_logical_ensemble_model_and_code.xml Outdated Show resolved Hide resolved

alfoa commented May 20, 2024

View reviewed changes

tests/framework/hybridModel/test_logical_ensemble_model_and_code.xml Outdated Show resolved Hide resolved

Apply suggestions from code review

2e94d8c

alfoa requested review from joshua-cogliati-inl and wangcj05 May 20, 2024 15:23

alfoa added 4 commits May 20, 2024 09:29

Merge branch 'devel' into alfoa/hybrid_model_for_batching_and_ensembl…

a332bd0

…e_model

updated addFinishedJob

648c163

identifier is added from the job runner

135bcf7

removed identifier factory...too many objects rely on reusing identif…

1084d1e

…iers

alfoa commented May 20, 2024

View reviewed changes

ravenframework/JobHandler.py Show resolved Hide resolved

alfoa added 2 commits May 20, 2024 13:33

forgot model file

3269196

inputs 'types' should be requested to the users and not guessed in th…

ab91508

…e LogicModel

test local jobhandler in ensemble model

5230636

casting the batch solution from rlz into float is not necessary and c…

09d5b63

…rashes if there are variables that are not called to be optimized but are strings

joshua-cogliati-inl reviewed Jun 4, 2024

View reviewed changes

ravenframework/Models/EnsembleModel.py Outdated Show resolved Hide resolved

alfoa added 6 commits June 24, 2024 11:23

fix ensemble

e648a1d

added option to run volume calc

d7cab4d

addition of command separator option

2cf8dd2

updated serpent documentation

9c4aede

removed some comments

71bc89c

added doc for command separator

b25a176

alfoa commented Jul 17, 2024

View reviewed changes

ravenframework/Models/EnsembleModel.py Show resolved Hide resolved

addressed comments

7067497

alfoa requested a review from joshua-cogliati-inl July 17, 2024 18:37

alfoa added the Ready To Review label Jul 17, 2024

jobhandler only if parallelstrategy is == 2

40ad61b

alfoa commented Jul 17, 2024

View reviewed changes

ravenframework/Models/HybridModels/HybridModelBase.py Show resolved Hide resolved

alfoa added 4 commits July 17, 2024 13:46

serpent

8d4a3f5

Merge branch 'devel' into alfoa/hybrid_model_for_batching_and_ensembl…

691547e

…e_model

fixed doc

5527d23

Merge branch 'alfoa/hybrid_model_for_batching_and_ensemble_model' of …

c81ffea

…github.com:idaholab/raven into alfoa/hybrid_model_for_batching_and_ensemble_model

joshua-cogliati-inl reviewed Jul 29, 2024

View reviewed changes

wangcj05 requested changes Aug 1, 2024

View reviewed changes

wangcj05 reviewed Aug 1, 2024

View reviewed changes

alfoa added 3 commits August 26, 2024 12:05

Merge branch 'devel' into alfoa/hybrid_model_for_batching_and_ensembl…

76e91c3

…e_model

addressed Josh's and Congjians comments

64611a5

added property to set if an hybrid model/logical model or ensemble mo…

5193b22

…del contains a code

alfoa requested review from joshua-cogliati-inl and wangcj05 August 27, 2024 14:19

wangcj05 approved these changes Aug 30, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Alfoa/hybrid model for batching and ensemble model #2322

Alfoa/hybrid model for batching and ensemble model #2322

alfoa commented May 18, 2024 •

edited

Loading

alfoa May 20, 2024

joshua-cogliati-inl Jul 29, 2024

alfoa Aug 26, 2024

alfoa May 20, 2024

wangcj05 Aug 1, 2024

alfoa Aug 26, 2024

alfoa May 20, 2024

alfoa Jul 19, 2024

wangcj05 Jul 19, 2024

joshua-cogliati-inl Jul 29, 2024 •

edited

Loading

alfoa Jul 30, 2024

alfoa Jul 30, 2024

aalfonsi Aug 1, 2024

moosebuild commented May 20, 2024

moosebuild commented May 22, 2024

moosebuild commented Jul 17, 2024

joshua-cogliati-inl Jul 29, 2024

joshua-cogliati-inl Jul 29, 2024

wangcj05 Aug 1, 2024

alfoa Aug 26, 2024

wangcj05 left a comment

wangcj05 Aug 1, 2024

alfoa Aug 26, 2024

wangcj05 Aug 1, 2024

wangcj05 Aug 1, 2024

wangcj05 Aug 1, 2024

alfoa Aug 27, 2024

alfoa commented Aug 27, 2024

wangcj05 left a comment

Alfoa/hybrid model for batching and ensemble model #2322

Are you sure you want to change the base?

Alfoa/hybrid model for batching and ensemble model #2322

Conversation

alfoa commented May 18, 2024 • edited Loading

Pull Request Description

What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)

What are the significant changes in functionality due to this change request?

For Change Control Board: Change Request Review

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshua-cogliati-inl Jul 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moosebuild commented May 20, 2024

moosebuild commented May 22, 2024

moosebuild commented Jul 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wangcj05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alfoa commented Aug 27, 2024

wangcj05 left a comment

Choose a reason for hiding this comment

alfoa commented May 18, 2024 •

edited

Loading

joshua-cogliati-inl Jul 29, 2024 •

edited

Loading