update ref pages

Author: enriquetomasmb

docs/scripts/gen_ref_pages.py

@@ -11,7 +11,12 @@
 
 print(f"Generating API pages from {src}")
 
+excluded_dirs = ["tests", "utils", "config"]
+
 for path in sorted(src.rglob("*.py")):
+    if any(excluded in path.parts for excluded in excluded_dirs):
+        print(f"Skipping excluded directory: {path}")
+        continue
     print(f"Generating API page for {path}")
     module_path = path.relative_to(src).with_suffix("")
     print(f"Module path: {module_path}")

nebula/node.py

@@ -48,6 +48,31 @@
 
 
 async def main(config):
+    """
+    Main function to start the NEBULA node.
+
+    This function initiates the NEBULA core component deployed on each federation participant.
+    It configures the node using the provided configuration object, setting up dataset partitions,
+    selecting and initializing the appropriate model and data handler, and establishing training
+    mechanisms. Additionally, it adjusts specific node parameters (such as indices and timing intervals)
+    based on the participant's configuration, and deploys the node's network communications for
+    federated learning.
+
+    Parameters:
+        config (Config): Configuration object containing settings for:
+            - scenario (including federation and deployment parameters),
+            - model selection and its corresponding hyperparameters,
+            - dataset and data partitioning,
+            - training strategy and related arguments,
+            - device roles and security flags.
+
+    Raises:
+        ValueError: If an unsupported model, dataset, or device role is specified.
+        NotImplementedError: If an unsupported training strategy (e.g., "scikit") is requested.
+
+    Returns:
+        Coroutine that initializes and starts the NEBULA node.
+    """
     n_nodes = config.participant["scenario_args"]["n_nodes"]
     model_name = config.participant["model_args"]["model"]
     idx = config.participant["device_args"]["idx"]

nebula/scenarios.py

@@ -27,6 +27,10 @@
 
 # Definition of a scenario
 class Scenario:
+    """
+    Class to define a scenario for the NEBULA platform.
+    It contains all the parameters needed to create a scenario and run it on the platform.
+    """
     def __init__(
         self,
         scenario_title,

nebula/utils.py

@@ -6,6 +6,9 @@
 
 
 class FileUtils:
+    """
+    Utility class for file operations.
+    """
     @classmethod
     def check_path(cls, base_path, relative_path):
         full_path = os.path.normpath(os.path.join(base_path, relative_path))
@@ -17,6 +20,9 @@ def check_path(cls, base_path, relative_path):
 
 
 class SocketUtils:
+    """
+    Utility class for socket operations.
+    """
     @classmethod
     def is_port_open(cls, port):
         s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
@@ -36,6 +42,9 @@ def find_free_port(cls, start_port=49152, end_port=65535):
 
 
 class DockerUtils:
+    """
+    Utility class for Docker operations.
+    """
     @classmethod
     def create_docker_network(cls, network_name, subnet=None, prefix=24):
         try: