Merge branch 'main' into r_cluster_branch

.github/utilities/run_examples.sh

@@ -9,6 +9,7 @@ excluded=()
 if [ "$1" = true ]; then
   excluded+=(
     "examples/datasets/load_data_from_web.ipynb"
+    "examples/benchmarking/published_results.ipynb"
     "examples/benchmarking/reference_results.ipynb"
     "examples/benchmarking/bakeoff_results.ipynb"
     "examples/benchmarking/regression.ipynb"
@@ -21,6 +22,7 @@ if [ "$1" = true ]; then
     "examples/classification/interval_based.ipynb"
     "examples/classification/shapelet_based.ipynb"
     "examples/classification/convolution_based.ipynb"
+    "examples/similarity_search/code_speed.ipynb"
 
   )
 fi

docs/api_reference/networks.rst

@@ -25,3 +25,7 @@ Deep learning networks
     LITENetwork
     AEBiGRUNetwork
     DisjointCNNNetwork
+    DCNNNetwork
+    AEDCNNNetwork
+    AEAttentionBiGRUNetwork
+    AEDRNNNetwork

docs/contributing.md

@@ -5,6 +5,13 @@ kinds of contributions, not just code. Improvements to docs, bug reports, and ta
 on communications or code of conduct responsibilities are all examples of valuable
 contributions beyond code which help make `aeon` a great package.
 
+Please consider whether you will be able to tackle and issue or pull request before
+assigning yourself to it. If the issue requires editing Python code, you should have
+some experience with Python and be able to run tests. If the issue tackles the
+specifics of a machine learning algorithm, some relevant knowledge of machine learning
+will be required. While we want to encourage new contributors, a base level
+of knowledge is required to make a meaningful contribution to certain issues.
+
 In the following we will give a brief overview of how to contribute to `aeon`. Making
 contributions to open source projects takes a bit of proactivity and can be daunting at
 first, but members of the community are here to help and answer questions. If you get
@@ -21,7 +28,9 @@ for creating a fork of `aeon`.
 to complete i.e. improving an algorithm, docstring or test. The [good first issue](https://github.com/aeon-toolkit/aeon/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
 list may be a good place to start.
 4. Post on the issue which you want to work on, so that others know you are working on
-it. To assign yourself an **Issue/Pull Request**, please post a comment in the issue
+it. **First ensure that the issue is not already being worked on. Look if there are any
+linked PRs and search the issue number in the pull requests list.**
+To assign yourself an **Issue/Pull Request**, please post a comment in the issue
 including '@aeon-actions-bot', the username of people to assign and the word `assign`:
 
     For example:
@@ -33,9 +42,11 @@ working on. A Core Developer may suggest a different issue if the one you chose
 complex or somebody is already working on it.
 5. Create a [pull request (PR)](https://github.com/aeon-toolkit/aeon/compare)
 with your changes from your fork. For help, see the [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
-or ask in Slack. Follow the PR template and checklist.
+or ask in Slack. Follow the PR template and checklist. Please make sure to include
+an appropriate [title tag](contributing/issues.md).
 6. A Core Developer will review your PR and may provide feedback, which you can then
-address. If you are unsure about any feedback, please ask for clarification.
+address. If you are unsure about any feedback, please ask for clarification. Please
+be patient, as Core Developers are volunteers and may be busy with other tasks.
 7. Once your PR is approved, it will be merged into the `aeon` repository. Thanks for
 making a contribution! Make sure you are included in the [list of contributors](contributors.md).
 
@@ -58,7 +69,8 @@ recognise various types of contributions. Take a look at our past and current
 If you are a new contributor, make sure we add you to our list of contributors. All
 contributions are recorded in [.all-contributorsrc](https://github.com/aeon-toolkit/aeon/blob/main/.all-contributorsrc).
 Alternatively, you can use the [@all-contributors](https://allcontributors.org/docs/en/bot/usage)
-bot to do this for you. A list of relevant tags can be found [here](https://allcontributors.org/docs/en/emoji-key).
+bot to do this for you. If the contribution is related to a PR, please only create this
+when the PR has merged. A list of relevant tags can be found [here](https://allcontributors.org/docs/en/emoji-key).
 
 ## Further Reading
 

docs/developer_guide.md

@@ -20,9 +20,6 @@ their [developer's guide](https://scikit-learn.org/stable/developers/index.html)
 :::{grid-item-card}
 :text-align: center
 
-:::{grid-item-card}
-:text-align: center
-
 AEP's
 
 ^^^