Skip to content

Commit ea1e25d

Browse files
committed
update doc strings for clarifications in encoding.py
1 parent fe76616 commit ea1e25d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/guidellm/utils/encoding.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ class MessageEncoding(Generic[ObjT, MsgT]):
7676
performance and compatibility across different transport mechanisms used in
7777
distributed scheduler operations.
7878
79+
For performance reasons, this encoding only supports Python primitives
80+
(int, float, str), Pydantic models, and collections of mixed Pydantic and Python
81+
models for a single level of nesting (list[Pydantic, int, float, str], tuple, dict).
82+
Nested combinations of mixtures of Pydantic and Python models are not supported.
83+
7984
Example:
8085
::
8186
from guidellm.utils.encoding import MessageEncoding
@@ -305,6 +310,11 @@ class Serializer:
305310
encoding/decoding cycles by storing class metadata and enabling proper
306311
reconstruction of complex objects. Supports both dictionary-based and
307312
sequence-based serialization strategies for different use cases.
313+
314+
For performance reasons, this serializer only supports Python primitives
315+
(int, float, str), Pydantic models, and collections of mixed Pydantic and Python
316+
models for a single level of nesting (list[Pydantic, int, float, str], tuple, dict).
317+
Nested combinations of mixtures of Pydantic and Python models are not supported.
308318
"""
309319

310320
def __init__(

0 commit comments

Comments
 (0)