Add capability to handle interdependent functions in samplers/optimizers #2319

alfoa · 2024-05-15T14:56:46Z

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?

Added the possibility to specify in Optimizers/Samplers variables (defined through functions) that are interdependent.

For example, lets assume we sample the variables

#_Eggs,
grams_Pancetta_or_Guanciale(I know we should use only guanciale but it is difficult to find it),
grams_Pecorino_Cheese;
#_tomatos;

the variable what_dish_do_we_cook depends solely on these variables (and it is defined through a RAVEN <function>) and depending on the values of #_tomatos and #_Eggs the result of this function can be either be Carbonara or Amatriciana.

the variable which_pasta_should_we_use depends on the variable what_dish_do_we_cook:
if

what_dish_do_we_cook == Carbonara, which_pasta_should_we_use == Rigatoni
else
what_dish_do_we_cook == Amatriciana, which_pasta_should_we_use == Bucatini

Based on this example, RAVEN will first sample #_Eggs, grams_Pancetta_or_Guanciale, grams_Pecorino_Cheese and #_tomatos; Then it evaluates the function that computes the variable
what_dish_do_we_cook and finally it computes the variable which_pasta_should_we_use depending on the
value of the variable what_dish_do_we_cook.

In addition to this capability, also a new test for the ensemble model testing/showing how to use it to transfer string variables from a model to the other using RAVEN variables has been added.

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.

…ound

alfoa · 2024-05-15T14:58:14Z

tests/framework/ensembleModelTests/test_ensemble_model_2_codes_passing_string_outputs.xml

@@ -0,0 +1,154 @@
+<?xml version="1.0" ?>


@Jimmy-INL This is the show case/example you asked about.

alfoa · 2024-05-15T15:14:33Z

@wangcj05 @joshua-cogliati-inl @mandd

Unfortunately new issue

