wandb 0.22.1__py3-none-win_amd64.whl → 0.22.3__py3-none-win_amd64.whl

wandb/sdk/wandb_settings.py

@@ -157,9 +157,11 @@ def _path_convert(*args: str) -> str:
 
 
 CLIENT_ONLY_SETTINGS = (
-    "reinit",
+    "files_dir",
     "max_end_of_run_history_metrics",
     "max_end_of_run_summary_metrics",
+    "reinit",
+    "x_files_dir",
     "x_sync_dir_suffix",
 )
 """Python-only keys that are not fields on the settings proto."""
@@ -239,25 +241,53 @@ class Settings(BaseModel, validate_assignment=True):
     """The type of console capture to be applied.
 
     Possible values are:
-      "auto" - Automatically selects the console capture method based on the
+    - "auto" - Automatically selects the console capture method based on the
       system environment and settings.
+    - "off" - Disables console capture.
+    - "redirect" - Redirects low-level file descriptors for capturing output.
+    - "wrap" - Overrides the write methods of sys.stdout/sys.stderr. Will be
+      mapped to either "wrap_raw" or "wrap_emu" based on the state of the system.
+    - "wrap_raw" - Same as "wrap" but captures raw output directly instead of
+      through an emulator. Derived from the `wrap` setting and should not be set manually.
+    - "wrap_emu" - Same as "wrap" but captures output through an emulator.
+      Derived from the `wrap` setting and should not be set manually.
+    """
 
-      "off" - Disables console capture.
+    console_multipart: bool = False
+    """Enable multipart console logging.
 
-      "redirect" - Redirects low-level file descriptors for capturing output.
+    When True, the SDK writes console output to timestamped files
+    under the `logs/` directory instead of a single `output.log`.
 
-      "wrap" - Overrides the write methods of sys.stdout/sys.stderr. Will be
-      mapped to either "wrap_raw" or "wrap_emu" based on the state of the system.
+    Each part is uploaded as soon as it is closed, giving users live
+    access to logs while the run is active. Rollover cadence is
+    controlled by `console_chunk_max_bytes` and/or `console_chunk_max_seconds`.
+    If both limits are `0`, all logs are uploaded once at run finish.
 
-      "wrap_raw" - Same as "wrap" but captures raw output directly instead of
-      through an emulator. Derived from the `wrap` setting and should not be set manually.
+    Note: Uploaded chunks are immutable; terminal control sequences
+    that modify previous lines (e.g., progress bars using carriage returns)
+    only affect the current chunk.
+    """
 
-      "wrap_emu" - Same as "wrap" but captures output through an emulator.
-      Derived from the `wrap` setting and should not be set manually.
+    console_chunk_max_bytes: int = 0
+    """Size-based rollover threshold for multipart console logs, in bytes.
+
+    Starts a new console log file when the current part reaches this
+    size. Has an effect only when `console_multipart` is `True`.
+    Can be combined with `console_chunk_max_seconds`; whichever limit is
+    hit first triggers the rollover. A value of `0` disables the
+    size-based limit.
     """
 
