wandb 0.17.9__py3-none-any.whl → 0.18.0rc1__py3-none-any.whl

wandb/__init__.py

@@ -8,7 +8,7 @@ For scripts and interactive notebooks, see https://github.com/wandb/examples.
 
 For reference documentation, see https://docs.wandb.com/ref/python.
 """
-__version__ = "0.17.9"
+__version__ = "0.18.0rc1"
 
 from typing import Optional
 
@@ -206,11 +206,6 @@ if "dev" in __version__:
         wandb.env.ERROR_REPORTING, "false"
     )
 
-    # turn on wandb-core for dev versions
-    if not wandb.env.is_require_legacy_service():
-        os.environ[wandb.env._REQUIRE_CORE] = os.environ.get(
-            wandb.env._REQUIRE_CORE, "true")
-
 _sentry = _Sentry()
 _sentry.setup()
 

wandb/__init__.pyi

@@ -79,7 +79,7 @@ from wandb.sdk.wandb_run import Run
 from wandb.sdk.wandb_setup import _WandbSetup
 from wandb.wandb_controller import _WandbController
 
-__version__: str = "0.17.9"
+__version__: str = "0.18.0rc1"
 
 run: Optional[Run] = None
 config = wandb_config.Config
@@ -147,7 +147,7 @@ def setup(
 
             # Optional: Explicitly shut down the backend
             wandb.teardown()
-    ```
+        ```
     """
     ...
 
