search

antoinecarme / pyaf

PyAF is an Open Source Python library for Automatic Time Series Forecasting built on top of popular pydata modules.
BSD 3-Clause "New" or "Revised" License
456 stars 73 forks source link

Provide some UML docs for PyAF integrators #233

Closed antoinecarme closed 1 year ago

antoinecarme commented 1 year ago

At least some class diagrams to help with the usage of hierarchical models.

antoinecarme commented 1 year ago

Use umbrello

https://docs.kde.org/trunk5/en/umbrello/umbrello/

Umbrello can extract class diagrams from existing python code.

antoinecarme commented 1 year ago

Signal Hierarchies :

image

antoinecarme commented 1 year ago

Hierarchical Engines

image

antoinecarme commented 1 year ago

Options :

image

antoinecarme commented 1 year ago

Time Series Model :

image

antoinecarme commented 1 year ago

All the docs are now available here :

https://github.com/antoinecarme/pyaf/tree/5.0-Fixes/docs/for_developpers/uml

antoinecarme commented 1 year ago

CLOSING.