-    console_multipart: bool = False
-    """Whether to produce multipart console log files."""
+    console_chunk_max_seconds: int = 0
+    """Time-based rollover threshold for multipart console logs, in seconds.
+
+    Starts a new console log file after this many seconds have elapsed
+    since the current part began. Requires `console_multipart` to be
+    `True`.  May be used with `console_chunk_max_bytes`; the first limit
+    reached closes the part. A value of `0` disables the time-based
+    limit.
+    """
 
     credentials_file: str = Field(
         default_factory=lambda: str(credentials.DEFAULT_WANDB_CREDENTIALS_FILE)
@@ -661,6 +691,9 @@ class Settings(BaseModel, validate_assignment=True):
     x_files_dir: Optional[str] = None
     """Override setting for the computed files_dir.
 
+    DEPRECATED, DO NOT USE. This private setting is not respected by wandb-core
+    but will continue to work for some legacy Python code.
+
     <!-- lazydoc-ignore-class-attributes -->
     """
 
@@ -1084,6 +1117,30 @@ class Settings(BaseModel, validate_assignment=True):
 
         return "wrap"
 
+    @field_validator("console_chunk_max_bytes", mode="after")
+    @classmethod
+    def validate_console_chunk_max_bytes(cls, value):
+        """Validate the console_chunk_max_bytes value.
+
+        <!-- lazydoc-ignore: internal -->
+        """
+        if value < 0:
+            raise ValueError("console_chunk_max_bytes must be non-negative")
+
+        return value
+
+    @field_validator("console_chunk_max_seconds", mode="after")
+    @classmethod
+    def validate_console_chunk_max_seconds(cls, value):
+        """Validate the console_chunk_max_seconds value.
+
+        <!-- lazydoc-ignore: internal -->
+        """
+        if value < 0:
+            raise ValueError("console_chunk_max_seconds must be non-negative")
+
+        return value
+
     @field_validator("x_executable", mode="before")
     @classmethod
     def validate_x_executable(cls, value):
@@ -1652,6 +1709,7 @@ class Settings(BaseModel, validate_assignment=True):
     @property
     def files_dir(self) -> str:
         """Absolute path to the local directory where the run's files are stored."""
+        # Must match the logic in settings.go in the service process.
         return self.x_files_dir or _path_convert(self.sync_dir, "files")
 
     @computed_field  # type: ignore[prop-decorator]
@@ -1913,24 +1971,7 @@ class Settings(BaseModel, validate_assignment=True):
         program = self.program or self._get_program()
 
         if program is not None:
-            try:
-                root = (
-                    GitRepo().root or os.getcwd()
-                    if not self.disable_git
-                    else os.getcwd()
-                )
-            except Exception:
-                # if the git command fails, fall back to the current working directory
-                root = os.getcwd()
-
-            self.program_relpath = self.program_relpath or self._get_program_relpath(
-                program, root
-            )
-            program_abspath = os.path.abspath(
-                os.path.join(root, os.path.relpath(os.getcwd(), root), program)
-            )
-            if os.path.exists(program_abspath):
-                self.program_abspath = program_abspath
+            self._setup_code_paths(program)
         else:
             program = "<python with no main file>"
 
@@ -2195,3 +2236,46 @@ class Settings(BaseModel, validate_assignment=True):
             This is a compatibility property for Pydantic v1 to mimic v2's model_fields_set.
             """
             return getattr(self, "__fields_set__", set())
+
+    def _setup_code_paths(self, program: str):
+        """Sets the program_abspath and program_relpath settings."""
+        if self._jupyter and self.x_jupyter_root:
+            self._infer_code_paths_for_jupyter(program)
+        else:
+            self._infer_code_path_for_program(program)
+
+    def _infer_code_path_for_program(self, program: str):
+        """Finds the program's absolute and relative paths."""
+        try:
+            root = (
+                GitRepo().root or os.getcwd() if not self.disable_git else os.getcwd()
+            )
+        except Exception:
+            # if the git command fails, fall back to the current working directory
+            root = os.getcwd()
+
+        self.program_relpath = self.program_relpath or self._get_program_relpath(
+            program, root
+        )
+
+        program_abspath = os.path.abspath(
+            os.path.join(root, os.path.relpath(os.getcwd(), root), program)
+        )
+
+        if os.path.exists(program_abspath):
+            self.program_abspath = program_abspath
+
+    def _infer_code_paths_for_jupyter(self, program: str):
+        """Find the notebook's absolute and relative paths.
+
+        Since the notebook's execution environment
+        is not the same as the current working directory.
+        We utilize the metadata provided by the jupyter server.
+        """
+        if not self.x_jupyter_root or not program:
+            return None
+
+        self.program_abspath = os.path.abspath(
+            os.path.join(self.x_jupyter_root, program)
+        )
+        self.program_relpath = program

{wandb-0.22.1.dist-info → wandb-0.22.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: wandb
-Version: 0.22.1
+Version: 0.22.3
 Summary: A CLI and library for interacting with the Weights & Biases API.
 Project-URL: Source, https://github.com/wandb/wandb
 Project-URL: Bug Reports, https://github.com/wandb/wandb/issues
@@ -42,6 +42,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: System :: Logging