dreadnode 1.10.0__tar.gz → 1.11.0__tar.gz

{dreadnode-1.10.0 → dreadnode-1.11.0}/PKG-INFO

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

{dreadnode-1.10.0 → dreadnode-1.11.0}/dreadnode/__init__.py

@@ -1,3 +1,4 @@
+from dreadnode import convert, data_types
 from dreadnode.data_types import Audio, Image, Object3D, Table, Video
 from dreadnode.main import DEFAULT_INSTANCE, Dreadnode
 from dreadnode.metric import Metric, MetricDict, Scorer
@@ -33,6 +34,7 @@ log_artifact = DEFAULT_INSTANCE.log_artifact
 __version__ = VERSION
 
 __all__ = [
+    "DEFAULT_INSTANCE",
     "Audio",
     "Dreadnode",
     "Image",
@@ -51,6 +53,10 @@ __all__ = [
     "__version__",
     "api",
     "configure",
+    "continue_run",
+    "convert",
+    "data_types",
+    "get_run_context",
     "link_objects",
     "log_artifact",
     "log_input",

dreadnode-1.11.0/dreadnode/convert.py

@@ -0,0 +1,42 @@
+import typing as t
+
+if t.TYPE_CHECKING:
+    import networkx as nx  # type: ignore [import-untyped]
+
+    from dreadnode.tracing.span import RunSpan
+
+
+def run_span_to_graph(run: "RunSpan") -> "nx.DiGraph":
+    try:
+        import networkx as nx
+    except ImportError as e:
+        raise RuntimeError("The `networkx` package is required for graph conversion") from e
+
+    graph = nx.DiGraph()
+
+    graph.add_node(
+        run.run_id,
+        name=run.name,
+        label=run.label,
+        start_time=run.start_time,
+        end_time=run.end_time,
+        duration=run.duration,
+        status="failed" if run.failed else "running" if run.is_recording else "completed",
+        tags=run.tags,
+    )
+
+    for task in run.all_tasks:
+        graph.add_node(
+            task.span_id,
+            name=task.name,
+            label=task.label,
+            start_time=task.start_time,
+            end_time=task.end_time,
+            duration=task.duration,
+            status="failed" if task.failed else "running" if task.active else "completed",
+            tags=task.tags,
+        )
+
+        graph.add_edge(task.parent_task.span_id if task.parent_task else run.run_id, task.span_id)
+
+    return graph

dreadnode-1.11.0/dreadnode/data_types/__init__.py

@@ -0,0 +1,9 @@
+from .audio import Audio
+from .base import WithMeta
+from .image import Image
+from .object_3d import Object3D
+from .table import Table
+from .text import Code, Markdown, Text
+from .video import Video
+
+__all__ = ["Audio", "Code", "Image", "Markdown", "Object3D", "Table", "Text", "Video", "WithMeta"]

{dreadnode-1.10.0 → dreadnode-1.11.0}/dreadnode/data_types/audio.py

@@ -9,12 +9,12 @@ try:
 except ImportError:
     sf = None
 
-from dreadnode.data_types.base_data_type import BaseDataType
+from dreadnode.data_types.base import DataType
 
 AudioDataType: t.TypeAlias = str | Path | np.ndarray[t.Any, t.Any] | bytes
 
 
-class Audio(BaseDataType):
+class Audio(DataType):
     """
     Audio media type for Dreadnode logging.
 

dreadnode-1.11.0/dreadnode/data_types/base.py

@@ -0,0 +1,49 @@
+import typing as t
+from abc import ABC, abstractmethod
+
+
+class DataType(ABC):
+    """Base class for dedicated data types that can be logged with Dreadnode."""
+
+    @abstractmethod
+    def to_serializable(self) -> tuple[t.Any, dict[str, t.Any]]:
+        """
+        Convert the media type to a serializable format.
+
+        Returns:
+            Tuple of (data, metadata) where:
+                - data: The serialized data
+                - metadata: Additional metadata for this data type
+        """
+
+
+class WithMeta(DataType):
+    """
+    Helper data type to add additional metadata to the schema for logged data.
+
+    Example:
+        ```
+        log_output("my_data", WithMeta(data, {"format": "custom-data"}))
+        ```
+    """
+
+    def __init__(self, obj: t.Any, metadata: dict[str, t.Any]):
+        """
+        Initialize a data type with associated metadata.
+
+        Args:
+            metadata: The metadata for this data type
+        """
+        self._obj = obj
+        self._metadata = metadata
+
+    def to_serializable(self) -> tuple[t.Any, dict[str, t.Any]]:
+        """
+        Convert the media type to a serializable format.
+
+        Returns:
+            Tuple of (data, metadata) where:
+                - data: The serialized data
+                - metadata: Additional metadata for this data type
+        """
+        return self._obj, self._metadata

{dreadnode-1.10.0 → dreadnode-1.11.0}/dreadnode/data_types/image.py

@@ -5,7 +5,7 @@ from pathlib import Path
 
 import numpy as np
 
-from dreadnode.data_types.base_data_type import BaseDataType
+from dreadnode.data_types.base import DataType
 
 try:
     from PIL import Image as PILImage
@@ -16,7 +16,7 @@ ImageDataType = t.Any | np.ndarray[t.Any, t.Any]
 ImageDataOrPathType = str | Path | bytes | ImageDataType
 
 
-class Image(BaseDataType):
+class Image(DataType):
     """
     Image media type for Dreadnode logging.
 

{dreadnode-1.10.0 → dreadnode-1.11.0}/dreadnode/data_types/object_3d.py

@@ -2,12 +2,12 @@ import typing as t
 from pathlib import Path
 from typing import ClassVar
 
-from dreadnode.data_types.base_data_type import BaseDataType
+from dreadnode.data_types.base import DataType
 
 Object3DDataType = str | Path | bytes
 
 
-class Object3D(BaseDataType):
+class Object3D(DataType):
     """
     3D object media type for Dreadnode logging.
 

{dreadnode-1.10.0 → dreadnode-1.11.0}/dreadnode/data_types/table.py

@@ -6,14 +6,14 @@ from typing import ClassVar
 import numpy as np
 import pandas as pd
 
-from dreadnode.data_types.base_data_type import BaseDataType
+from dreadnode.data_types.base import DataType
 
 TableDataType = (
     pd.DataFrame | dict[t.Any, t.Any] | list[t.Any] | str | Path | np.ndarray[t.Any, t.Any]
 )
 
 
-class Table(BaseDataType):
+class Table(DataType):
     """
     Table data type for Dreadnode logging.
 

dreadnode-1.11.0/dreadnode/data_types/text.py

@@ -0,0 +1,59 @@
+import typing as t
+
+from dreadnode.data_types.base import DataType
+
+
+class Text(DataType):
+    """
+    Text data type for Dreadnode logging.
+    """
+
+    def __init__(self, text: str, format: str):
+        """
+        Initialize a Text object.
+
+        Args:
+            text: The text content to log
+            format: The format hint of the text
+        """
+        self._text = text
+        self._format = format
+
+    def to_serializable(self) -> tuple[str, dict[str, t.Any]]:
+        return self._text, {"format": self._format}
+
+
+class Markdown(Text):
+    """
+    Hint type for markdown-formatted text.
+
+    This is a subclass of Text with format set to "markdown".
+
+    Example:
+        ```
+        log_output("report", Markdown("..."))
+        ```
+    """
+
+    def __init__(self, text: str):
+        super().__init__(text, format="markdown")
+
+
+class Code(Text):
+    """
+    Hint type for code-formatted text.
+
+    This is a subclass of Text with format set to "code".
+
+    Example:
+        ```
+        log_output("code_snippet", Code("print('Hello, World!')", language="python"))
+        ```
+    """
+
+    def __init__(self, text: str, language: str = ""):
+        super().__init__(text, format="code")
+        self._language = language
+
+    def to_serializable(self) -> tuple[str, dict[str, t.Any]]:
+        return self._text, {"format": self._format, "code-language": self._language}

{dreadnode-1.10.0 → dreadnode-1.11.0}/dreadnode/data_types/video.py

@@ -6,7 +6,7 @@ from pathlib import Path
 import numpy as np
 from numpy.typing import NDArray
 
-from dreadnode.data_types.base_data_type import BaseDataType
+from dreadnode.data_types.base import DataType
 
 try:
     from moviepy.video.io.ImageSequenceClip import ImageSequenceClip  # type: ignore  # noqa: PGH003
@@ -19,7 +19,7 @@ except ImportError:
 VideoDataType: t.TypeAlias = str | Path | NDArray[t.Any] | bytes | list[NDArray[t.Any]] | t.Any
 
 
-class Video(BaseDataType):
+class Video(DataType):
     """
     Video media type for Dreadnode logging.