wandb 0.20.2rc20250616__py3-none-win_amd64.whl → 0.21.1__py3-none-win_amd64.whl

wandb/sdk/artifacts/artifact.py

@@ -34,6 +34,7 @@ from wandb.apis.public import ArtifactCollection, ArtifactFiles, Run
 from wandb.apis.public.utils import gql_compat
 from wandb.data_types import WBValue
 from wandb.errors import CommError
+from wandb.errors.errors import UnsupportedError
 from wandb.errors.term import termerror, termlog, termwarn
 from wandb.proto import wandb_internal_pb2 as pb
 from wandb.proto.wandb_deprecated import Deprecated
@@ -61,20 +62,25 @@ from ._generated import (
     ADD_ALIASES_GQL,
     DELETE_ALIASES_GQL,
     FETCH_LINKED_ARTIFACTS_GQL,
+    LINK_ARTIFACT_GQL,
     UPDATE_ARTIFACT_GQL,
     ArtifactAliasInput,
     ArtifactCollectionAliasInput,
     FetchLinkedArtifacts,
+    LinkArtifact,
+    LinkArtifactInput,
     TagInput,
     UpdateArtifact,
 )
 from ._graphql_fragments import _gql_artifact_fragment, omit_artifact_fields
 from ._validators import (
     LINKED_ARTIFACT_COLLECTION_TYPE,
+    ArtifactPath,
     _LinkArtifactFields,
     ensure_logged,
     ensure_not_finalized,
     is_artifact_registry_project,
+    remove_registry_prefix,
     validate_aliases,
     validate_artifact_name,
     validate_artifact_type,
@@ -126,25 +132,26 @@ class Artifact:
 
     Construct an empty W&B Artifact. Populate an artifacts contents with methods that
     begin with `add`. Once the artifact has all the desired files, you can call
-    `wandb.log_artifact()` to log it.
+    `run.log_artifact()` to log it.
 
     Args:
-        name: A human-readable name for the artifact. Use the name to identify
+        name (str): A human-readable name for the artifact. Use the name to identify
             a specific artifact in the W&B App UI or programmatically. You can
             interactively reference an artifact with the `use_artifact` Public API.
             A name can contain letters, numbers, underscores, hyphens, and dots.
             The name must be unique across a project.
-        type: The artifact's type. Use the type of an artifact to both organize
+        type (str): The artifact's type. Use the type of an artifact to both organize
             and differentiate artifacts. You can use any string that contains letters,
             numbers, underscores, hyphens, and dots. Common types include `dataset` or `model`.
-            Note: Some types are reserved for internal use and cannot be set by users.
-                Such types include `job` and types that start with `wandb-`.
-        description: A description of the artifact. For Model or Dataset Artifacts,
+            Include `model` within your type string if you want to link the artifact
+            to the W&B Model Registry. Note that some types reserved for internal use
+            and cannot be set by users. Such types include `job` and types that start with `wandb-`.
+        description (str | None) = None: A description of the artifact. For Model or Dataset Artifacts,
             add documentation for your standardized team model or dataset card. View
             an artifact's description programmatically with the `Artifact.description`
             attribute or programmatically with the W&B App UI. W&B renders the
             description as markdown in the W&B App.
-        metadata: Additional information about an artifact. Specify metadata as a
+        metadata (dict[str, Any] | None) = None: Additional information about an artifact. Specify metadata as a
             dictionary of key-value pairs. You can specify no more than 100 total keys.
         incremental: Use `Artifact.new_draft()` method instead to modify an
             existing artifact.
@@ -277,6 +284,87 @@ class Artifact:
         name = "{}:v{}".format(src_collection["name"], attrs["versionIndex"])
         return cls._from_attrs(entity_name, project_name, name, attrs, client)
 
+    @classmethod
+    def _membership_from_name(
+        cls,
+        *,
+        entity: str,
+        project: str,
+        name: str,
+        client: RetryingClient,
+    ) -> Artifact:
+        if not InternalApi()._server_supports(
+            pb.ServerFeature.PROJECT_ARTIFACT_COLLECTION_MEMBERSHIP
+        ):
+            raise UnsupportedError(
+                "querying for the artifact collection membership is not supported "
+                "by this version of wandb server. Consider updating to the latest version."
+            )
+
+        query = gql(
+            f"""
+            query ArtifactByName($entityName: String!, $projectName: String!, $name: String!) {{
+                project(name: $projectName, entityName: $entityName) {{
+                    artifactCollectionMembership(name: $name) {{
+                        id
+                        artifactCollection {{
+                            id
+                            name
+                            project {{
+                                id
+                                entityName
+                                name
+                            }}
+                        }}
+                        artifact {{
+                            ...ArtifactFragment
+                        }}
+                    }}
+                }}
+            }}
+            {_gql_artifact_fragment()}
+            """
+        )
+
+        query_variable_values: dict[str, Any] = {
+            "entityName": entity,
+            "projectName": project,
+            "name": name,
+        }
+        response = client.execute(
+            query,
+            variable_values=query_variable_values,
+        )
+        if not (project_attrs := response.get("project")):
+            raise ValueError(f"project {project!r} not found under entity {entity!r}")
+        if not (acm_attrs := project_attrs.get("artifactCollectionMembership")):
+            entity_project = f"{entity}/{project}"
+            raise ValueError(
+                f"artifact membership {name!r} not found in {entity_project!r}"
+            )
+        if not (ac_attrs := acm_attrs.get("artifactCollection")):
+            raise ValueError("artifact collection not found")
+        if not (
+            (ac_name := ac_attrs.get("name"))
+            and (ac_project_attrs := ac_attrs.get("project"))
+        ):
+            raise ValueError("artifact collection project not found")
+        ac_project = ac_project_attrs.get("name")
+        ac_entity = ac_project_attrs.get("entityName")
+        if is_artifact_registry_project(ac_project) and project == "model-registry":
+            wandb.termwarn(
+                "This model registry has been migrated and will be discontinued. "
+                f"Your request was redirected to the corresponding artifact `{ac_name}` in the new registry. "
+                f"Please update your paths to point to the migrated registry directly, `{ac_project}/{ac_name}`."
+            )
+            entity = ac_entity
+            project = ac_project
+        if not (attrs := acm_attrs.get("artifact")):
+            entity_project = f"{entity}/{project}"
+            raise ValueError(f"artifact {name!r} not found in {entity_project!r}")
+
+        return cls._from_attrs(entity, project, name, attrs, client)
+
     @classmethod
     def _from_name(
         cls,
@@ -287,14 +375,31 @@ class Artifact:
         client: RetryingClient,
         enable_tracking: bool = False,
     ) -> Artifact:
+        if InternalApi()._server_supports(
+            pb.ServerFeature.PROJECT_ARTIFACT_COLLECTION_MEMBERSHIP
+        ):
+            return cls._membership_from_name(
+                entity=entity,
+                project=project,
+                name=name,
+                client=client,
+            )
+
+        query_variable_values: dict[str, Any] = {
+            "entityName": entity,
+            "projectName": project,
+            "name": name,
+        }
+        query_vars = ["$entityName: String!", "$projectName: String!", "$name: String!"]
+        query_args = ["name: $name"]
+
         server_supports_enabling_artifact_usage_tracking = (
             InternalApi().server_project_type_introspection()
         )
-        query_vars = ["$entityName: String!", "$projectName: String!", "$name: String!"]
-        query_args = ["name: $name"]
         if server_supports_enabling_artifact_usage_tracking:
             query_vars.append("$enableTracking: Boolean")
             query_args.append("enableTracking: $enableTracking")
+            query_variable_values["enableTracking"] = enable_tracking
 
         vars_str = ", ".join(query_vars)
         args_str = ", ".join(query_args)
@@ -311,14 +416,6 @@ class Artifact:
             {_gql_artifact_fragment()}
             """
         )
-        query_variable_values: dict[str, Any] = {
-            "entityName": entity,
-            "projectName": project,
-            "name": name,
-        }
-        if server_supports_enabling_artifact_usage_tracking:
-            query_variable_values["enableTracking"] = enable_tracking
-
         response = client.execute(
             query,
             variable_values=query_variable_values,
@@ -329,6 +426,7 @@ class Artifact:
         attrs = project_attrs.get("artifact")
         if not attrs:
             raise ValueError(f"artifact '{name}' not found in '{entity}/{project}'")
+
         return cls._from_attrs(entity, project, name, attrs, client)
 
     @classmethod
@@ -743,7 +841,7 @@ class Artifact:
         )
         return urljoin(
             base_url,
-            f"orgs/{org.display_name}/registry/{self._type}?selectionPath={selection_path}&view=membership&version={self._version}",
+            f"orgs/{org.display_name}/registry/{remove_registry_prefix(self.project)}?selectionPath={selection_path}&view=membership&version={self.version}",
         )
 
     def _construct_model_registry_url(self, base_url: str) -> str:
@@ -828,7 +926,8 @@ class Artifact:
         TTL and there is no custom policy set on an artifact.
 
         Raises:
-            ArtifactNotLoggedError: Unable to fetch inherited TTL if the artifact has not been logged or saved
+            ArtifactNotLoggedError: Unable to fetch inherited TTL if the
+            artifact has not been logged or saved.
         """
         if self._ttl_is_inherited and (self.is_draft() or self._ttl_changed):
             raise ArtifactNotLoggedError(f"{type(self).__name__}.ttl", self)
@@ -880,7 +979,9 @@ class Artifact:
     @property
     @ensure_logged
     def aliases(self) -> list[str]:
-        """List of one or more semantically-friendly references or identifying "nicknames" assigned to an artifact version.
+        """List of one or more semantically-friendly references or
+
+        identifying "nicknames" assigned to an artifact version.
 
         Aliases are mutable references that you can programmatically reference.
         Change an artifact's alias with the W&B App UI or programmatically.
@@ -916,6 +1017,10 @@ class Artifact:
 
     @property
     def distributed_id(self) -> str | None:
+        """The distributed ID of the artifact.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         return self._distributed_id
 
     @distributed_id.setter
@@ -924,6 +1029,10 @@ class Artifact:
 
     @property
     def incremental(self) -> bool:
+        """Boolean flag indicating if the artifact is an incremental artifact.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         return self._incremental
 
     @property
@@ -1043,15 +1152,15 @@ class Artifact:
         """The nearest step at which history metrics were logged for the source run of the artifact.
 
         Examples:
-            ```python
-            run = artifact.logged_by()
-            if run and (artifact.history_step is not None):
-                history = run.sample_history(
-                    min_step=artifact.history_step,
-                    max_step=artifact.history_step + 1,
-                    keys=["my_metric"],
-                )
-            ```
+        ```python
+        run = artifact.logged_by()
+        if run and (artifact.history_step is not None):
+            history = run.sample_history(
+                min_step=artifact.history_step,
+                max_step=artifact.history_step + 1,
+                keys=["my_metric"],
+            )
+        ```
         """
         if self._history_step is None:
             return None
@@ -1072,7 +1181,8 @@ class Artifact:
     def is_draft(self) -> bool:
         """Check if artifact is not saved.
 
-        Returns: Boolean. `False` if artifact is saved. `True` if artifact is not saved.
+        Returns:
+            Boolean. `False` if artifact is saved. `True` if artifact is not saved.
         """
         return self._state == ArtifactState.PENDING
 
@@ -1320,7 +1430,7 @@ class Artifact:
             name: The artifact relative name to get.
 
         Returns:
-            W&B object that can be logged with `wandb.log()` and visualized in the W&B UI.
+            W&B object that can be logged with `run.log()` and visualized in the W&B UI.
 
         Raises:
             ArtifactNotLoggedError: If the artifact isn't logged or the run is offline.
@@ -1338,8 +1448,9 @@ class Artifact:
             The added manifest entry
 
         Raises:
-            ArtifactFinalizedError: You cannot make changes to the current artifact
-            version because it is finalized. Log a new artifact version instead.
+            ArtifactFinalizedError: You cannot make changes to the current
+            artifact version because it is finalized. Log a new artifact
+            version instead.
         """
         return self.add(item, name)
 
@@ -1356,12 +1467,13 @@ class Artifact:
             encoding: The encoding used to open the new file.
 
         Returns:
-            A new file object that can be written to. Upon closing, the file will be
-            automatically added to the artifact.
+            A new file object that can be written to. Upon closing, the file
+            is automatically added to the artifact.
 
         Raises:
-            ArtifactFinalizedError: You cannot make changes to the current artifact
-            version because it is finalized. Log a new artifact version instead.
+            ArtifactFinalizedError: You cannot make changes to the current
+            artifact version because it is finalized. Log a new artifact
+            version instead.
         """
         overwrite: bool = "x" not in mode
 
@@ -1400,22 +1512,26 @@ class Artifact:
 
         Args:
             local_path: The path to the file being added.
-            name: The path within the artifact to use for the file being added. Defaults
-                to the basename of the file.
+            name: The path within the artifact to use for the file being added.
+                Defaults to the basename of the file.
             is_tmp: If true, then the file is renamed deterministically to avoid
                 collisions.
-            skip_cache: If `True`, W&B will not copy files to the cache after uploading.
-            policy: By default, set to "mutable". If set to "mutable", create a temporary copy of the
-                file to prevent corruption during upload. If set to "immutable", disable
-                protection and rely on the user not to delete or change the file.
+            skip_cache: If `True`, do not copy files to the cache
+                after uploading.
+            policy: By default, set to "mutable". If set to "mutable",
+                create a temporary copy of the file to prevent corruption
+                during upload. If set to "immutable", disable
+                protection and rely on the user not to delete or change the
+                file.
             overwrite: If `True`, overwrite the file if it already exists.
 
         Returns:
             The added manifest entry.
 
         Raises:
-            ArtifactFinalizedError: You cannot make changes to the current artifact
-            version because it is finalized. Log a new artifact version instead.
+            ArtifactFinalizedError: You cannot make changes to the current
+                artifact version because it is finalized. Log a new artifact
+                version instead.
             ValueError: Policy must be "mutable" or "immutable"
         """
         if not os.path.isfile(local_path):
@@ -1452,21 +1568,23 @@ class Artifact:
 
         Args:
             local_path: The path of the local directory.
-            name: The subdirectory name within an artifact. The name you specify appears
-                in the W&B App UI nested by artifact's `type`.
+            name: The subdirectory name within an artifact. The name you
+                specify appears in the W&B App UI nested by artifact's `type`.
                 Defaults to the root of the artifact.
-            skip_cache: If set to `True`, W&B will not copy/move files to the cache while uploading
-            policy: "mutable" | "immutable". By default, "mutable"
-                "mutable": Create a temporary copy of the file to prevent corruption during upload.
-                "immutable": Disable protection, rely on the user not to delete or change the file.
+            skip_cache: If set to `True`, W&B will not copy/move files to
+                the cache while uploading
+            policy: By default, "mutable".
+            - mutable: Create a temporary copy of the file to prevent corruption during upload.
+            - immutable: Disable protection, rely on the user not to delete or change the file.
             merge: If `False` (default), throws ValueError if a file was already added in a previous add_dir call
                 and its content has changed. If `True`, overwrites existing files with changed content.
                 Always adds new files and never removes files. To replace an entire directory, pass a name when adding the directory
                 using `add_dir(local_path, name=my_prefix)` and call `remove(my_prefix)` to remove the directory, then add it again.
 
         Raises:
-            ArtifactFinalizedError: You cannot make changes to the current artifact
-            version because it is finalized. Log a new artifact version instead.
+            ArtifactFinalizedError: You cannot make changes to the current
+                artifact version because it is finalized. Log a new artifact
+                version instead.
             ValueError: Policy must be "mutable" or "immutable"
         """
         if not os.path.isdir(local_path):
@@ -1525,13 +1643,14 @@ class Artifact:
 
         - http(s): The size and digest of the file will be inferred by the
           `Content-Length` and the `ETag` response headers returned by the server.
-        - s3: The checksum and size are pulled from the object metadata. If bucket
-          versioning is enabled, then the version ID is also tracked.
+        - s3: The checksum and size are pulled from the object metadata.
+          If bucket versioning is enabled, then the version ID is also tracked.
         - gs: The checksum and size are pulled from the object metadata. If bucket
           versioning is enabled, then the version ID is also tracked.
-        - https, domain matching `*.blob.core.windows.net` (Azure): The checksum and size
-          are be pulled from the blob metadata. If storage account versioning is
-          enabled, then the version ID is also tracked.
+        - https, domain matching `*.blob.core.windows.net`
+        - Azure: The checksum and size are be pulled from the blob metadata.
+          If storage account versioning is enabled, then the version ID is
+          also tracked.
         - file: The checksum and size are pulled from the file system. This scheme
           is useful if you have an NFS share or other externally mounted volume
           containing files you wish to track but not necessarily upload.
@@ -1552,16 +1671,18 @@ class Artifact:
                 setting `checksum=False` when adding reference objects, in which case
                 a new version will only be created if the reference URI changes.
             max_objects: The maximum number of objects to consider when adding a
-                reference that points to directory or bucket store prefix. By default,
-                the maximum number of objects allowed for Amazon S3,
-                GCS, Azure, and local files is 10,000,000. Other URI schemas do not have a maximum.
+                reference that points to directory or bucket store prefix.
+                By default, the maximum number of objects allowed for Amazon S3,
+                GCS, Azure, and local files is 10,000,000. Other URI schemas
+                do not have a maximum.
 
         Returns:
             The added manifest entries.
 
         Raises:
-            ArtifactFinalizedError: You cannot make changes to the current artifact
-            version because it is finalized. Log a new artifact version instead.
+            ArtifactFinalizedError: You cannot make changes to the current
+            artifact version because it is finalized. Log a new artifact
+            version instead.
         """
         if name is not None:
             name = LogicalPath(name)
@@ -1598,17 +1719,19 @@ class Artifact:
 
         Args:
             obj: The object to add. Currently support one of Bokeh, JoinedTable,
-                PartitionedTable, Table, Classes, ImageMask, BoundingBoxes2D, Audio,
-                Image, Video, Html, Object3D
+                PartitionedTable, Table, Classes, ImageMask, BoundingBoxes2D,
+                Audio, Image, Video, Html, Object3D
             name: The path within the artifact to add the object.
-            overwrite: If True, overwrite existing objects with the same file path (if applicable).
+            overwrite: If True, overwrite existing objects with the same file
+                path if applicable.
 
         Returns:
             The added manifest entry
 
         Raises:
-            ArtifactFinalizedError: You cannot make changes to the current artifact
-            version because it is finalized. Log a new artifact version instead.
+            ArtifactFinalizedError: You cannot make changes to the current
+            artifact version because it is finalized. Log a new artifact
+            version instead.
         """
         name = LogicalPath(name)
 
@@ -1723,13 +1846,14 @@ class Artifact:
         """Remove an item from the artifact.
 
         Args:
-            item: The item to remove. Can be a specific manifest entry or the name of an
-                artifact-relative path. If the item matches a directory all items in
-                that directory will be removed.
+            item: The item to remove. Can be a specific manifest entry
+                or the name of an artifact-relative path. If the item
+                matches a directory all items in that directory will be removed.
 
         Raises:
-            ArtifactFinalizedError: You cannot make changes to the current artifact
-            version because it is finalized. Log a new artifact version instead.
+            ArtifactFinalizedError: You cannot make changes to the current
+                artifact version because it is finalized. Log a new artifact
+                version instead.
             FileNotFoundError: If the item isn't found in the artifact.
         """
         if isinstance(item, ArtifactManifestEntry):
@@ -1785,10 +1909,12 @@ class Artifact:
             name: The artifact relative name to retrieve.
 
         Returns:
-            W&B object that can be logged with `wandb.log()` and visualized in the W&B UI.
+            W&B object that can be logged with `run.log()` and
+            visualized in the W&B UI.
 
         Raises:
-            ArtifactNotLoggedError: if the artifact isn't logged or the run is offline
+            ArtifactNotLoggedError: if the artifact isn't logged or the
+                run is offline.
         """
         entry, wb_class = self._get_obj_entry(name)
         if entry is None or wb_class is None:
@@ -2224,7 +2350,7 @@ class Artifact:
 
         Args:
             root: The root directory to store the file. Defaults to
-                './artifacts/self.name/'.
+                `./artifacts/self.name/`.
 
         Returns:
             The full path of the downloaded file.
@@ -2290,16 +2416,16 @@ class Artifact:
     def delete(self, delete_aliases: bool = False) -> None:
         """Delete an artifact and its files.
 
-        If called on a linked artifact (i.e. a member of a portfolio collection): only the link is deleted, and the
+        If called on a linked artifact, only the link is deleted, and the
         source artifact is unaffected.
 
         Use `artifact.unlink()` instead of `artifact.delete()` to remove a link between a source artifact and a linked artifact.
 
         Args:
-            delete_aliases: If set to `True`, deletes all aliases associated with the artifact.
-                Otherwise, this raises an exception if the artifact has existing
-                aliases.
-                This parameter is ignored if the artifact is linked (i.e. a member of a portfolio collection).
+            delete_aliases: If set to `True`, deletes all aliases associated
+                with the artifact. Otherwise, this raises an exception if
+                the artifact has existing aliases. This parameter is ignored
+                if the artifact is linked (a member of a portfolio collection).
 
         Raises:
             ArtifactNotLoggedError: If the artifact is not logged.
@@ -2352,8 +2478,8 @@ class Artifact:
                 portfolio inside a project, set `target_path` to the following
                 schema `{"model-registry"}/{Registered Model Name}` or
                 `{entity}/{"model-registry"}/{Registered Model Name}`.
-            aliases: A list of strings that uniquely identifies the artifact inside the
-                specified portfolio.
+            aliases: A list of strings that uniquely identifies the artifact
+                inside the specified portfolio.
 
         Raises:
             ArtifactNotLoggedError: If the artifact is not logged.
@@ -2361,33 +2487,80 @@ class Artifact:
         Returns:
             The linked artifact if linking was successful, otherwise None.
         """
+        from wandb import Api
+
         if self.is_link:
             wandb.termwarn(
                 "Linking to a link artifact will result in directly linking to the source artifact of that link artifact."
             )
 
-        if run := wandb_setup.singleton().most_recent_active_run:
-            # TODO: Deprecate and encourage explicit link_artifact().
-            return run.link_artifact(self, target_path, aliases)
+        if self._client is None:
+            raise ValueError("Client not initialized for artifact mutations")
+
+        # Save the artifact first if necessary
+        if self.is_draft():
+            if not self._is_draft_save_started():
+                self.save(project=self.source_project)
+
+            # Wait until the artifact is committed before trying to link it.
+            self.wait()
+
+        api = Api(overrides={"entity": self.source_entity})
+
+        target = ArtifactPath.from_str(target_path).with_defaults(
+            project=api.settings.get("project") or "uncategorized",
+        )
+
+        # Parse the entity (first part of the path) appropriately,
+        # depending on whether we're linking to a registry
+        if target.project and is_artifact_registry_project(target.project):
+            # In a Registry linking, the entity is used to fetch the organization of the artifact
+            # therefore the source artifact's entity is passed to the backend
+            organization = target.prefix or api.settings.get("organization") or ""
 
+            target.prefix = InternalApi()._resolve_org_entity_name(
+                self.source_entity, organization
+            )
         else:
-            with wandb.init(
-                entity=self._source_entity,
-                project=self._source_project,
-                job_type="auto",
-                settings=wandb.Settings(silent="true"),
-            ) as run:
-                return run.link_artifact(self, target_path, aliases)
+            target = target.with_defaults(prefix=self.source_entity)
 
-        return None
+        # Prepare the validated GQL input, send it
+        alias_inputs = [
+            ArtifactAliasInput(artifact_collection_name=target.name, alias=a)
+            for a in (aliases or [])
+        ]
+        gql_input = LinkArtifactInput(
+            artifact_id=self.id,
+            artifact_portfolio_name=target.name,
+            entity_name=target.prefix,
+            project_name=target.project,
+            aliases=alias_inputs,
+        )
+        gql_vars = {"input": gql_input.model_dump(exclude_none=True)}
+        gql_op = gql(LINK_ARTIFACT_GQL)
+        data = self._client.execute(gql_op, variable_values=gql_vars)
+
+        result = LinkArtifact.model_validate(data).link_artifact
+        if not (result and (version_idx := result.version_index) is not None):
+            raise ValueError("Unable to parse linked artifact version from response")
+
+        # Fetch the linked artifact to return it
+        linked_path = f"{target.to_str()}:v{version_idx}"
+
+        try:
+            return api._artifact(linked_path)
+        except Exception as e:
+            wandb.termerror(f"Error fetching link artifact after linking: {e}")
+            return None
 
     @ensure_logged
     def unlink(self) -> None:
-        """Unlink this artifact if it is currently a member of a portfolio (a promoted collection of artifacts).
+        """Unlink this artifact if it is currently a member of a promoted collection of artifacts.
 
         Raises:
             ArtifactNotLoggedError: If the artifact is not logged.
-            ValueError: If the artifact is not linked, i.e. it is not a member of a portfolio collection.
+            ValueError: If the artifact is not linked, in other words,
+            it is not a member of a portfolio collection.
         """
         # Fail early if this isn't a linked artifact to begin with
         if not self.is_link: