search

aeon-toolkit / aeon

A toolkit for machine learning from time series
https://aeon-toolkit.org/
BSD 3-Clause "New" or "Revised" License
978 stars 118 forks source link

[DOC] Mix Docstring styles in aeon. #1540

Closed aadya940 closed 2 months ago

aadya940 commented 4 months ago

Describe the issue linked to the documentation

Some methods uses Parameters, Returns in the docstring whereas some methods uses Arguments, Returns, for example, AEFCNNetwork.build_network. I think we could use the same style for consistency, shifting everything to Numpy style docstrings (Parameters, Returns)?

Suggest a potential alternative/fix

No response

TonyBagnall commented 4 months ago

yes I agree

Moonzyyy commented 3 months ago

Just went through the doc and haven't seen any (Arguments, Returns). I am assuming someone has fixed this, but hasn't closed this issue

aadya940 commented 3 months ago

Check aeon.networks._ae_fcn.py. Check the build_network method in the file.

aadya940 commented 3 months ago

You can find other files using grep -i if you're using linux.

IRKnyazev commented 2 months ago

Aeon-Assign bot assign @IRKnyazev