p2p-ld/numpydantic
1
0
Fork 0
mirror of https://github.com/p2p-ld/numpydantic.git synced 2024-11-12 17:54:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

further fixing readme

Browse source
This commit is contained in:
sneakers-the-rat 2024-05-20 21:29:01 -07:00
parent 1ae235cec6
commit 927964d3ff
Signed by untrusted user who does not match committer: jonny
GPG key ID: 6DCB96EF1E4D232D
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -34,8 +34,11 @@ generating JSON Schema, serialization to JSON
- **Types** - Annotations (based on [npytyping](https://github.com/ramonhagenaars/nptyping))
for specifying arrays in pydantic models
- **Validation** - Shape, dtype, and other array validations
- **Interfaces** - Works with {mod}`~.interface.numpy`, {mod}`~.interface.dask`, {mod}`~.interface.hdf5`,
{mod}`~.interface.video`, and {mod}`~.interface.zarr`,
- **Interfaces** - Works with [`numpy`](https://numpydantic.readthedocs.io/en/latest/api/interface/numpy.html),
[`dask`](https://numpydantic.readthedocs.io/en/latest/api/interface/dask.html),
[`hdf5`](https://numpydantic.readthedocs.io/en/latest/api/interface/hdf5.html),
[`video`](https://numpydantic.readthedocs.io/en/latest/api/interface/video.html),
[`zarr`](https://numpydantic.readthedocs.io/en/latest/api/interface/zarr.html),
and a simple extension system to make it work with whatever else you want!
- **Serialization** - Dump an array as a JSON-compatible array-of-arrays with enough metadata to be able to
recreate the model in the native format