Skip to content

Commit

Permalink
[DOC] Refactor examples directory and link to docs/source/examples (#…
Browse files Browse the repository at this point in the history
…6210)

#### Reference Issues/PRs

Fixes #6148. 

#### What does this implement/fix? Explain your changes.
<!--
A clear and concise description of what you have implemented.
-->

I rearranged the examples dir to be similar to the docs/source/examples,
replaced docs/source/examples containing individual sym links inside
with just one directory sym link to examples, and adjusted the path of
some image links.

For comparison: 
https://www.sktime.net/en/stable/examples.html

https://duydlsktime.readthedocs.io/en/patch-docs-examples-0/examples.html
in case PR docs not yet rendered
  • Loading branch information
duydl authored Apr 11, 2024
1 parent db8d4b1 commit 19ea5ba
Show file tree
Hide file tree
Showing 48 changed files with 14 additions and 31 deletions.
1 change: 1 addition & 0 deletions docs/source/examples
9 changes: 9 additions & 0 deletions docs/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Forecasting
examples/01_forecasting.ipynb
examples/01a_forecasting_sklearn.ipynb
examples/01b_forecasting_proba.ipynb
examples/01c_forecasting_hierarchical_global.ipynb
examples/forecasting/*

Classification
Expand All @@ -22,6 +23,9 @@ Classification
:glob:

examples/02_classification.ipynb
examples/02a_classification_multivariate_cnn.ipynb
examples/02b_classification_multivariate_lstmfcn.ipynb
examples/02c_classification_multivariate_inceptiontime.ipynb
examples/classification/*

Regression
Expand Down Expand Up @@ -51,6 +55,9 @@ Transformation
.. nbgallery::
:glob:

examples/03_transformers.ipynb
examples/03a_transformers_cheat_sheet.ipynb
examples/03b_forecasting_transformers_pipelines_tuning.ipynb
examples/transformation/*

Data
Expand All @@ -68,5 +75,7 @@ Other
.. nbgallery::
:glob:

examples/00_sktime_intro.ipynb
examples/04_benchmarking.ipynb
examples/04_benchmarking_v2.ipynb
examples/other/*
1 change: 0 additions & 1 deletion docs/source/examples/01_forecasting.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/01a_forecasting_sklearn.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/01b_forecasting_proba.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/02_classification.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/04_benchmarking.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/AA_datatypes_and_datasets.ipynb

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/data/loading_data.ipynb

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/forecasting/window_splitters.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/img

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/other/distances.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/transformation/catch22.ipynb

This file was deleted.

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/transformation/interpolation.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/transformation/minirocket.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/transformation/plateau_finder.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/transformation/rocket.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/transformation/signature_method.ipynb

This file was deleted.

1 change: 0 additions & 1 deletion docs/source/examples/transformation/theta_transform.ipynb

This file was deleted.

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 19ea5ba

Please sign in to comment.