Skip to content

Commit

Permalink
[DOC] Update examples webpage (#2396)
Browse files Browse the repository at this point in the history
* examples

* remove unused images

* index
  • Loading branch information
MatthewMiddlehurst authored Nov 27, 2024
1 parent 2ae9b84 commit dd32528
Show file tree
Hide file tree
Showing 13 changed files with 57 additions and 605 deletions.
6 changes: 3 additions & 3 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The core developers push forward `aeon`'s development and maintain the package.

`aeon` is an affiliated project of [NumFOCUS](https://numfocus.org/).

![https://numfocus.org/](images/other_logos/numfocus-logo.png){w=300px}
![https://numfocus.org/](images/other_logos/numfocus-logo.png){w=400px}

## History

Expand Down Expand Up @@ -134,7 +134,7 @@ and documentation hosting.

## Pre-fork Acknowledgements

<details><summary>`sktime` v0.16.0 core developers</summary>
<details><summary>sktime v0.16.0 core developers</summary>
<p>

The following listed contributors were part of the `sktime` core developer team at some
Expand Down Expand Up @@ -164,7 +164,7 @@ point prior to the split of the project.
</p>
</details>

<details><summary>`sktime` v0.16.0 funders</summary>
<details><summary>sktime v0.16.0 funders</summary>
<p>

As a fork of the `sktime` project, `aeon` has benefited from funding given to `sktime`
Expand Down
84 changes: 50 additions & 34 deletions docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Early TSC
:gutter: 1

:::{grid-item-card}
:img-top: /examples/regression/img/tser.png
:img-top: examples/regression/img/tser.png
:class-img-top: aeon-card-image-m
:link: /examples/regression/regression.ipynb
:link-type: ref
Expand Down Expand Up @@ -260,6 +260,17 @@ Signature method

:::

:::{grid-item-card}
:img-top: images/logo/aeon-logo-blue-2-transparent.png
:class-img-top: aeon-card-image-m
:link: /examples/transformations/channel_selection.ipynb
:link-type: ref
:text-align: center

Channel selection

:::

::::

## Segmentation
Expand Down Expand Up @@ -371,45 +382,40 @@ Benchmarking of similarity search speed-ups

:::


::::


## Data Formatting and Loading
## Forecasting

::::{grid} 2 3 4 4
:gutter: 1


:::{grid-item-card}
:img-top: examples/datasets/img/data.png
:img-top: images/logo/aeon-logo-blue-2-transparent.png
:class-img-top: aeon-card-image-m
:link: /examples/datasets/datasets.ipynb
:link: /examples/forecasting/forecasting.ipynb
:link-type: ref
:text-align: center

Data in aeon
Forecasting

:::

:::{grid-item-card}
:img-top: images/logo/aeon-logo-blue-2-transparent.png
:class-img-top: aeon-card-image-m
:link: /examples/datasets/data_structures.ipynb
:link-type: ref
:text-align: center
::::

Data structures and containers used in aeon
## Data Formatting and Loading

:::
::::{grid} 2 3 4 4
:gutter: 1

:::{grid-item-card}
:img-top: images/logo/aeon-logo-blue-2-transparent.png
:img-top: examples/datasets/img/data.png
:class-img-top: aeon-card-image-m
:link: /examples/datasets/data_conversions.ipynb
:link: /examples/datasets/datasets.ipynb
:link-type: ref
:text-align: center

Conversions between data structures
Data in aeon

:::

Expand Down Expand Up @@ -459,7 +465,6 @@ Unequal length series

:::


::::

## Benchmarking
Expand Down Expand Up @@ -511,17 +516,6 @@ Benchmarking extrinsic regression algorithms

:::

:::{grid-item-card}
:img-top: images/logo/aeon-logo-blue-2-transparent.png
:class-img-top: aeon-card-image-m
:link: /examples/benchmarking/bakeoff_results.ipynb
:link-type: ref
:text-align: center

Getting published bakeoff results

:::

::::

## Base
Expand Down Expand Up @@ -553,20 +547,42 @@ Series base classes

::::

## Utils
## Visualisation

::::{grid} 2 3 4 4
:gutter: 1

:::{grid-item-card}
:img-top: images/logo/aeon-logo-blue-2-transparent.png
:class-img-top: aeon-card-image-m
:link: /examples/utils/preprocessing.ipynb
:link: /examples/visualisation/plotting_series.ipynb
:link-type: ref
:text-align: center

Plotting time series

:::

:::{grid-item-card}
:img-top: images/logo/aeon-logo-blue-2-transparent.png
:class-img-top: aeon-card-image-m
:link: /examples/visualisation/plotting_results.ipynb
:link-type: ref
:text-align: center

Preprocessing collections of time series
Plotting results

:::

::::
:::{grid-item-card}
:img-top: images/logo/aeon-logo-blue-2-transparent.png
:class-img-top: aeon-card-image-m
:link: /examples/visualisation/plotting_series.ipynb
:link-type: ref
:text-align: center

Plotting for specific learning tasks

:::

::::
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ segmentation and similarity search.
:gutter: 3

:::{grid-item-card}
:img-top: examples/img/tsc.png
:img-top: examples/classification/img/tsc.png
:class-img-top: aeon-card-image
:text-align: center

Expand All @@ -54,7 +54,7 @@ Classification
:::

:::{grid-item-card}
:img-top: examples/img/tser.png
:img-top: examples/regression/img/tser.png
:class-img-top: aeon-card-image
:text-align: center

Expand All @@ -73,7 +73,7 @@ Regression
:::

:::{grid-item-card}
:img-top: examples/img/tscl.png
:img-top: examples/clustering/img/tscl.png
:class-img-top: aeon-card-image
:text-align: center

Expand Down
2 changes: 1 addition & 1 deletion examples/classification/classification.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
"the [ArrowHead dataset](https://timeseriesclassification.com/description.php?Dataset=ArrowHead) we have just loaded consists of outlines of the images of\n",
"arrow heads. The classification of projectile points is an important topic in anthropology.\n",
"\n",
"<img src=\"../img/arrow-heads.png\" width=\"600\" alt=\"arrow heads\">\n",
"<img src=\"img/arrow-heads.png\" width=\"600\" alt=\"arrow heads\">\n",
"\n",
"The shapes of the projectile points are converted into a sequence using the\n",
"angle-based method as described in this [blog post](https://izbicki.me/blog/converting-images-into-time-series-for-data-mining.html) about converting images into time series for data mining.\n",
Expand Down
File renamed without changes
Binary file removed examples/img/OSULeaf.jpg
Binary file not shown.
Binary file removed examples/img/dtw.png
Binary file not shown.
Binary file removed examples/img/leaf_types.png
Binary file not shown.
Binary file removed examples/img/shapelet_classifier.png
Binary file not shown.
Binary file removed examples/img/tsc.png
Binary file not shown.
Binary file removed examples/img/tscl.png
Binary file not shown.
Binary file removed examples/img/tser.png
Binary file not shown.
Loading

0 comments on commit dd32528

Please sign in to comment.