@@ -343,6 +343,7 @@ def init(
             mode if a user isn't logged in to W&B. (default: `False`)
         sync_tensorboard: (bool, optional) Synchronize wandb logs from tensorboard or
             tensorboardX and save the relevant events file. (default: `False`)
+        tensorboard: (bool, optional) Alias for `sync_tensorboard`, deprecated.
         monitor_gym: (bool, optional) Automatically log videos of environment when
             using OpenAI Gym. (default: `False`)
             See [our guide to this integration](https://docs.wandb.com/guides/integrations/openai-gym).
@@ -356,6 +357,12 @@ def init(
             a moment in a previous run to fork a new run from. Creates a new run that picks up
             logging history from the specified run at the specified moment. The target run must
             be in the current project. Example: `fork_from="my-run-id?_step=1234"`.
+        resume_from: (str, optional) A string with the format {run_id}?_step={step} describing
+            a moment in a previous run to resume a run from. This allows users to truncate
+            the history logged to a run at an intermediate step and resume logging from that step.
+            It uses run forking under the hood. The target run must be in the
+            current project. Example: `resume_from="my-run-id?_step=1234"`.
+        settings: (dict, wandb.Settings, optional) Settings to use for this run. (default: None)
 
     Examples:
     ### Set where the run is logged
@@ -393,7 +400,7 @@ def init(
         KeyboardInterrupt: if user interrupts the run.
 
     Returns:
-    A `Run` object.
+        A `Run` object.
     """
     ...
 
@@ -405,7 +412,7 @@ def finish(exit_code: Optional[int] = None, quiet: Optional[bool] = None) -> Non
 
     Arguments:
         exit_code: Set to something other than 0 to mark a run as failed
-    quiet: Set to true to minimize log output
+        quiet: Set to true to minimize log output
     """
     ...
 
@@ -430,6 +437,7 @@ def login(
             "allow", only create an anonymous user if the user
             isn't already logged in. If set to "never", never log a
             user anonymously. Default set to "never".
+        key: (string, optional) The API key to use.
         relogin: (bool, optional) If true, will re-prompt for API key.
         host: (string, optional) The host to connect to.
         force: (bool, optional) If true, will force a relogin.
@@ -441,7 +449,7 @@ def login(
 
     Raises:
         AuthenticationError - if api_key fails verification with the server
-    UsageError - if api_key cannot be configured and no tty
+        UsageError - if api_key cannot be configured and no tty
     """
     ...
 
@@ -675,7 +683,7 @@ def log(
 
     Raises:
         wandb.Error: if called before `wandb.init`
-    ValueError: if invalid data is passed
+        ValueError: if invalid data is passed
     """
     ...
 
@@ -729,7 +737,7 @@ def save(
     Returns:
         Paths to the symlinks created for the matched files.
 
-    For historical reasons, this may return a boolean in legacy code.
+        For historical reasons, this may return a boolean in legacy code.
     """
     ...
 
@@ -766,7 +774,7 @@ def sweep(
       prior_runs: The run IDs of existing runs to add to this sweep.
 
     Returns:
-    sweep_id: str. A unique identifier for the sweep.
+      sweep_id: str. A unique identifier for the sweep.
     """
     ...
 
@@ -786,7 +794,7 @@ def controller(
         print(tuner.sweep_id)
         tuner.configure_search(...)
         tuner.configure_stopping(...)
-    ```
+        ```
     """
     ...
 
@@ -816,7 +824,7 @@ def agent(
         project: The name of the project where W&B runs created from
             the sweep are sent to. If the project is not specified, the
             run is sent to a project labeled "Uncategorized".
-    count: The number of sweep config trials to try.
+        count: The number of sweep config trials to try.
     """
     ...
 
@@ -853,7 +861,7 @@ def define_metric(
             previous calls.
 
     Returns:
-    An object that represents this call but can otherwise be discarded.
+        An object that represents this call but can otherwise be discarded.
     """
     ...
 
@@ -862,6 +870,7 @@ def log_artifact(
     name: Optional[str] = None,
     type: Optional[str] = None,
     aliases: Optional[List[str]] = None,
+    tags: Optional[List[str]] = None,
 ) -> Artifact:
     """Declare an artifact as an output of a run.
 
@@ -882,9 +891,10 @@ def log_artifact(
         type: (str) The type of artifact to log, examples include `dataset`, `model`
         aliases: (list, optional) Aliases to apply to this artifact,
             defaults to `["latest"]`
+        tags: (list, optional) Tags to apply to this artifact, if any.
 
     Returns:
-    An `Artifact` object.
+        An `Artifact` object.
     """
     ...
 
@@ -911,7 +921,7 @@ def use_artifact(
                                    Will be shown in UI.
 
     Returns:
-    An `Artifact` object.
+        An `Artifact` object.
     """
     ...
 
@@ -957,7 +967,7 @@ def log_model(
         ValueError: if name has invalid special characters
 
     Returns:
-    None
+        None
     """
     ...
 
@@ -998,7 +1008,7 @@ def use_model(name: str) -> FilePathStr:
         AssertionError: if model artifact 'name' is of a type that does not contain the substring 'model'.
 
     Returns:
-    path: (str) path to downloaded model artifact file(s).
+        path: (str) path to downloaded model artifact file(s).
     """
     ...
 
@@ -1030,7 +1040,7 @@ def link_model(
         registered_model_name: (str) - the name of the registered model that the model is to be linked to.
             A registered model is a collection of model versions linked to the model registry, typically representing a
             team's specific ML Task. The entity that this registered model belongs to will be derived from the run
-            name: (str, optional) - the name of the model artifact that files in 'path' will be logged to. This will
+        name: (str, optional) - the name of the model artifact that files in 'path' will be logged to. This will
             default to the basename of the path prepended with the current run id  if not specified.
         aliases: (List[str], optional) - alias(es) that will only be applied on this linked artifact
             inside the registered model.
@@ -1069,6 +1079,6 @@ def link_model(
         ValueError: if name has invalid special characters
 
     Returns:
-    None
+        None
     """
     ...

wandb/analytics/sentry.py

@@ -211,7 +211,7 @@ class Sentry:
             "sweep_id",
             "deployment",
             "_disable_service",
-            "_require_core",
+            "_require_legacy_service",
             "launch",
         )
 

wandb/cli/cli.py

@@ -35,7 +35,7 @@ import wandb.sdk.verify.verify as wandb_verify
 from wandb import Config, Error, env, util, wandb_agent, wandb_sdk
 from wandb.apis import InternalApi, PublicApi
 from wandb.apis.public import RunQueue
-from wandb.errors import WandbCoreNotAvailableError
+from wandb.errors import UsageError, WandbCoreNotAvailableError
 from wandb.integration.magic import magic_install
 from wandb.sdk.artifacts.artifact_file_cache import get_artifact_file_cache
 from wandb.sdk.launch import utils as launch_utils
@@ -123,6 +123,9 @@ _api = None  # caching api instance allows patching from unit tests
 
 def _get_cling_api(reset=None):
     """Get a reference to the internal api with cling settings."""
+    # TODO: move CLI to wandb-core backend
+    wandb.require("legacy-service")
+
     global _api
     if reset:
         _api = None
@@ -226,6 +229,9 @@ def projects(entity, display=True):
 @click.option("--verify", default=False, is_flag=True, help="Verify login credentials")
 @display_error
 def login(key, host, cloud, relogin, anonymously, verify, no_offline=False):
+    # TODO: move CLI to wandb-core backend
+    wandb.require("legacy-service")
+
     # TODO: handle no_offline
     anon_mode = "must" if anonymously else "never"
 
@@ -433,8 +439,15 @@ def init(ctx, project, entity, reset, mode):
 def beta():
     """Beta versions of wandb CLI commands. Requires wandb-core."""
     # this is the future that requires wandb-core!
+    import wandb.env
+
     wandb._sentry.configure_scope(process_context="wandb_beta")
-    wandb.require("core")
+
+    if wandb.env.is_require_legacy_service():
+        raise UsageError(
+            "wandb beta commands can only be used with wandb-core. "
+            f"Please make sure that `{wandb.env._REQUIRE_LEGACY_SERVICE}` is not set."
+        )
 
     try:
         get_core_path()
@@ -2942,14 +2955,6 @@ def enabled(service):
         )
 
 
-@cli.command("gc", hidden=True, context_settings={"ignore_unknown_options": True})
-@click.argument("args", nargs=-1)
-def gc(args):
-    click.echo(
-        "`wandb gc` command has been removed. Use `wandb sync --clean` to clean up synced runs."
-    )
-
-
 @cli.command(context_settings=CONTEXT, help="Verify your local instance")
 @click.option("--host", default=None, help="Test a specific instance of W&B")
 def verify(host):

wandb/env.py

@@ -90,7 +90,6 @@ _EXECUTABLE = "WANDB_EXECUTABLE"
 LAUNCH_QUEUE_NAME = "WANDB_LAUNCH_QUEUE_NAME"
 LAUNCH_QUEUE_ENTITY = "WANDB_LAUNCH_QUEUE_ENTITY"
 LAUNCH_TRACE_ID = "WANDB_LAUNCH_TRACE_ID"
-_REQUIRE_CORE = "WANDB__REQUIRE_CORE"
 _REQUIRE_LEGACY_SERVICE = "WANDB__REQUIRE_LEGACY_SERVICE"
 
 # For testing, to be removed in future version
@@ -154,19 +153,8 @@ def _env_as_bool(
         return False
 
 
-def is_require_core(env: Optional[Env] = None) -> bool:
-    """Return whether wandb.require("core") was used.
-
-    Note that this may contradict wandb.require("legacy-service").
-    """
-    return _env_as_bool(_REQUIRE_CORE, default="False", env=env)
-
-
 def is_require_legacy_service(env: Optional[Env] = None) -> bool:
-    """Return whether wandb.require("legacy-service") was used.
-
-    Note that this may contradict wandb.require("core").
-    """
+    """Return whether wandb.require("legacy-service") was used."""
     return _env_as_bool(_REQUIRE_LEGACY_SERVICE, default="False", env=env)
 
 

wandb/integration/tensorboard/log.py

@@ -54,9 +54,6 @@ def make_ndarray(tensor: Any) -> Optional["np.ndarray"]:
 def namespaced_tag(tag: str, namespace: str = "") -> str:
     if not namespace:
         return tag
-    elif tag in namespace:
-        # This happens with tensorboardX
-        return namespace
     else:
         return namespace + "/" + tag
 

wandb/jupyter.py

@@ -167,8 +167,6 @@ def notebook_metadata_from_jupyter_servers_and_kernel_id():
             urljoin(s["url"], "api/sessions"), params={"token": s.get("token", "")}
         ).json()
         for nn in res:
-            # TODO: wandb/client#400 found a case where res returned an array of
-            # strings...
             if isinstance(nn, dict) and nn.get("kernel") and "notebook" in nn:
                 if nn["kernel"]["id"] == kernel_id:
                     return {
@@ -176,7 +174,24 @@ def notebook_metadata_from_jupyter_servers_and_kernel_id():
                         "path": nn["notebook"]["path"],
                         "name": nn["notebook"]["name"],
                     }
-    return None
+
+    if not kernel_id:
+        return None
+
+    # Built-in notebook server in VS Code
+    try:
+        from IPython import get_ipython
+
+        ipython = get_ipython()
+        notebook_path = ipython.kernel.shell.user_ns.get("__vsc_ipynb_file__")
+        if notebook_path:
+            return {
+                "root": os.path.dirname(notebook_path),
+                "path": notebook_path,
+                "name": os.path.basename(notebook_path),
+            }
+    except Exception:
+        return None
 
 
 def notebook_metadata(silent: bool) -> Dict[str, str]: