Add documentation part about custom serializers #39
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
caniko
requested changes
Apr 1, 2024
README.md
Outdated
Comment on lines
72
to
73
| If you're not happy with default `NumpyDataDict` serialization, as defined in [typing.py](./pydantic_numpy/helper/typing.py), you could define your own type with custom serializer using `NpArrayPydanticAnnotation.factory` | ||
| and its `serialize_numpy_array_to_json` argument taking `Callable[[npt.ArrayLike], Iterable]`. |
There was a problem hiding this comment.
Maybe something like this?
Suggested change
| If you're not happy with default `NumpyDataDict` serialization, as defined in [typing.py](./pydantic_numpy/helper/typing.py), you could define your own type with custom serializer using `NpArrayPydanticAnnotation.factory` | |
| and its `serialize_numpy_array_to_json` argument taking `Callable[[npt.ArrayLike], Iterable]`. | |
| If the default serialization of NumpyDataDict, as outlined in [typing.py](https://chat.openai.com/c/pydantic_numpy/helper/typing.py), doesn't meet your requirements, you have the option to define a custom type with its own serializer. This can be achieved using the NpArrayPydanticAnnotation.factory method, which accepts a custom serialization function through its serialize_numpy_array_to_json parameter. This parameter expects a function of the form Callable[[npt.ArrayLike], Iterable], allowing you to tailor the serialization process to your specific needs. |
There was a problem hiding this comment.
Yes, that's the better wording, fixed it!
P.S. Wondering how did chat.openai.com ended up in your example url? 1st of April? :)
Chore(version): bump PATCH
|
Fixed with #43 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Doc(README): add documentation part about custom serializers
Chore(version): bump PATCH
Partial of #38