Skip to content

Commit

Permalink
Update docs/user_guide/data_types_and_io/pydantic_basemodel.md
Browse files Browse the repository at this point in the history
Co-authored-by: David Espejo <[email protected]>
Signed-off-by: Han-Ru Chen (Future-Outlier) <[email protected]>
  • Loading branch information
Future-Outlier and davidmirror-ops authored Nov 21, 2024
1 parent c1de100 commit 9f7e452
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/user_guide/data_types_and_io/pydantic_basemodel.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Pydantic BaseModel V2 only works when you are using flytekit version >= v1.14.0.
With the 1.14 release, `flytekit` adopted `MessagePack` as the serialization format for Pydantic `BaseModel`, overcoming a major limitation of serialization into a JSON string within a Protobuf `struct` datatype like the previous versions do: to store `int` types, Protobuf's `struct` converts them to `float`, forcing users to write boilerplate code to workaround this issue. By default, `flytekit >= 1.14` will produce `msgpack` bytes literals when serializing dataclasses, preserving the types defined in your `BaseModel` class.
:::{important}
If you're serializing dataclasses using `flytekit` version >= v1.14.0 and you want to produce Protobuf `struct literal` instead, you can set environment variable `FLYTE_USE_OLD_DC_FORMAT` to `true`.
If you're using Flytekit version >= v1.14.0 and you want to produce protobuf struct literal for Pydantic BaseModels,

For more details, you can refer the MESSAGEPACK IDL RFC: https://github.com/flyteorg/flyte/blob/master/rfc/system/5741-binary-idl-with-message-pack.md
:::
Expand Down

0 comments on commit 9f7e452

Please sign in to comment.