wandb 0.21.1__py3-none-win32.whl → 0.21.3__py3-none-win32.whl

wandb/sdk/wandb_run.py

@@ -2610,7 +2610,7 @@ class Run:
     ) -> Artifact:
         job_artifact = InternalArtifact(name, job_builder.JOB_ARTIFACT_TYPE)
         if patch_path and os.path.exists(patch_path):
-            job_artifact.add_file(FilePathStr(str(patch_path)), "diff.patch")
+            job_artifact.add_file(FilePathStr(patch_path), "diff.patch")
         with job_artifact.new_file("requirements.frozen.txt") as f:
             f.write("\n".join(installed_packages_list))
         with job_artifact.new_file("wandb-job.json") as f:
@@ -2723,7 +2723,6 @@ class Run:
             wait_with_progress(
                 exit_handle,
                 timeout=None,
-                progress_after=1,
                 display_progress=functools.partial(
                     self._display_finish_stats,
                     progress_printer,
@@ -2962,7 +2961,7 @@ class Run:
         artifact: Artifact,
         target_path: str,
         aliases: list[str] | None = None,
-    ) -> Artifact | None:
+    ) -> Artifact:
         """Link the given artifact to a portfolio (a promoted collection of artifacts).
 
         Linked artifacts are visible in the UI for the specified portfolio.
@@ -2976,7 +2975,7 @@ class Run:
             The alias "latest" will always be applied to the latest version of an artifact that is linked.
 
         Returns:
-            The linked artifact if linking was successful, otherwise None.
+            The linked artifact.
 
         """
         if artifact.is_draft() and not artifact._is_draft_save_started():
@@ -3888,64 +3887,101 @@ class Run:
         if settings.quiet or settings.silent:
             return
 
-        panel = []
+        panel: list[str] = []
 
-        # Render history if available
-        if history:
-            logger.info("rendering history")
+        if history and (
+            history_grid := Run._footer_history(history, printer, settings)
+        ):
+            panel.append(history_grid)
 
-            sampled_history = {
-                item.key: wandb.util.downsample(
-                    item.values_float or item.values_int, 40
-                )
-                for item in history.item
-                if not item.key.startswith("_")
-            }
+        if summary and (
+            summary_grid := Run._footer_summary(summary, printer, settings)
+        ):
+            panel.append(summary_grid)
 
-            history_rows = []
-            for key, values in sorted(sampled_history.items()):
-                if any(not isinstance(value, numbers.Number) for value in values):
-                    continue
-                sparkline = printer.sparklines(values)
-                if sparkline:
-                    history_rows.append([key, sparkline])
-            if history_rows:
-                history_grid = printer.grid(
-                    history_rows,
-                    "Run history:",
-                )
-                panel.append(history_grid)
+        if panel:
+            printer.display(printer.panel(panel))
 
-        # Render summary if available
-        if summary:
-            final_summary = {}
-            for item in summary.item:
-                if item.key.startswith("_") or len(item.nested_key) > 0:
-                    continue
-                final_summary[item.key] = json.loads(item.value_json)
-
-            logger.info("rendering summary")
-            summary_rows = []
-            for key, value in sorted(final_summary.items()):
-                # arrays etc. might be too large. for now, we just don't print them
-                if isinstance(value, str):
-                    value = value[:20] + "..." * (len(value) >= 20)
-                    summary_rows.append([key, value])
-                elif isinstance(value, numbers.Number):
-                    value = round(value, 5) if isinstance(value, float) else value
-                    summary_rows.append([key, str(value)])
-                else:
-                    continue
+    @staticmethod
+    def _footer_history(
+        history: SampledHistoryResponse,
+        printer: printer.Printer,
+        settings: Settings,
+    ) -> str | None:
+        """Returns the run history formatted for printing to the console."""
+        sorted_history_items = sorted(
+            (item for item in history.item if not item.key.startswith("_")),
+            key=lambda item: item.key,
+        )
 
-            if summary_rows:
-                summary_grid = printer.grid(
-                    summary_rows,
-                    "Run summary:",
-                )
-                panel.append(summary_grid)
+        history_rows: list[list[str]] = []
+        for item in sorted_history_items:
+            if len(history_rows) >= settings.max_end_of_run_history_metrics:
+                break
 
