sweep yaml

Author: MatthewMiddlehurst

sweep.yaml

@@ -0,0 +1,23 @@
+gha_enabled: True
+branch: "main"
+blocked_dirs: [".github/"]
+draft: False
+description: "time-series-machine-learning/tsml is a Python project for time series machine learning algorithms following the scikit-learn interface. Write code that adheres to PEP8 and is formatted to the Black code style. The projects documentation is built using Sphinx and MyST, and unit testing is done using pytest."
+
+docs:
+  scikit-learn: ["https://scikit-learn.org/stable/", "Estimator algorithms from scikit-learn are one of the options available in our experiment functions."]
+  sklearn: ["https://scikit-learn.org/stable/", "Estimator algorithms from scikit-learn are one of the options available in our experiment functions."]
+  numpy: ["https://numpy.org/doc/stable/", "We use numpy as a data container and for mathematical operations."]
+  numba: ["https://numba.readthedocs.io/en/stable/", "We use numba to speed up functions where possible."]
+  sphinx: ["https://www.sphinx-doc.org/en/master/", "We use sphinx to generate our documentation."]
+  myst: ["https://myst-parser.readthedocs.io/en/stable/", "We use myst to write our documentation in markdown."]
+  pytest: ["https://docs.pytest.org/en/stable/", "We use pytest for unit testing."]
+
+sandbox:
+  install:
+    - pre-commit install
+  check:
+    - git add . && pre-commit run --files {file_path} || exit 0
+
+rules:
+  - ""