Feature:4015 Allow both infer & explicit options

Author: Json-Andriopoulos

docs/book/how-to/metadata/metadata.md

@@ -261,6 +261,38 @@ def get_train_test_datasets():
 ```
 
 Keep in mind that when using the `infer_artifacts` option, the `bulk_log_metadata` function logs metadata to all output artifacts of the step.
+When logging metadata, you may need the option to use `infer` options in combination with identifier references. For instance, you may want
+to log metadata to a step's outputs but also to its inputs. The `bulk_log_metadata` function enables you to use both options in one go:
+
+```python
+from zenml import bulk_log_metadata, get_step_context, step
+from zenml.models import ArtifactVersionIdentifier
+
+
+def calculate_metrics(model, test_dataset):
+    ...
+
+
+def summarize_metrics(metrics_report):
+    ...
+
+
+@step
+def model_evaluation(test_dataset, model):
+    metrics_report = calculate_metrics(model, test_dataset)
+
+    slim_metrics_version = summarize_metrics(metrics_report)
+
+    bulk_log_metadata(
+        metadata=slim_metrics_version,
+        infer_artifacts=True,  # log metadata for outputs
+        artifact_versions=[
+            ArtifactVersionIdentifier(id=get_step_context().inputs["model"].id)
+        ]  # log metadata for the model input
+    )
+
+    return metrics_report
+```
 
 ### Performance improvements hints
 

src/zenml/utils/metadata_utils.py

@@ -395,7 +395,7 @@ def bulk_log_metadata(
         infer_artifacts: Flag - when enabled infer artifact to log metadata for from step context.
 
     Raises:
-        ValueError: If options are not passed correctly (infer options with explicit declarations) or
+        ValueError: If options are not passed correctly (empty metadata or no identifier options) or
             invocation with `infer` options is done outside of a step context.
     """
     client = Client()
@@ -420,16 +420,6 @@ def bulk_log_metadata(
             "You must select at least one entity to log metadata to."
         )
 
-    if infer_models and model_versions:
-        raise ValueError(
-            "You can either specify model versions or use the infer option."
-        )
-
-    if infer_artifacts and artifact_versions:
-        raise ValueError(
-            "You can either specify artifact versions or use the infer option."
-        )
-
     try:
         step_context = get_step_context()
     except RuntimeError:

tests/unit/utils/test_metadata_utils.py

@@ -15,24 +15,6 @@
 
 
 def test_bulk_log_metadata_validations(monkeypatch):
-    # test one can not specify both explicit and infer options for models
-
-    with pytest.raises(ValueError):
-        bulk_log_metadata(
-            metadata={"x": 1},
-            infer_models=True,
-            model_versions=[ModelVersionIdentifier(id=uuid4())],
-        )
-
-    # test one can not specify both explicit and infer options for a
-
-    with pytest.raises(ValueError):
-        bulk_log_metadata(
-            metadata={"x": 1},
-            infer_artifacts=True,
-            model_versions=[ModelVersionIdentifier(id=uuid4())],
-        )
-
     def boom():
         raise RuntimeError("boom!")
 
@@ -167,3 +149,38 @@ def test_bulk_log_metadata_infer_model(monkeypatch):
     assert (
         len(mock_client.create_run_metadata.call_args.kwargs["resources"]) == 1
     )
+
+
+def test_combined_infer_with_explicit_options(monkeypatch):
+    mock_step_context = MagicMock(
+        model_version=MagicMock(id=uuid4()),
+        _outputs={"a": MagicMock(id=uuid4()), "b": MagicMock(id=uuid4())},
+    )
+
+    mock_client = MagicMock()
+    mock_client.create_run_metadata = MagicMock()
+
+    with monkeypatch.context() as m:
+        m.setattr(metadata_utils, "Client", lambda: mock_client)
+        m.setattr(
+            metadata_utils, "get_step_context", lambda: mock_step_context
+        )
+
+        bulk_log_metadata(
+            metadata={"x": 1},
+            infer_models=True,
+            infer_artifacts=True,
+            model_versions=[ModelVersionIdentifier(id=uuid4())],
+            artifact_versions=[ArtifactVersionIdentifier(id=uuid4())],
+        )
+
+        assert mock_client.create_run_metadata.call_count == 1
+
+        assert mock_client.create_run_metadata.call_args.kwargs[
+            "metadata"
+        ] == {"x": 1}
+        assert (
+            len(mock_client.create_run_metadata.call_args.kwargs["resources"])
+            == 3
+        )
+        assert mock_step_context.add_output_metadata.call_count == 2