Merge pull request #8890 from OpenMined/node_description

Add node description field on node metadata
OpenMined · Jun 26, 2024 · ee68336 · ee68336
2 parents 71be405 + 478ef9c
commit ee68336
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/packages/syft/src/syft/service/settings/settings.py b/packages/syft/src/syft/service/settings/settings.py
@@ -85,6 +85,7 @@ class NodeSettings(SyftObject):
     __repr_attrs__ = [
         "name",
         "organization",
+        "description",
         "deployed_on",
         "signup_enabled",
         "admin_email",
@@ -96,7 +97,7 @@ class NodeSettings(SyftObject):
     organization: str = "OpenMined"
     verify_key: SyftVerifyKey
     on_board: bool = True
-    description: str = "Text"
+    description: str = "This is the default description for a Domain Node."
     node_type: NodeType = NodeType.DOMAIN
     signup_enabled: bool
     admin_email: str
@@ -119,6 +120,7 @@ def _repr_html_(self) -> Any:
                 <p><strong>Id: </strong>{self.id}</p>
                 <p><strong>Name: </strong>{self.name}</p>
                 <p><strong>Organization: </strong>{self.organization}</p>
+                <p><strong>Description: </strong>{self.description}</p>
                 <p><strong>Deployed on: </strong>{self.deployed_on}</p>
                 <p><strong>Signup enabled: </strong>{self.signup_enabled}</p>
                 <p><strong>Admin email: </strong>{self.admin_email}</p>

diff --git a/packages/syft/src/syft/service/settings/settings_service.py b/packages/syft/src/syft/service/settings/settings_service.py
@@ -353,6 +353,7 @@ def welcome_show(
                     FONT_CSS=FONT_CSS,
                     grid_symbol=load_png_base64("small-grid-symbol-logo.png"),
                     domain_name=context.node.name,
+                    description=context.node.metadata.description,
                     # node_url='http://testing:8080',
                     node_type=context.node.metadata.node_type.capitalize(),
                     node_side_type=node_side_type,

diff --git a/packages/syft/src/syft/util/schema.py b/packages/syft/src/syft/util/schema.py
@@ -59,6 +59,7 @@
             <h2>Welcome to $domain_name</h2>
             <div class="syft-space">
             <strong>URL:</strong> $node_url <br />
+            <strong>Node Description:</strong> $description <br />
             <strong>Node Type:</strong> $node_type <br />
             <strong>Node Side Type:</strong>$node_side_type<br />
             <strong>Syft Version:</strong> $node_version<br />