How to Contribute

Any contribution are welcomed. Here is a guide of how to conribute a spicific model to realseries.

Since RealSeries uses a split-joint structure to formulize the lib. To contribute a model is to follow the following steps:

1. create yourmodel.py in realseries/models;

2. inherite base.py to yourmodel.py;

3. develop your model;

4. write a jupyter notebook example and a documentation.