mirror of
https://github.com/p2p-ld/numpydantic.git
synced 2024-11-12 17:54:29 +00:00
20 lines
704 B
Markdown
20 lines
704 B
Markdown
|
# numpydantic
|
||
|
|
|
||
|
|
Type and shape validation and serialization for numpy arrays in pydantic models
|
||
|
|
|
||
|
|
This package was picked out of [nwb-linkml](https://github.com/p2p-ld/nwb-linkml/), a
|
||
|
|
translation of the [NWB](https://www.nwb.org/) schema language and data format to
|
||
|
|
linkML and pydantic models.
|
||
|
|
|
||
|
|
It does two primary things:
|
||
|
|
- **Provide types** - Annotations (based on [npytyping](https://github.com/ramonhagenaars/nptyping))
|
||
|
|
for specifying numpy arrays in pydantic models, and
|
||
|
|
- **Generate models from LinkML** - extend the LinkML pydantic generator to create models that
|
||
|
|
that use the [linkml-arrays](https://github.com/linkml/linkml-arrays) syntax
|
||
|
|
|
||
|
|
```{toctree}
|
||
|
|
:maxdepth: 2
|
||
|
|
:caption: Contents:
|
||
|
|
```
|
||
|
|
|