diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..5ce6e2e --- /dev/null +++ b/codecov.yml @@ -0,0 +1,10 @@ +coverage: + require_ci_to_pass: false + status: + project: + default: + target: 95% + patch: + default: + target: 95% + informational: true diff --git a/docs/README.md b/docs/README.md index 7ce567b..6756aa0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,32 +13,32 @@ Prophetverse leverages the theory behind the Prophet model for time series forec
-- :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__ +- :material-school:{ .lg .middle } __Theory__ --- - Install `Prophetverse` with `pip` and get up - and forecasting in minutes + Understand the idea behind the model and how it works - [:octicons-arrow-right-24: Getting started](getting-started) + [:octicons-arrow-right-24: Read the post](the-theory) -- :material-school:{ .lg .middle } __Theory__ +- :material-lightbulb-on:{ .lg .middle } __Basic examples__ --- - Understand the idea behind the model and how it works + Go the example gallery and see how to use the model, and its features! - [:octicons-arrow-right-24: Read the post](the-theory) + [:octicons-arrow-right-24: Examples](tutorial/univariate) -- :material-file:{ .lg .middle } __Examples__ +- :material-cogs:{ .lg .middle } __Advanced examples__ --- - Go the example gallery and see how to use the model, and its features! + Learn how to customize timeseries components + + [:octicons-arrow-right-24: How-to](howto) - [:octicons-arrow-right-24: Examples](examples/univariate) -- :material-book:{ .lg .middle } __Reference__ +- :material-book-open-page-variant:{ .lg .middle } __Reference__ --- diff --git a/docs/howto/index.md b/docs/howto/index.md new file mode 100644 index 0000000..6126a94 --- /dev/null +++ b/docs/howto/index.md @@ -0,0 +1,33 @@ +# How-to + +In this documentation section, you will find how you can create more advanced patterns +
+ +- :material-chart-line:{ .lg .middle } __Custom timeseries component__ + + --- + + Know how to create a custom timeseries component and enhance your forecasting + capabilities! + + [:octicons-arrow-right-24: Custom effect](custom-effects) + +- :material-trending-up:{ .lg .middle } __Custom trend__ + + --- + + See a practical example of how to create a custom trend and + use it in your forecasting + + [:octicons-arrow-right-24: Custom trend](custom-trend) + +- :material-chart-multiline:{ .lg .middle } __Composition of timeseries components__ + + --- + + Learn how to use different timeseries components to create a more complex + forecasting model + + [:octicons-arrow-right-24: Composite exogenous effect](composite-exogenous-effects) + +
\ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 91991a6..4f0ced0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,6 +8,7 @@ theme: - navigation.tabs - navigation.instant - navigation.instant.progress + - search - toc.integrate - toc.follow palette: @@ -41,6 +42,7 @@ nav: - Hierarchical Time Series: tutorial/hierarchical/index.md - Nonnegative timeseries: tutorial/count-data/index.md - How-to 🛠️: + - Overview: howto/index.md - Custom Exogenous Effects ✨ : howto/custom-effects/index.md - Custom Trend 🌟: howto/custom-trend/index.md - Composite Exogenous Effects: howto/composite-exogenous-effects/index.md diff --git a/pyproject.toml b/pyproject.toml index 6eb5192..3b78fc3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "prophetverse" -version = "0.4.1" +version = "0.5.0" description = "" authors = ["Felipe Angelim "] readme = "README.md"