numpydantic/docs/index.md

32 lines
480 B
Markdown

# numpydantic
Type and shape validation and serialization for numpy arrays in pydantic models
- **Provide types** - Annotations (based on [npytyping](https://github.com/ramonhagenaars/nptyping))
for specifying numpy arrays in pydantic models, and
```{toctree}
:maxdepth: 2
:caption: Contents
:hidden: true
overview
ndarray
hooks
todo
```
```{toctree}
:maxdepth: 2
:caption: API
:hidden: true
api/index
api/ndarray
api/proxy
api/linkml/index
api/maps
api/monkeypatch
```