Skip to content

Commit

Permalink
user guide start
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewMiddlehurst committed Nov 16, 2023
1 parent cfab07f commit e5f8709
Show file tree
Hide file tree
Showing 6 changed files with 103 additions and 10 deletions.
File renamed without changes
62 changes: 53 additions & 9 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:gutter: 3

:::{grid-item-card}
:img-top: examples/images/wip.png
:img-top: examples/images/database.png
:text-align: center

tsml-eval Data Format
Expand All @@ -25,6 +25,50 @@ Datasets

:::

:::{grid-item-card}
:img-top: examples/images/wip.png
:text-align: center

tsml-eval Results Evaluation

^^^

Placeholder.

+++

```{button-ref} /examples/evaluation.ipynb
:color: primary
:click-parent:
:expand:

Evaluation
```

:::

:::{grid-item-card}
:img-top: examples/images/wip.png
:text-align: center

tsml-eval Results Format

^^^

Placeholder.

+++

```{button-ref} /examples/results_format.ipynb
:color: primary
:click-parent:
:expand:

Results
```

:::

:::{grid-item-card}
:img-top: examples/images/TSC.png
:text-align: center
Expand Down Expand Up @@ -92,45 +136,45 @@ TSCL
:::

:::{grid-item-card}
:img-top: examples/images/wip.png
:img-top: examples/images/TSCL.png
:text-align: center

tsml-eval Results Evaluation
Time Series Clustering

^^^

Placeholder.

+++

```{button-ref} /examples/evaluation.ipynb
```{button-ref} /examples/clustering_experiments.ipynb
:color: primary
:click-parent:
:expand:

Evaluation
TSCL
```

:::

:::{grid-item-card}
:img-top: examples/images/wip.png
:img-top: examples/images/forecasting.png
:text-align: center

tsml-eval Results Format
Time Series Forecasting

^^^

Placeholder.

+++

```{button-ref} /examples/results_format.ipynb
```{button-ref} /examples/forecasting_experiments.ipynb
:color: primary
:click-parent:
:expand:

Results
Forecasting
```

:::
Expand Down
2 changes: 1 addition & 1 deletion examples/datasets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"\n",
"Placeholder\n",
"\n",
"<img src=\"./images/wip.png\" width=\"600\" alt=\"wip\"> [<i>&#x200B;</i>](./images/wip.png)"
"<img src=\"./images/wip.png\" width=\"600\" alt=\"wip\"> [<i>&#x200B;</i>](./images/database.png)"
],
"metadata": {
"collapsed": false
Expand Down
49 changes: 49 additions & 0 deletions examples/forecasting_experiments.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"cells": [
{
"cell_type": "markdown",
"source": [
"# Time Series Forecasting Experiments\n",
"\n",
"Placeholder.\n",
"\n",
"<img src=\"./images/TSC.png\" width=\"600\" alt=\"time series classification\"> [<i>&#x200B;</i>](./images/forecasting.png)"
],
"metadata": {
"collapsed": false
}
},
{
"cell_type": "code",
"execution_count": null,
"outputs": [],
"source": [
"print(\"Placeholder\")"
],
"metadata": {
"collapsed": false
}
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 2
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython2",
"version": "2.7.6"
}
},
"nbformat": 4,
"nbformat_minor": 0
}
Binary file added examples/images/database.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/images/forecasting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e5f8709

Please sign in to comment.