Developer Guide¶
Welcome to the aeon
developer guide. This guide is intended for new developers and
current developers who want to learn about specific topics for code and non-code
developments.
For a step-by-step guide for setting up a development version of aeon
and creating a pull request, see the contributing guide. At any point
during the process, feel free to post questions on Slack or ask core developers
for help.
aeon
aims to follow the scikit-learn
API and conventions whenever possible. If
you’re new to scikit-learn
, take a look at their getting-started guide.
If you’re already familiar with scikit-learn
, you may still learn something new from
their developer’s guide.
Adding Estimators
A guide to creating new aeon
estimators.
AEP’s
Writing aeon
Enhancement Proposals (AEP).
Coding Standards
Coding standards for the aeon
code base.
CI/CD
A description of the aeon
CI/CD pipeline.
Dependencies
A guide to the types of aeon
dependencies.
Deprecation
Deprecation policy for aeon
.
Developer Installation
A guide to installing aeon
for development.
Documentation
A guide to writing aeon
documentation and docstrings.
Release
The aeon
release process.
Testing
The aeon
testing framework.