-        if panel:
-            printer.display(printer.panel(panel))
+            values = wandb.util.downsample(
+                item.values_float or item.values_int,
+                40,
+            )
+
+            if sparkline := printer.sparklines(values):
+                history_rows.append([item.key, sparkline])
+
+        if not history_rows:
+            return None
+
+        if len(history_rows) < len(sorted_history_items):
+            remaining = len(sorted_history_items) - len(history_rows)
+            history_rows.append([f"+{remaining:,d}", "..."])
+
+        return printer.grid(history_rows, "Run history:")
+
+    @staticmethod
+    def _footer_summary(
+        summary: GetSummaryResponse,
+        printer: printer.Printer,
+        settings: Settings,
+    ) -> str | None:
+        """Returns the run summary formatted for printing to the console."""
+        sorted_summary_items = sorted(
+            (
+                item
+                for item in summary.item
+                if not item.key.startswith("_") and not item.nested_key
+            ),
+            key=lambda item: item.key,
+        )
+
+        summary_rows: list[list[str]] = []
+        skipped = 0
+        for item in sorted_summary_items:
+            if len(summary_rows) >= settings.max_end_of_run_summary_metrics:
+                break
+
+            try:
+                value = json.loads(item.value_json)
+            except json.JSONDecodeError:
+                logger.exception(f"Error decoding summary[{item.key!r}]")
+                skipped += 1
+                continue
+
+            if isinstance(value, str):
+                value = value[:20] + "..." * (len(value) >= 20)
+                summary_rows.append([item.key, value])
+            elif isinstance(value, numbers.Number):
+                value = round(value, 5) if isinstance(value, float) else value
+                summary_rows.append([item.key, str(value)])
+            else:
+                skipped += 1
+
+        if not summary_rows:
+            return None
+
+        if len(summary_rows) < len(sorted_summary_items) - skipped:
+            remaining = len(sorted_summary_items) - len(summary_rows) - skipped
+            summary_rows.append([f"+{remaining:,d}", "..."])
+
+        return printer.grid(summary_rows, "Run summary:")
 
     @staticmethod
     def _footer_internal_messages(

wandb/sdk/wandb_settings.py

@@ -156,6 +156,14 @@ def _path_convert(*args: str) -> str:
     return os.path.expanduser(os.path.join(*args))
 
 
+CLIENT_ONLY_SETTINGS = (
+    "reinit",
+    "max_end_of_run_history_metrics",
+    "max_end_of_run_summary_metrics",
+)
+"""Python-only keys that are not fields on the settings proto."""
+
+
 class Settings(BaseModel, validate_assignment=True):
     """Settings for the W&B SDK.
 
@@ -469,6 +477,12 @@ class Settings(BaseModel, validate_assignment=True):
     settings_system: Optional[str] = None
     """Path to the system-wide settings file."""
 
+    max_end_of_run_history_metrics: int = 10
+    """Maximum number of history sparklines to display at the end of a run."""
+
+    max_end_of_run_summary_metrics: int = 10
+    """Maximum number of summary metrics to display at the end of a run."""
+
     show_colors: Optional[bool] = None
     """Whether to use colored output in the console.
 
@@ -1008,7 +1022,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_api_key(cls, value):
         """Validate the API key.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is not None and (len(value) > len(value.strip())):
             raise UsageError("API key cannot start or end with whitespace")
@@ -1019,7 +1033,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_base_url(cls, value):
         """Validate the base URL.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         validate_url(value)
         # wandb.ai-specific checks
@@ -1037,7 +1051,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_code_dir(cls, value):
         """Validate the code directory.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         # TODO: add native support for pathlib.Path
         if isinstance(value, pathlib.Path):
@@ -1049,7 +1063,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_console(cls, value, values):
         """Validate the console capture method.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value != "auto":
             return value
@@ -1061,7 +1075,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_x_executable(cls, value):
         """Validate the Python executable path.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         # TODO: add native support for pathlib.Path
         if isinstance(value, pathlib.Path):
@@ -1080,7 +1094,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_file_stream_max_line_bytes(cls, value):
         """Validate the maximum line length for filestream JSONL files.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is not None and value < 1:
             raise ValueError("File stream max line bytes must be greater than 0")
@@ -1091,7 +1105,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_x_files_dir(cls, value):
         """Validate the files directory.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         # TODO: add native support for pathlib.Path
         if isinstance(value, pathlib.Path):
@@ -1103,7 +1117,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_fork_from(cls, value, values) -> Optional[RunMoment]:
         """Validate the fork_from field.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         run_moment = cls._runmoment_preprocessor(value)
 
@@ -1131,7 +1145,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_http_proxy(cls, value):
         """Validate the HTTP proxy.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is None:
             return None
@@ -1143,7 +1157,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_https_proxy(cls, value):
         """Validate the HTTPS proxy.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is None:
             return None
@@ -1155,7 +1169,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_ignore_globs(cls, value):
         """Validate the ignore globs.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         return tuple(value) if not isinstance(value, tuple) else value
 
@@ -1164,7 +1178,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_program(cls, value):
         """Validate the program path.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         # TODO: add native support for pathlib.Path
         if isinstance(value, pathlib.Path):
@@ -1176,7 +1190,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_program_abspath(cls, value):
         """Validate the absolute program path.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         # TODO: add native support for pathlib.Path
         if isinstance(value, pathlib.Path):
@@ -1188,7 +1202,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_program_relpath(cls, value):
         """Validate the relative program path.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         # TODO: add native support for pathlib.Path
         if isinstance(value, pathlib.Path):
@@ -1200,7 +1214,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_project(cls, value, values):
         """Validate the project name.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is None:
             return None
@@ -1221,7 +1235,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_resume(cls, value):
         """Validate the resume behavior.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is False:
             return None
@@ -1234,7 +1248,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_resume_from(cls, value, values) -> Optional[RunMoment]:
         """Validate the resume_from field.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         run_moment = cls._runmoment_preprocessor(value)
 
@@ -1260,7 +1274,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_root_dir(cls, value):
         """Validate the root directory.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         # TODO: add native support for pathlib.Path
         if isinstance(value, pathlib.Path):
@@ -1272,7 +1286,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_run_id(cls, value, values):
         """Validate the run ID.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is None:
             return None
@@ -1295,7 +1309,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_settings_system(cls, value):
         """Validate the system settings file path.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is None:
             return None
@@ -1309,7 +1323,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_service_wait(cls, value):
         """Validate the service wait time.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value < 0:
             raise UsageError("Service wait time cannot be negative")
@@ -1320,7 +1334,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_start_method(cls, value):
         """Validate the start method for subprocesses.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is None:
             return value
@@ -1342,7 +1356,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_x_stats_gpu_device_ids(cls, value):
         """Validate the GPU device IDs.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if isinstance(value, str):
             return json.loads(value)
@@ -1353,7 +1367,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_x_stats_neuron_monitor_config_path(cls, value):
         """Validate the path to the neuron-monitor config file.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         # TODO: add native support for pathlib.Path
         if isinstance(value, pathlib.Path):
@@ -1365,7 +1379,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_stats_open_metrics_endpoints(cls, value):
         """Validate the OpenMetrics endpoints.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if isinstance(value, str):
             return json.loads(value)
@@ -1376,7 +1390,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_stats_open_metrics_filters(cls, value):
         """Validate the OpenMetrics filters.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if isinstance(value, str):
             return json.loads(value)
@@ -1387,7 +1401,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_stats_open_metrics_http_headers(cls, value):
         """Validate the OpenMetrics HTTP headers.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if isinstance(value, str):
             return json.loads(value)
@@ -1398,7 +1412,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_stats_sampling_interval(cls, value):
         """Validate the stats sampling interval.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value < 0.1:
             raise UsageError("Stats sampling interval cannot be less than 0.1 seconds")
@@ -1409,7 +1423,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_sweep_id(cls, value):
         """Validate the sweep ID.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is None:
             return None
@@ -1426,7 +1440,7 @@ class Settings(BaseModel, validate_assignment=True):
     def validate_sweep_param_path(cls, value):
         """Validate the sweep parameter path.
 
-        <!-- lazydoc-ignore: internal -->
+        <!-- lazydoc-ignore-classmethod: internal -->
         """
         # TODO: add native support for pathlib.Path
         if isinstance(value, pathlib.Path):
@@ -1857,8 +1871,7 @@ class Settings(BaseModel, validate_assignment=True):
         """Generate a protobuf representation of the settings."""
         settings_proto = wandb_settings_pb2.Settings()
         for k, v in self.model_dump(exclude_none=True).items():
-            # Client-only settings that don't exist on the protobuf.
-            if k in ("reinit",):
+            if k in CLIENT_ONLY_SETTINGS:
                 continue
 
             # Special case for x_stats_open_metrics_filters.