... Activating environment ...
... Installing libraries from PIP-ONLY ...
...pip-only command: pip install netcdf4==1.6.* tensorflow==2.13.* grpcio dask[complete] ray[default]==2.6.* imageio==2.22.* python-sensors numdifftools==0.9.* xmlschema fmpy==0.3.16.*
WARNING: Retrying (Retry(total=4, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfab2cb0>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
WARNING: Retrying (Retry(total=3, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfc26bc0>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
WARNING: Retrying (Retry(total=2, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfc25ab0>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
WARNING: Retrying (Retry(total=1, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfc26080>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
WARNING: Retrying (Retry(total=0, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfab30d0>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
ERROR: Could not find a version that satisfies the requirement netcdf4==1.6.* (from versions: none)
ERROR: No matching distribution found for netcdf4==1.6.*

ERROR: exiting with code 1

ravenframework/Samplers/EnsembleForward.py

ravenframework/Samplers/Sampler.py

moosebuild · 2024-05-16T04:45:37Z

All jobs on d6e0159 : invalidated by @wangcj05

ravenframework/Samplers/Sampler.py

…he Model sections

moosebuild · 2024-05-24T14:06:57Z

Job Mingw Test on 74e6708 : invalidated by @alfoa

alfoa · 2024-05-29T15:09:50Z

@wangcj05 @joshua-cogliati-inl the windows machine seems to be down since days. Can we merge this without that test?

moosebuild · 2024-05-29T15:14:55Z

Job Mingw Test on 0fd2726 : invalidated by @wangcj05

wangcj05

Some comments for you to consider. @alfoa

wangcj05 · 2024-05-30T14:49:41Z

ravenframework/utils/graphStructure.py

+    Method to evaluate the function execution order using graph theory
+    The order is stored in self.variableFunctionExecutionList


These two lines need to be updated.

wangcj05 · 2024-05-30T14:50:11Z

ravenframework/Models/EnsembleModel.py

+    #self.ensembleModelGraph = graphStructure.graphObject(modelsToOutputModels)
+    self.ensembleModelGraph = modelsGraph #graphStructure.graphObject(modelsToOutputModels)
    # make some checks
    if not self.ensembleModelGraph.isConnectedNet():
      isolatedModels = self.ensembleModelGraph.findIsolatedVertices()
      self.raiseAnError(IOError, "Some models are not connected. Possible candidates are: "+' '.join(isolatedModels))
    # get all paths
-    allPath = self.ensembleModelGraph.findAllUniquePaths(self.initialStartModels)
+    #allPath = self.ensembleModelGraph.findAllUniquePaths(self.initialStartModels)
    ###################################################
    # to be removed once executionList can be handled #
-    self.orderList = self.ensembleModelGraph.createSingleListOfVertices(allPath)
+    #self.ensembleModelGraph.createSingleListOfVertices(allPath)


Do you want to keep the commented lines?

moosebuild · 2024-05-30T15:10:21Z

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

restarted civet

moosebuild · 2024-05-30T15:14:48Z

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

restarted civet

moosebuild · 2024-05-31T01:07:57Z

Job Mingw Test on 0fd2726 : invalidated by @alfoa

ravenframework/utils/graphStructure.py

ravenframework/Models/EnsembleModel.py

ravenframework/utils/graphStructure.py

alfoa · 2024-05-31T16:30:54Z

@wangcj05 @joshua-cogliati-inl Unfortunately windows machine still has issues... (now with the set environment).

moosebuild · 2024-06-03T14:00:26Z

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

failed trying to download icu-73.2-h63175ca_0.conda

moosebuild · 2024-06-03T21:23:43Z

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

updated conda

moosebuild · 2024-06-05T20:55:23Z

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

Failed in set python evnvironment (warning libmamba Could not parse mod/etag header)

alfoa · 2024-06-07T14:25:44Z

Is this good to be merged? @wangcj05 @joshua-cogliati-inl ?

wangcj05

changes are good.

wangcj05 · 2024-06-07T14:37:22Z

PR is good, and checklist is satisfied.

…ers (#2319) * moved samplers-optimizers function tests in their own folder for clarity * renamed * modified test names and revisions * moved subfolders * Closes #2302 * usage base class function evaluation method in ensembleForward * added error msg for detection of loop in function system * added test for ensemble model passing strings (restart file paths) around * removed trailing spaces * Update ravenframework/Samplers/EnsembleForward.py * Update ravenframework/Samplers/Sampler.py * Update ravenframework/Samplers/Sampler.py * Update ravenframework/Samplers/Sampler.py * fixed comment * we always check for isolated functions * updated model.tex * changed order to reflect order of appearance in the introduction of the Model sections * modified test description to make them latex compatible * specialization for EnsembleForward and CustomSampler * Apply suggestions from code review addressed Congjian's comments * Apply suggestions from code review * Apply suggestions from code review * Update ravenframework/Samplers/Sampler.py * updated setuptools dep * updated to simply ver 69 * added utility function as Congjian's request * plot entity * model order * added starting models * Apply suggestions from code review * Update ravenframework/utils/graphStructure.py --------- Co-authored-by: Congjian Wang - INL <congjian.wang@inl.gov>

alfoa added 8 commits May 14, 2024 14:17

moved samplers-optimizers function tests in their own folder for clarity

c97e112

renamed

1a721e0

modified test names and revisions

dde95ae

moved subfolders

3d79cdb

Closes #2302

e5c7ef4

usage base class function evaluation method in ensembleForward

8db6b58

added error msg for detection of loop in function system

4e0621d

added test for ensemble model passing strings (restart file paths) ar…

9600e81

…ound

alfoa commented May 15, 2024

View reviewed changes

alfoa added the Ready To Review label May 15, 2024

removed trailing spaces

7deed0a

alfoa requested review from wangcj05 and mandd May 15, 2024 15:02

alfoa commented May 15, 2024

View reviewed changes

ravenframework/Samplers/EnsembleForward.py Outdated Show resolved Hide resolved

Update ravenframework/Samplers/EnsembleForward.py

cfbe01e

alfoa commented May 15, 2024

View reviewed changes

ravenframework/Samplers/Sampler.py Outdated Show resolved Hide resolved

Update ravenframework/Samplers/Sampler.py

d6e0159

alfoa commented May 16, 2024

View reviewed changes

ravenframework/Samplers/Sampler.py Outdated Show resolved Hide resolved

Update ravenframework/Samplers/Sampler.py

142f61e

alfoa commented May 16, 2024

View reviewed changes

ravenframework/Samplers/Sampler.py Outdated Show resolved Hide resolved

alfoa added 8 commits May 16, 2024 07:43

Update ravenframework/Samplers/Sampler.py

4a767df

fixed comment

1a9bac5

Merge branch 'devel' into alfoa/functions_graph_theory

3387f85

we always check for isolated functions

e4accf3

updated model.tex

f8703ba

changed order to reflect order of appearance in the introduction of t…

6e09e02

…he Model sections

modified test description to make them latex compatible

efc347c

specialization for EnsembleForward and CustomSampler

5c0f684

alfoa added 4 commits May 28, 2024 10:34

added utility function as Congjian's request

beddaca

plot entity

5a7b576

model order

89eb00f

added starting models

0fd2726

wangcj05 reviewed May 30, 2024

View reviewed changes