Skip to content

Refactor / remove ensemble.from_yaml/toml/json #1605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

Refactor / remove ensemble.from_yaml/toml/json #1605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4927bb2
remove capability, examples, tests for loading libE parameters from y…
jlnav Oct 24, 2025
dba3978
adjust dependencies
jlnav Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions docs/examples/calling_scripts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,6 @@ One worker runs a persistent generator and the other four run the forces simulat
:caption: tests/scaling_tests/forces/forces_simple/run_libe_forces.py
:linenos:

Object + yaml Version
~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: ../../libensemble/tests/scaling_tests/forces/forces_adv/run_libe_forces_from_yaml.py
:language: python
:caption: tests/scaling_tests/forces/forces_adv/run_libe_forces_from_yaml.py
:linenos:

.. literalinclude:: ../../libensemble/tests/scaling_tests/forces/forces_adv/forces.yaml
:language: yaml
:caption: tests/scaling_tests/forces/forces_adv/forces.yaml
:linenos:

Persistent APOSMM with Gradients
--------------------------------

Expand Down
213 changes: 0 additions & 213 deletions libensemble/ensemble.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import importlib
import json
import logging

import numpy.typing as npt
import tomli
import yaml

from libensemble.executors import Executor
from libensemble.libE import libE
Expand Down Expand Up @@ -117,110 +113,6 @@ class Ensemble:
experiment = Ensemble()
experiment.sim_specs = sim_specs

.. dropdown:: Option 3: Loading parameters from files

.. code-block:: python
:linenos:

from libensemble import Ensemble

experiment = Ensemble()

my_experiment.from_yaml("my_parameters.yaml")
# or...
my_experiment.from_toml("my_parameters.toml")
# or...
my_experiment.from_json("my_parameters.json")

.. tab-set::

.. tab-item:: my_parameters.yaml

.. code-block:: yaml
:linenos:

libE_specs:
save_every_k_gens: 20

exit_criteria:
sim_max: 80

gen_specs:
gen_f: generator.gen_random_sample
outputs:
x:
type: float
size: 1
user:
gen_batch_size: 5

sim_specs:
sim_f: simulator.sim_find_sine
inputs:
- x
outputs:
y:
type: float

.. tab-item:: my_parameters.toml

.. code-block:: toml
:linenos:

[libE_specs]
save_every_k_gens = 300

[exit_criteria]
sim_max = 80

[gen_specs]
gen_f = "generator.gen_random_sample"
[gen_specs.outputs]
[gen_specs.outputs.x]
type = "float"
size = 1
[gen_specs.user]
gen_batch_size = 5

[sim_specs]
sim_f = "simulator.sim_find_sine"
inputs = ["x"]
[sim_specs.outputs]
[sim_specs.outputs.y]
type = "float"

.. tab-item:: my_parameters.json

.. code-block:: json
:linenos:

{
"libE_specs": {
"save_every_k_gens": 300,
},
"exit_criteria": {
"sim_max": 80
},
"gen_specs": {
"gen_f": "generator.gen_random_sample",
"outputs": {
"x": {
"type": "float",
"size": 1
}
},
"user": {
"gen_batch_size": 5
}
},
"sim_specs": {
"sim_f": "simulator.sim_find_sine",
"inputs": ["x"],
"outputs": {
"f": {"type": "float"}
}
}
}

Parameters
----------
Expand Down Expand Up @@ -431,111 +323,6 @@ def nworkers(self, value):
if self._libE_specs:
self._libE_specs.nworkers = value

def _get_func(self, loaded):
"""Extracts user function specified in loaded dict"""
func_path_split = loaded.rsplit(".", 1)
func_name = func_path_split[-1]
try:
return getattr(importlib.import_module(func_path_split[0]), func_name)
except AttributeError:
self._util_logger.manager_warning(ATTR_ERR_MSG.format(func_name))
raise
except ModuleNotFoundError:
self._util_logger.manager_warning(NOTFOUND_ERR_MSG.format(func_name))
raise

@staticmethod
def _get_outputs(loaded):
"""Extracts output parameters from loaded dict"""
if not loaded:
return []
fields = [i for i in loaded]
field_params = [i for i in loaded.values()]
results = []
for i in range(len(fields)):
field_type = field_params[i]["type"]
built_in_type = __builtins__.get(field_type, field_type)
try:
if field_params[i]["size"] == 1:
size = (1,) # formatting how size=1 is typically preferred
else:
size = field_params[i]["size"]
results.append((fields[i], built_in_type, size))
except KeyError:
results.append((fields[i], built_in_type))
return results

@staticmethod
def _get_normal(loaded):
return loaded

def _get_option(self, specs, name):
"""Gets a specs value, underlying spec is either a dict or a class"""
attr = getattr(self, specs)
if isinstance(attr, dict):
return attr.get(name)
else:
return getattr(attr, name)

def _parse_spec(self, loaded_spec):
"""Parses and creates traditional libEnsemble dictionary from loaded dict info"""

field_f = {
"sim_f": self._get_func,
"gen_f": self._get_func,
"alloc_f": self._get_func,
"inputs": self._get_normal,
"persis_in": self._get_normal,
"outputs": self._get_outputs,
"globus_compute_endpoint": self._get_normal,
"user": self._get_normal,
}

userf_fields = [f for f in loaded_spec if f in field_f.keys()]

if len(userf_fields):
for f in userf_fields:
loaded_spec[f] = field_f[f](loaded_spec[f])

return loaded_spec

def _parameterize(self, loaded):
"""Updates and sets attributes from specs loaded from file"""
for f in loaded:
loaded_spec = self._parse_spec(loaded[f])
old_spec = getattr(self, f)
ClassType = CORRESPONDING_CLASSES[f]
if isinstance(old_spec, dict):
old_spec.update(loaded_spec)
if old_spec.get("in") and old_spec.get("inputs"):
old_spec.pop("inputs") # avoid clashes
elif old_spec.get("out") and old_spec.get("outputs"):
old_spec.pop("outputs") # avoid clashes
setattr(self, f, ClassType(**old_spec))
else: # None. attribute not set yet
setattr(self, f, ClassType(**loaded_spec))

def from_yaml(self, file_path: str):
"""Parameterizes libEnsemble from ``yaml`` file"""
with open(file_path, "r") as f:
loaded = yaml.full_load(f)

self._parameterize(loaded)

def from_toml(self, file_path: str):
"""Parameterizes libEnsemble from ``toml`` file"""
with open(file_path, "rb") as f:
loaded = tomli.load(f)

self._parameterize(loaded)

def from_json(self, file_path: str):
"""Parameterizes libEnsemble from ``json`` file"""
with open(file_path, "rb") as f:
loaded = json.load(f)

self._parameterize(loaded)

def add_random_streams(self, num_streams: int = 0, seed: str = ""):
"""

Expand Down
32 changes: 0 additions & 32 deletions libensemble/tests/functionality_tests/1d_sampling.json
View file
Open in desktop

This file was deleted.

22 changes: 0 additions & 22 deletions libensemble/tests/functionality_tests/1d_sampling.toml
View file
Open in desktop

This file was deleted.

24 changes: 0 additions & 24 deletions libensemble/tests/functionality_tests/1d_sampling.yaml
View file
Open in desktop

This file was deleted.

44 changes: 0 additions & 44 deletions libensemble/tests/functionality_tests/test_1d_sampling_from_files.py
View file
Open in desktop

This file was deleted.

Loading