dreadnode 1.0.3__tar.gz → 1.0.4__tar.gz

{dreadnode-1.0.3 → dreadnode-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dreadnode
-Version: 1.0.3
+Version: 1.0.4
 Summary: Dreadnode SDK
 Author: Nick Landers
 Author-email: monoxgas@gmail.com

{dreadnode-1.0.3 → dreadnode-1.0.4}/dreadnode/__init__.py

@@ -16,6 +16,7 @@ run = DEFAULT_INSTANCE.run
 scorer = DEFAULT_INSTANCE.scorer
 task_span = DEFAULT_INSTANCE.task_span
 push_update = DEFAULT_INSTANCE.push_update
+tag = DEFAULT_INSTANCE.tag
 
 log_metric = DEFAULT_INSTANCE.log_metric
 log_param = DEFAULT_INSTANCE.log_param
@@ -33,19 +34,28 @@ __all__ = [
     "Metric",
     "MetricDict",
     "Object",
-    "Run",
     "RunSpan",
-    "Score",
     "Scorer",
     "Span",
     "Task",
     "TaskSpan",
-    "__version__",
+    "api",
     "configure",
+    "link_objects",
+    "log_artifact",
+    "log_input",
+    "log_inputs",
     "log_metric",
+    "log_output",
     "log_param",
+    "log_params",
+    "push_update",
     "run",
+    "scorer",
     "shutdown",
     "span",
+    "tag",
     "task",
+    "task_span",
+    "task_span",
 ]

{dreadnode-1.0.3 → dreadnode-1.0.4}/dreadnode/main.py

@@ -2,7 +2,6 @@ import contextlib
 import inspect
 import os
 import random
-import re
 import typing as t
 from dataclasses import dataclass
 from datetime import datetime, timezone
@@ -53,7 +52,7 @@ from dreadnode.types import (
     JsonDict,
     JsonValue,
 )
-from dreadnode.util import handle_internal_errors
+from dreadnode.util import clean_str, handle_internal_errors
 from dreadnode.version import VERSION
 
 if t.TYPE_CHECKING:
@@ -503,7 +502,7 @@ class Dreadnode:
             _label = label or func_name
 
             # conform our label for sanity
-            _label = re.sub(r"[\W_]+", "_", _label.lower())
+            _label = clean_str(_label)
 
             _attributes = attributes or {}
             _attributes["code.function"] = func_name
@@ -570,7 +569,7 @@ class Dreadnode:
         if (run := current_run_span.get()) is None:
             raise RuntimeError("Task spans must be created within a run")
 
-        label = label or re.sub(r"[\W_]+", "_", name.lower())
+        label = label or clean_str(name)
         return TaskSpan(
             name=name,
             label=label,
@@ -681,6 +680,31 @@ class Dreadnode:
             autolog=autolog,
         )
 
+    def tag(self, *tag: str, to: ToObject = "task-or-run") -> None:
+        """
+        Add one or many tags to the current task or run.
+
+        Example:
+            ```
+            with dreadnode.run("my_run") as run:
+                run.tag("my_tag")
+            ```
+
+        Args:
+            tag: The tag to attach to the task or run.
+            to: The target object to log the tag to. Can be "task-or-run" or "run".
+                Defaults to "task-or-run". If "task-or-run", the tag will be logged
+                to the current task or run, whichever is the nearest ancestor.
+        """
+        task = current_task_span.get()
+        run = current_run_span.get()
+
+        target = (task or run) if to == "task-or-run" else run
+        if target is None:
+            raise RuntimeError("Tagging must be done within a run")
+
+        target.add_tags(tag)
+
     @handle_internal_errors()
     def push_update(self) -> None:
         """
@@ -777,7 +801,7 @@ class Dreadnode:
         mode: MetricAggMode | None = None,
         attributes: JsonDict | None = None,
         to: ToObject = "task-or-run",
-    ) -> None:
+    ) -> Metric:
         """
         Log a single metric to the current task or run.
 
@@ -809,6 +833,9 @@ class Dreadnode:
             to: The target object to log the metric to. Can be "task-or-run" or "run".
                 Defaults to "task-or-run". If "task-or-run", the metric will be logged
                 to the current task or run, whichever is the nearest ancestor.
+
+        Returns:
+            The logged metric object.
         """
 
     @t.overload
@@ -820,7 +847,7 @@ class Dreadnode:
         origin: t.Any | None = None,
         mode: MetricAggMode | None = None,
         to: ToObject = "task-or-run",
-    ) -> None:
+    ) -> Metric:
         """
         Log a single metric to the current task or run.
 
@@ -848,6 +875,9 @@ class Dreadnode:
             to: The target object to log the metric to. Can be "task-or-run" or "run".
                 Defaults to "task-or-run". If "task-or-run", the metric will be logged
                 to the current task or run, whichever is the nearest ancestor.
+
+        Returns:
+            The logged metric object.
         """
 
     @handle_internal_errors()
@@ -862,7 +892,7 @@ class Dreadnode:
         mode: MetricAggMode | None = None,
         attributes: JsonDict | None = None,
         to: ToObject = "task-or-run",
-    ) -> None:
+    ) -> Metric:
         task = current_task_span.get()
         run = current_run_span.get()
 
@@ -877,7 +907,7 @@ class Dreadnode:
                 float(value), step, timestamp or datetime.now(timezone.utc), attributes or {}
             )
         )
-        target.log_metric(key, metric, origin=origin, mode=mode)
+        return target.log_metric(key, metric, origin=origin, mode=mode)
 
     @handle_internal_errors()
     def log_artifact(
@@ -926,7 +956,7 @@ class Dreadnode:
     def log_input(
         self,
         name: str,
-        value: JsonValue,
+        value: t.Any,
         *,
         label: str | None = None,
         to: ToObject = "task-or-run",

{dreadnode-1.0.3 → dreadnode-1.0.4}/dreadnode/metric.py

@@ -68,7 +68,7 @@ class Metric:
         This will modify the metric in place.
 
         Args:
-            mode: The mode to apply. One of "sum", "min", "max", or "inc".
+            mode: The mode to apply. One of "sum", "min", "max", or "count".
             others: A list of other metrics to apply the mode to.
 
         Returns:
@@ -87,7 +87,8 @@ class Metric:
         prior_values = [m.value for m in sorted(others, key=lambda m: m.timestamp)]
 
         if mode == "sum":
-            self.value += max(prior_values)
+            # Take the max of the priors because they might already be summed
+            self.value += max(prior_values) if prior_values else 0
         elif mode == "min":
             self.value = min([self.value, *prior_values])
         elif mode == "max":

{dreadnode-1.0.3 → dreadnode-1.0.4}/dreadnode/tracing/span.py

@@ -1,5 +1,4 @@
 import logging
-import re
 import types
 import typing as t
 from contextvars import ContextVar, Token
@@ -32,6 +31,7 @@ from dreadnode.metric import Metric, MetricAggMode, MetricDict
 from dreadnode.object import Object, ObjectRef, ObjectUri, ObjectVal
 from dreadnode.serialization import Serialized, serialize
 from dreadnode.types import UNSET, AnyDict, JsonDict, JsonValue, Unset
+from dreadnode.util import clean_str
 from dreadnode.version import VERSION
 
 from .constants import (
@@ -92,11 +92,16 @@ class Span(ReadableSpan):
     ) -> None:
         self._label = label or ""
         self._span_name = name
+
+        tags = [tags] if isinstance(tags, str) else list(tags or [])
+        tags = [clean_str(t) for t in tags]
+        self.tags: tuple[str, ...] = uniquify_sequence(tags)
+
         self._pre_attributes = {
             SPAN_ATTRIBUTE_VERSION: VERSION,
             SPAN_ATTRIBUTE_TYPE: type,
             SPAN_ATTRIBUTE_LABEL: self._label,
-            SPAN_ATTRIBUTE_TAGS_: uniquify_sequence(tags or ()),
+            SPAN_ATTRIBUTE_TAGS_: self.tags,
             **attributes,
         }
         self._tracer = tracer
@@ -145,6 +150,8 @@ class Span(ReadableSpan):
             SPAN_ATTRIBUTE_SCHEMA,
             attributes_json_schema(self._schema) if self._schema else r"{}",
         )
+        self._span.set_attribute(SPAN_ATTRIBUTE_TAGS_, self.tags)
+
         self._span.__exit__(exc_type, exc_value, traceback)
 
         OPEN_SPANS.discard(self._span)  # type: ignore [arg-type]
@@ -167,13 +174,14 @@ class Span(ReadableSpan):
             return False
         return self._span.is_recording()
 
-    @property
-    def tags(self) -> tuple[str, ...]:
-        return tuple(self.get_attribute(SPAN_ATTRIBUTE_TAGS_, ()))
+    def set_tags(self, tags: t.Sequence[str]) -> None:
+        tags = [tags] if isinstance(tags, str) else list(tags)
+        tags = [clean_str(t) for t in tags]
+        self.tags = uniquify_sequence(tags)
 
-    @tags.setter
-    def tags(self, new_tags: t.Sequence[str]) -> None:
-        self.set_attribute(SPAN_ATTRIBUTE_TAGS_, uniquify_sequence(new_tags))
+    def add_tags(self, tags: t.Sequence[str]) -> None:
+        tags = [tags] if isinstance(tags, str) else list(tags)
+        self.set_tags([*self.tags, *tags])
 
     def set_attribute(
         self,
@@ -485,7 +493,7 @@ class RunSpan(Span):
         label: str | None = None,
         **attributes: JsonValue,
     ) -> None:
-        label = label or re.sub(r"\W+", "_", name.lower())
+        label = label or clean_str(name)
         hash_ = self.log_object(
             value,
             label=label,
@@ -533,7 +541,7 @@ class RunSpan(Span):
         mode: MetricAggMode | None = None,
         prefix: str | None = None,
         attributes: JsonDict | None = None,
-    ) -> None: ...
+    ) -> Metric: ...
 
     @t.overload
     def log_metric(
@@ -544,7 +552,7 @@ class RunSpan(Span):
         origin: t.Any | None = None,
         mode: MetricAggMode | None = None,
         prefix: str | None = None,
-    ) -> None: ...
+    ) -> Metric: ...
 
     def log_metric(
         self,
@@ -557,7 +565,7 @@ class RunSpan(Span):
         mode: MetricAggMode | None = None,
         prefix: str | None = None,
         attributes: JsonDict | None = None,
-    ) -> None:
+    ) -> Metric:
         metric = (
             value
             if isinstance(value, Metric)
@@ -566,7 +574,7 @@ class RunSpan(Span):
             )
         )
 
-        key = re.sub(r"[^\w/]+", "_", key.lower())
+        key = clean_str(key)
         if prefix is not None:
             key = f"{prefix}.{key}"
 
@@ -583,6 +591,8 @@ class RunSpan(Span):
             metric = metric.apply_mode(mode, metrics)
         metrics.append(metric)
 
+        return metric
+
     @property
     def outputs(self) -> AnyDict:
         return {ref.name: self.get_object(ref.hash) for ref in self._outputs}
@@ -595,7 +605,7 @@ class RunSpan(Span):
         label: str | None = None,
         **attributes: JsonValue,
     ) -> None:
-        label = label or re.sub(r"\W+", "_", name.lower())
+        label = label or clean_str(name)
         hash_ = self.log_object(
             value,
             label=label,
@@ -698,7 +708,7 @@ class TaskSpan(Span, t.Generic[R]):
         label: str | None = None,
         **attributes: JsonValue,
     ) -> str:
-        label = label or re.sub(r"\W+", "_", name.lower())
+        label = label or clean_str(name)
         hash_ = self.run.log_object(
             value,
             label=label,
@@ -729,7 +739,7 @@ class TaskSpan(Span, t.Generic[R]):
         label: str | None = None,
         **attributes: JsonValue,
     ) -> str:
-        label = label or re.sub(r"\W+", "_", name.lower())
+        label = label or clean_str(name)
         hash_ = self.run.log_object(
             value,
             label=label,
@@ -753,7 +763,7 @@ class TaskSpan(Span, t.Generic[R]):
         timestamp: datetime | None = None,
         mode: MetricAggMode | None = None,
         attributes: JsonDict | None = None,
-    ) -> None: ...
+    ) -> Metric: ...
 
     @t.overload
     def log_metric(
@@ -763,7 +773,7 @@ class TaskSpan(Span, t.Generic[R]):
         *,
         origin: t.Any | None = None,
         mode: MetricAggMode | None = None,
-    ) -> None: ...
+    ) -> Metric: ...
 
     def log_metric(
         self,
@@ -775,7 +785,7 @@ class TaskSpan(Span, t.Generic[R]):
         timestamp: datetime | None = None,
         mode: MetricAggMode | None = None,
         attributes: JsonDict | None = None,
-    ) -> None:
+    ) -> Metric:
         metric = (
             value
             if isinstance(value, Metric)
@@ -784,27 +794,21 @@ class TaskSpan(Span, t.Generic[R]):
             )
         )
 
-        key = re.sub(r"[^\w/]+", "_", key.lower())
-
-        if origin is not None:
-            origin_hash = self.run.log_object(
-                origin,
-                label=key,
-                event_name=EVENT_NAME_OBJECT_METRIC,
-            )
-            metric.attributes[METRIC_ATTRIBUTE_SOURCE_HASH] = origin_hash
-
-        metrics = self._metrics.setdefault(key, [])
-        if mode is not None:
-            metric = metric.apply_mode(mode, metrics)
-        metrics.append(metric)
+        key = clean_str(key)
 
         # For every metric we log, also log it to the run
         # with our `label` as a prefix.
         #
-        # Don't include `source` and `mode` as we handled it here.
+        # Let the run handle the origin and mode aggregation
+        # for us as we don't have access to the other times
+        # this task-metric was logged here.
+
         if (run := current_run_span.get()) is not None:
-            run.log_metric(key, metric, prefix=self._label)
+            metric = run.log_metric(key, metric, prefix=self._label, origin=origin, mode=mode)
+
+        self._metrics.setdefault(key, []).append(metric)
+
+        return metric
 
     def get_average_metric_value(self, key: str | None = None) -> float:
         metrics = (

{dreadnode-1.0.3 → dreadnode-1.0.4}/dreadnode/util.py

@@ -4,6 +4,7 @@
 import inspect
 import logging
 import os
+import re
 import sys
 import typing as t
 from contextlib import contextmanager
@@ -27,6 +28,13 @@ logger = logging.getLogger("dreadnode")
 add_non_user_code_prefix(Path(dreadnode.__file__).parent)
 
 
+def clean_str(s: str) -> str:
+    """
+    Clean a string by replacing all non-alphanumeric characters with underscores.
+    """
+    return re.sub(r"[^\w/]+", "_", s.lower())
+
+
 def safe_repr(obj: t.Any) -> str:
     """
     Return some kind of non-empty string representation of an object, catching exceptions.

{dreadnode-1.0.3 → dreadnode-1.0.4}/pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "dreadnode"
-version = "1.0.3"
+version = "1.0.4"
 description = "Dreadnode SDK"
 requires-python = ">=3.10,<3.14"
 
 [tool.poetry]
 name = "dreadnode"
-version = "1.0.3"
+version = "1.0.4"
 description = "Dreadnode SDK"
 authors = ["Nick Landers <monoxgas@gmail.com>"]
 repository = "https://github.com/dreadnode/sdk"