Experiment Preview

setup.py

@@ -107,8 +107,11 @@
 
 # check for compatible python versions
 if not build_env.is_compatible_python(versions.PYTHON_MIN):
-    print("You are using Python {}. Python >={} is required.".format(build_env.python_version,
-                                                                     ".".join((versions.PYTHON_MIN))))
+    print(
+        "You are using Python {}. Python >={} is required.".format(
+            build_env.python_version, ".".join((versions.PYTHON_MIN))
+        )
+    )
     sys.exit(-1)
 
 if build_env.is_windows():
@@ -120,9 +123,11 @@
 # __version__ in smartsim/__init__.py
 smartsim_version = versions.write_version(setup_path)
 
+
 class BuildError(Exception):
     pass
 
+
 # Hacky workaround for solving CI build "purelib" issue
 # see https://github.com/google/or-tools/issues/616
 class InstallPlatlib(install):
@@ -131,15 +136,14 @@ def finalize_options(self):
         if self.distribution.has_ext_modules():
             self.install_lib = self.install_platlib
 
-class SmartSimBuild(build_py):
 
+class SmartSimBuild(build_py):
     def run(self):
-        database_builder = builder.DatabaseBuilder(build_env(),
-                                             build_env.MALLOC,
-                                             build_env.JOBS)
+        database_builder = builder.DatabaseBuilder(
+            build_env(), build_env.MALLOC, build_env.JOBS
+        )
         if not database_builder.is_built:
-            database_builder.build_from_git(versions.REDIS_URL,
-                                         versions.REDIS)
+            database_builder.build_from_git(versions.REDIS_URL, versions.REDIS)
 
             database_builder.cleanup()
 
@@ -151,9 +155,10 @@ def run(self):
 class BinaryDistribution(Distribution):
     """Distribution which always forces a binary package with platform name
 
-       We use this because we want to pre-package Redis for certain
-       platforms to use.
+    We use this because we want to pre-package Redis for certain
+    platforms to use.
     """
+
     def has_ext_modules(_placeholder):
         return True
 
@@ -168,6 +173,7 @@ def has_ext_modules(_placeholder):
     "filelock>=3.4.2",
     "protobuf~=3.20",
     "watchdog>=3.0.0",
+    "jinja2",
 ]
 
 # Add SmartRedis at specific version
@@ -192,7 +198,7 @@ def has_ext_modules(_placeholder):
         "types-setuptools",
     ],
     # see smartsim/_core/_install/buildenv.py for more details
-    **versions.ml_extras_required()
+    **versions.ml_extras_required(),
 }
 
 
@@ -211,5 +217,5 @@ def has_ext_modules(_placeholder):
         "console_scripts": [
             "smart = smartsim._core._cli.__main__:main",
         ]
-    }
+    },
 )

smartsim/_core/__init__.py

@@ -24,7 +24,7 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from .control import Controller, Manifest
+from .control import Controller, Manifest, Viewexp
 from .generation import Generator
 
-__all__ = ["Controller", "Manifest", "Generator"]
+__all__ = ["Controller", "Manifest", "Generator", "Viewexp"]

smartsim/_core/control/__init__.py

@@ -26,3 +26,4 @@
 
 from .controller import Controller
 from .manifest import Manifest
+from .view import Viewexp

smartsim/_core/control/view.py

@@ -0,0 +1,43 @@
+# BSD 2-Clause License
+#
+# Copyright (c) 2021-2023, Hewlett Packard Enterprise
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+import typing as t
+import jinja2
+
+
+class Viewexp:
+    def __init__(self, exp_entity: t.Any) -> None:
+        self.exp_entity = exp_entity
+
+    def render(self) -> str:
+        """
+        Render the template from the supplied entity
+        """
+        loader = jinja2.PackageLoader("templates")
+        env = jinja2.Environment(loader=loader, autoescape=True)
+        tpl = env.get_template("master.pytpl")
+        template = tpl.render(exp_entity=self.exp_entity)
+
+        return template

smartsim/experiment.py

@@ -30,14 +30,13 @@
 from os import getcwd
 
 from tabulate import tabulate
-
-from ._core import Controller, Generator, Manifest
+from ._core import Controller, Generator, Manifest, Viewexp
 from ._core.utils import init_default
 from .database import Orchestrator
 from .entity import Ensemble, Model, SmartSimEntity
 from .error import SmartSimError
 from .log import get_logger
-from .settings import Container, base, settings
+from .settings import settings, base, Container
 from .wlm import detect_launcher
 
 logger = get_logger(__name__)
@@ -797,6 +796,56 @@
             logger.error(e)
             raise
 
+    def preview(
+        self,
+        output_format: t.Optional[str] = None,
+        output_filename: t.Optional[str] = None,
+        verbosity_level: t.Optional[str] = None,
+    ) -> str:
+        """Preview entity information prior to launch. This method
+        aggregates multiple pieces of information to give users insight
+        into what and how entities will be launched.  Any instance of
+        ``Model``, ``Ensemble`` or ``Orchestrator`` created by the
+        Experiment can be passed as an argument to the preview method.
+        param output_format: Set output destination. The possible accepted
+        output formats are `json`, `xml`, `html`, `plain_text`, `color_text`.
+        A filename is required if an output format is specified. If no output
+        format is set, the preview will be output to stdout. Defaults to None.
+        type output_type: str
+        param output_filename: Specify name of path to write preview data to.
+        Only needed when an output format has been specified. Defaults to None.
+        type output_filename: str
+        param verbosity level: the verbosity level.
+        info: Display User defined fields and entities
+        debug: Display user defined field and entities and auto generated
+        fields.
+        developer: Display user defined field and entities, auto generated
+        fields, and run commands.
+        Defaults to info.
+        type verbosity_level: str
+        """
+
+        if output_format:
+            raise NotImplementedError
+        if output_filename:
+            raise NotImplementedError
+        if verbosity_level:
+            raise NotImplementedError
+
+        return self._preview()
+
+    def _preview(self) -> str:
+        """String formatting"""
+
+        preview = Viewexp(self).render()
+        logger.info(preview)
+
+        return preview
+
+    def get_launcher(self) -> str:
+        """Get launcher"""
+        return self._launcher
+
     def summary(self, style: str = "github") -> str:
         """Return a summary of the ``Experiment``
 

templates/templates/experiment.pytpl

@@ -0,0 +1,4 @@
+=== Experiment Overview ===
+Experiment: {{ exp_entity.name }}
+Experiment Path: {{ exp_entity.exp_path }}
+Launcher: {{ exp_entity.get_launcher() }}

templates/templates/master.pytpl

@@ -0,0 +1,2 @@
+
+{% extends "experiment.pytpl" %}

tests/test_preview.py

@@ -0,0 +1,82 @@
+# BSD 2-Clause License
+#
+# Copyright (c) 2021-2023, Hewlett Packard Enterprise
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import pytest
+
+from smartsim import Experiment
+
+
+def test_experiment_preview(test_dir, wlmutils):
+    """Test correct preview output items for Experiment preview"""
+    test_launcher = wlmutils.get_test_launcher()
+    exp_name = "test_prefix"
+    exp = Experiment(exp_name, exp_path=test_dir, launcher=test_launcher)
+    # Call method for string formatting for testing
+    output = exp._preview().strip()
+    summary_lines = output.split("\n")
+    summary_lines = [item.replace("\t", "") for item in summary_lines[-3:]]
+    assert 3 == len(summary_lines)
+    summary_dict = dict(row.split(": ") for row in summary_lines)
+    assert set(["Experiment", "Experiment Path", "Launcher"]).issubset(summary_dict)
+
+
+def test_experiment_preview_properties(test_dir, wlmutils):
+    """Test correct preview output properties for Experiment preview"""
+    test_launcher = wlmutils.get_test_launcher()
+    exp_name = "test_experiment_preview_properties"
+    exp = Experiment(exp_name, exp_path=test_dir, launcher=test_launcher)
+    # Call method for string formatting for testing
+    output = exp._preview().strip()
+    summary_lines = output.split("\n")
+    summary_lines = [item.replace("\t", "") for item in summary_lines[-3:]]
+    assert 3 == len(summary_lines)
+    summary_dict = dict(row.split(": ") for row in summary_lines)
+    assert exp.name == summary_dict["Experiment"]
+    assert exp.exp_path == summary_dict["Experiment Path"]
+    assert exp.get_launcher() == summary_dict["Launcher"]
+
+def test_output_format_error():
+    exp_name = "test_output_format"
+    exp = Experiment(exp_name)
+
+    with pytest.raises(NotImplementedError):
+        exp.preview(output_format="hello")
+
+
+def test_output_filename_error():
+    exp_name = "test_output_filename"
+    exp = Experiment(exp_name)
+
+    with pytest.raises(NotImplementedError):
+        exp.preview(output_filename="hello")
+
+
+def test_verbosity_level_error():
+    exp_name = "test_verbosity_level"
+    exp = Experiment(exp_name)
+
+    with pytest.raises(NotImplementedError):
+        exp.preview(verbosity_level="hello")