[Core] Add HTML reprs for ClientContext and WorkerContext (ray-pr…

…oject#25730)

python/ray/__init__.py

@@ -235,6 +235,7 @@ def __getattr__(self, attr):
  "timeline",
  "util",
  "wait",
+ "widgets",
  "LOCAL_MODE",
  "SCRIPT_MODE",
  "WORKER_MODE",

python/ray/_private/worker.py

@@ -84,6 +84,7 @@
 from ray.util.debug import log_once
 from ray.util.scheduling_strategies import PlacementGroupSchedulingStrategy
 from ray.util.tracing.tracing_helper import _import_from_string
+from ray.widgets import Template
 
 SCRIPT_MODE = 0
 WORKER_MODE = 1
@@ -971,6 +972,20 @@ def disconnect(self):
  # Include disconnect() to stay consistent with ClientContext
  ray.shutdown()
 
+ def _repr_html_(self):
+ if self.dashboard_url:
+ dashboard_row = Template("context_dashrow.html.j2").render(
+ dashboard_url=self.dashboard_url
+ )
+ else:
+ dashboard_row = None
+
+ return Template("context.html.j2").render(
+ python_version=self.python_version,
+ ray_version=self.ray_version,
+ dashboard_row=dashboard_row,
+ )
+
 
 global_worker = Worker()
 """Worker: The global Worker object for this worker process.

python/ray/client_builder.py

@@ -18,6 +18,7 @@
 from ray._private.worker import init as ray_driver_init
 from ray.job_config import JobConfig
 from ray.util.annotations import Deprecated, PublicAPI
+from ray.widgets import Template
 
 logger = logging.getLogger(__name__)
 
@@ -81,6 +82,20 @@ def _disconnect_with_context(self, force_disconnect: bool) -> None:
  # This is only a driver connected to an existing cluster.
  ray.shutdown()
 
+ def _repr_html_(self):
+ if self.dashboard_url:
+ dashboard_row = Template("context_dashrow.html.j2").render(
+ dashboard_url=self.dashboard_url
+ )
+ else:
+ dashboard_row = None
+
+ return Template("context.html.j2").render(
+ python_version=self.python_version,
+ ray_version=self.ray_version,
+ dashboard_row=dashboard_row,
+ )
+
 
 @Deprecated
 class ClientBuilder:

python/ray/widgets/__init__.py

@@ -0,0 +1,3 @@
+from ray.widgets.render import Template
+
+__all__ = ["Template"]

python/ray/widgets/render.py

@@ -0,0 +1,38 @@
+import pathlib
+from typing import List
+
+from ray.util.annotations import DeveloperAPI
+
+
+@DeveloperAPI
+class Template:
+ """Class which provides basic HTML templating."""
+
+ def __init__(self, file: str):
+ with open(pathlib.Path(__file__).parent / "templates" / file, "r") as f:
+ self.template = f.read()
+
+ def render(self, **kwargs) -> str:
+ """Render an HTML template with the given data.
+
+ This is done by replacing instances of `{{ key }}` with `value`
+ from the keyword arguments.
+
+ Returns:
+ str: HTML template with the keys of the kwargs replaced with corresponding
+ values.
+ """
+ rendered = self.template
+ for key, value in kwargs.items():
+ rendered = rendered.replace("{{ " + key + " }}", value if value else "")
+ return rendered
+
+ @staticmethod
+ def list_templates() -> List[pathlib.Path]:
+ """List the available HTML templates.
+
+ Returns:
+ List[pathlib.Path]: A list of files with .html.j2 extensions inside
+ ./templates/
+ """
+ return (pathlib.Path(__file__).parent / "templates").glob("*.html.j2")

python/ray/widgets/templates/context.html.j2

@@ -0,0 +1,37 @@
+<div>
+ <div style="margin-left: 50px;display: flex;flex-direction: row;align-items: center">
+ <h3 style="color: var(--jp-ui-font-color0)">Ray</h3>
+ <svg version="1.1" id="ray" width="3em" viewBox="0 0 144.5 144.6" style="margin-left: 3em;margin-right: 3em">
+ <g id="layer-1">
+ <path fill="#00a2e9" class="st0" d="M97.3,77.2c-3.8-1.1-6.2,0.9-8.3,5.1c-3.5,6.8-9.9,9.9-17.4,9.6S58,88.1,54.8,81.2c-1.4-3-3-4-6.3-4.1
+ c-5.6-0.1-9.9,0.1-13.1,6.4c-3.8,7.6-13.6,10.2-21.8,7.6C5.2,88.4-0.4,80.5,0,71.7c0.1-8.4,5.7-15.8,13.8-18.2
+ c8.4-2.6,17.5,0.7,22.3,8c1.3,1.9,1.3,5.2,3.6,5.6c3.9,0.6,8,0.2,12,0.2c1.8,0,1.9-1.6,2.4-2.8c3.5-7.8,9.7-11.8,18-11.9
+ c8.2-0.1,14.4,3.9,17.8,11.4c1.3,2.8,2.9,3.6,5.7,3.3c1-0.1,2,0.1,3,0c2.8-0.5,6.4,1.7,8.1-2.7s-2.3-5.5-4.1-7.5
+ c-5.1-5.7-10.9-10.8-16.1-16.3C84,38,81.9,37.1,78,38.3C66.7,42,56.2,35.7,53,24.1C50.3,14,57.3,2.8,67.7,0.5
+ C78.4-2,89,4.7,91.5,15.3c0.1,0.3,0.1,0.5,0.2,0.8c0.7,3.4,0.7,6.9-0.8,9.8c-1.7,3.2-0.8,5,1.5,7.2c6.7,6.5,13.3,13,19.8,19.7
+ c1.8,1.8,3,2.1,5.5,1.2c9.1-3.4,17.9-0.6,23.4,7c4.8,6.9,4.6,16.1-0.4,22.9c-5.4,7.2-14.2,9.9-23.1,6.5c-2.3-0.9-3.5-0.6-5.1,1.1
+ c-6.7,6.9-13.6,13.7-20.5,20.4c-1.8,1.8-2.5,3.2-1.4,5.9c3.5,8.7,0.3,18.6-7.7,23.6c-7.9,5-18.2,3.8-24.8-2.9
+ c-6.4-6.4-7.4-16.2-2.5-24.3c4.9-7.8,14.5-11,23.1-7.8c3,1.1,4.7,0.5,6.9-1.7C91.7,98.4,98,92.3,104.2,86c1.6-1.6,4.1-2.7,2.6-6.2
+ c-1.4-3.3-3.8-2.5-6.2-2.6C99.8,77.2,98.9,77.2,97.3,77.2z M72.1,29.7c5.5,0.1,9.9-4.3,10-9.8c0-0.1,0-0.2,0-0.3
+ C81.8,14,77,9.8,71.5,10.2c-5,0.3-9,4.2-9.3,9.2c-0.2,5.5,4,10.1,9.5,10.3C71.8,29.7,72,29.7,72.1,29.7z M72.3,62.3
+ c-5.4-0.1-9.9,4.2-10.1,9.7c0,0.2,0,0.3,0,0.5c0.2,5.4,4.5,9.7,9.9,10c5.1,0.1,9.9-4.7,10.1-9.8c0.2-5.5-4-10-9.5-10.3
+ C72.6,62.3,72.4,62.3,72.3,62.3z M115,72.5c0.1,5.4,4.5,9.7,9.8,9.9c5.6-0.2,10-4.8,10-10.4c-0.2-5.4-4.6-9.7-10-9.7
+ c-5.3-0.1-9.8,4.2-9.9,9.5C115,72.1,115,72.3,115,72.5z M19.5,62.3c-5.4,0.1-9.8,4.4-10,9.8c-0.1,5.1,5.2,10.4,10.2,10.3
+ c5.6-0.2,10-4.9,9.8-10.5c-0.1-5.4-4.5-9.7-9.9-9.6C19.6,62.3,19.5,62.3,19.5,62.3z M71.8,134.6c5.9,0.2,10.3-3.9,10.4-9.6
+ c0.5-5.5-3.6-10.4-9.1-10.8c-5.5-0.5-10.4,3.6-10.8,9.1c0,0.5,0,0.9,0,1.4c-0.2,5.3,4,9.8,9.3,10
+ C71.6,134.6,71.7,134.6,71.8,134.6z"/>
+ </g>
+ </svg>
+ <table>
+ <tr>
+ <td style="text-align: left"><b>Python version:</b></td>
+ <td style="text-align: left"><b>{{ python_version }}</b></td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><b>Ray version:</b></td>
+ <td style="text-align: left"><b> {{ ray_version }}</b></td>
+ </tr>
+ {{ dashboard_row }}
+ </table>
+ </div>
+</div>

python/ray/widgets/templates/context_dashrow.html.j2

@@ -0,0 +1,4 @@
+<tr>
+ <td style="text-align: left"><b>Dashboard:</b></td>
+ <td style="text-align: left"><b><a href="{{ dashboard_url }}" target="_blank">{{ dashboard_url }}</a></b></td>
+</tr>