search

aeon-toolkit / aeon

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

[DOC] Replace NOTES by REFERENCES in docstrings #2280

Closed hadifawaz1999 closed 3 weeks ago

hadifawaz1999 commented 3 weeks ago

Describe the issue linked to the documentation

Noticed that some docstrings use NOTES instead of REFERENCES in docstrings, making the api doc not linking refs correctly

Suggest a potential alternative/fix

just should be replaced, i noticed it in some deep learners but would be good to do a check all over aeon at some point

MatthewMiddlehurst commented 3 weeks ago

NOTES is a valid header, but if its used in place of references it should be replaced yeah

TonyBagnall commented 3 weeks ago

might require splitting into Notes and References, please post any instances here

aryanpola commented 3 weeks ago

Screenshot 2024-10-31 214208 aeon.classification.deep_learning._inception_time.py

TonyBagnall commented 3 weeks ago

so I would have Notes

Adapted from ...

References

..[1] Fawaz et al.

hadifawaz1999 commented 3 weeks ago

so I would have

Notes

Adapted from ...

References

..[1] Fawaz et al.

Yes this and also the paper references to be in references