update docstrings

Signed-off-by: Samhita Alla <[email protected]>

Author: samhita-alla

plugins/wandb/src/flyteplugins/wandb/__init__.py

@@ -237,9 +237,9 @@ def download_wandb_run_dir(
 
     Downloaded contents:
 
-        - `summary.json` - final summary metrics (always exported)
-        - `metrics_history.json` - step-by-step metrics (if `include_history=True`)
-        - Plus any files synced by wandb (`requirements.txt`, `wandb_metadata.json`, etc.)
+        - summary.json - final summary metrics (always exported)
+        - metrics_history.json - step-by-step metrics (if include_history=True)
+        - Plus any files synced by wandb (requirements.txt, wandb_metadata.json, etc.)
 
     Args:
         run_id: The wandb run ID to download. If `None`, uses the current run's ID

plugins/wandb/src/flyteplugins/wandb/_context.py

@@ -204,19 +204,19 @@ def wandb_config(
     2. As a context manager - overrides config for specific tasks
 
     Args:
-        project: wandb project name
-        entity: wandb entity (team or username)
-        id: unique run id (auto-generated if not provided)
-        name: human-readable run name
-        tags: list of tags for organizing runs
-        config: dictionary of hyperparameters
+        project: W&B project name
+        entity: W&B entity (team or username)
+        id: Unique run id (auto-generated if not provided)
+        name: Human-readable run name
+        tags: List of tags for organizing runs
+        config: Dictionary of hyperparameters
         mode: "online", "offline" or "disabled"
-        group: group name for related runs
-        run_mode: flyte-specific run mode - "auto", "new" or "shared".
+        group: Group name for related runs
+        run_mode: Flyte-specific run mode - "auto", "new" or "shared".
             Controls whether tasks create new W&B runs or share existing ones
-        download_logs: if `True`, downloads wandb run files after task completes
+        download_logs: If `True`, downloads wandb run files after task completes
             and shows them as a trace output in the Flyte UI
-        **kwargs: additional `wandb.init()` parameters
+        **kwargs: Additional `wandb.init()` parameters
     """
     return _WandBConfig(
         project=project,
@@ -363,15 +363,10 @@ def wandb_sweep_config(
         project: W&B project for the sweep
         entity: W&B entity for the sweep
         prior_runs: List of prior run IDs to include in the sweep analysis
-        name: Sweep name (auto-generated as `"{run_name}-{action_name}"` if not provided)
-        download_logs: if `True`, downloads all sweep run files after task completes
+        name: Sweep name (auto-generated as `{run_name}-{action_name}` if not provided)
+        download_logs: If `True`, downloads all sweep run files after task completes
             and shows them as a trace output in the Flyte UI
-
-        **kwargs: additional sweep config parameters like:
-            - early_terminate: Early termination config
-            - description: Sweep description
-            - command: CLI command to run
-            - controller: Sweep controller config
+        **kwargs: additional sweep config parameters like `early_terminate`, `description`, `command`, etc.
 
     See: https://docs.wandb.ai/models/sweeps/sweep-config-keys
     """

plugins/wandb/src/flyteplugins/wandb/_decorator.py

@@ -196,16 +196,15 @@ def wandb_init(
 
     Args:
         run_mode: Controls whether to create a new W&B run or share an existing one:
-
-            - "auto" (default): Creates new run if no parent run exists, otherwise shares parent's run
-            - "new": Always creates a new wandb run with a unique ID
-            - "shared": Always shares the parent's run ID (useful for child tasks)
-        download_logs: if `True`, downloads wandb run files after task completes
+        - "auto" (default): Creates new run if no parent run exists, otherwise shares parent's run
+        - "new": Always creates a new wandb run with a unique ID
+        - "shared": Always shares the parent's run ID (useful for child tasks)
+        download_logs: If `True`, downloads wandb run files after task completes
             and shows them as a trace output in the Flyte UI. If None, uses
             the value from wandb_config() context if set.
         project: W&B project name (overrides context config if provided)
         entity: W&B entity/team name (overrides context config if provided)
-        **kwargs: additional `wandb.init()` parameters (tags, config, mode, etc.)
+        **kwargs: Additional `wandb.init()` parameters (tags, config, mode, etc.)
 
     Decorator Order:
         For tasks, @wandb_init must be the outermost decorator:

plugins/wandb/src/flyteplugins/wandb/_link.py

@@ -12,16 +12,17 @@ class Wandb(Link):
     Generates a Weights & Biases run link.
 
     Args:
-        host: base W&B host URL
+        host: Base W&B host URL
         project: W&B project name (overrides context config if provided)
         entity: W&B entity/team name (overrides context config if provided)
-        run_mode: controls whether to create a new W&B run or share an existing one:
+        run_mode: Controls whether to create a new W&B run or share an existing one:
 
             - "auto" (default): Creates new run if no parent run exists, otherwise shares parent's run
             - "new": Always creates a new wandb run with a unique ID
             - "shared": Always shares the parent's run ID (useful for child tasks)
-        id: optional W&B run ID (overrides context config if provided)
-        name: link name in the Flyte UI
+
+        id: Optional W&B run ID (overrides context config if provided)
+        name: Link name in the Flyte UI
     """
 
     host: str = "https://wandb.ai"
@@ -96,11 +97,11 @@ class WandbSweep(Link):
     Generates a Weights & Biases Sweep link.
 
     Args:
-        host: base W&B host URL
+        host: Base W&B host URL
         project: W&B project name (overrides context config if provided)
         entity: W&B entity/team name (overrides context config if provided)
-        id: optional W&B sweep ID (overrides context config if provided)
-        name: link name in the Flyte UI
+        id: Optional W&B sweep ID (overrides context config if provided)
+        name: Link name in the Flyte UI
     """
 
     host: str = "https://wandb.ai"