From 419b553209d0161a2cdee484f2d83baec5221233 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Thu, 25 Jul 2024 21:50:12 -0700 Subject: [PATCH 1/3] add codecov --- .Rbuildignore | 1 + README.Rmd | 3 ++- README.md | 3 +++ codecov.yml | 14 ++++++++++++++ 4 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 codecov.yml diff --git a/.Rbuildignore b/.Rbuildignore index e57c00f..dc05ba9 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -10,3 +10,4 @@ ^docs$ ^pkgdown$ ^vignettes/articles$ +^codecov\.yml$ diff --git a/README.Rmd b/README.Rmd index e8b6b8f..db463b3 100644 --- a/README.Rmd +++ b/README.Rmd @@ -16,6 +16,7 @@ knitr::opts_chunk$set( # orbital +[![Codecov test coverage](https://codecov.io/gh/tidymodels/orbital/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/orbital?branch=main) The goal of orbital is to enable running predictions of tidymodels [workflows](https://workflows.tidymodels.org/) inside databases. @@ -76,4 +77,4 @@ predict(orbital_obj, as_tibble(mtcars)) # Supported models and recipes steps Full list of supported models and recipes steps can be found here: -#' `vignette("supported-models")`. \ No newline at end of file +#' `vignette("supported-models")`. diff --git a/README.md b/README.md index 3223a04..49364e4 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ # orbital + +[![Codecov test +coverage](https://codecov.io/gh/tidymodels/orbital/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/orbital?branch=main) The goal of orbital is to enable running predictions of tidymodels diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..04c5585 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,14 @@ +comment: false + +coverage: + status: + project: + default: + target: auto + threshold: 1% + informational: true + patch: + default: + target: auto + threshold: 1% + informational: true From 5f99f6a01b621b7d10b08c9256a3f747565d3763 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Thu, 25 Jul 2024 21:57:01 -0700 Subject: [PATCH 2/3] add more stuff to readme --- .github/CODE_OF_CONDUCT.md | 126 +++++++++++++++++++++++++++++++++++++ README.Rmd | 15 +++++ README.md | 27 ++++++++ 3 files changed, 168 insertions(+) create mode 100644 .github/CODE_OF_CONDUCT.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3ac34c8 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,126 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at codeofconduct@posit.co. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion]. + +For answers to common questions about this code of conduct, see the FAQ at +. Translations are available at . + +[homepage]: https://www.contributor-covenant.org diff --git a/README.Rmd b/README.Rmd index db463b3..bd54def 100644 --- a/README.Rmd +++ b/README.Rmd @@ -16,7 +16,10 @@ knitr::opts_chunk$set( # orbital +[![R-CMD-check](https://github.com/tidymodels/orbital/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/orbital/actions/workflows/R-CMD-check.yaml) +[![CRAN status](https://www.r-pkg.org/badges/version/orbital)](https://CRAN.R-project.org/package=orbital) [![Codecov test coverage](https://codecov.io/gh/tidymodels/orbital/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/orbital?branch=main) +[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) The goal of orbital is to enable running predictions of tidymodels [workflows](https://workflows.tidymodels.org/) inside databases. @@ -78,3 +81,15 @@ predict(orbital_obj, as_tibble(mtcars)) Full list of supported models and recipes steps can be found here: #' `vignette("supported-models")`. + +## contributing + +This project is released with a [Contributor Code of Conduct](https://github.com/tidymodels/orbital/blob/main/.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms. + +- For questions and discussions about tidymodels packages, modeling, and machine learning, please [post on Posit Community](https://forum.posit.co/new-topic?category_id=15&tags=tidymodels,question). + +- If you think you have encountered a bug, please [submit an issue](https://github.com/tidymodels/orbital/issues). + +- Either way, learn how to create and share a [reprex](https://reprex.tidyverse.org/articles/articles/learn-reprex.html) (a minimal, reproducible example), to clearly communicate about your code. + +- Check out further details on [contributing guidelines for tidymodels packages](https://www.tidymodels.org/contribute/) and [how to get help](https://www.tidymodels.org/help/). diff --git a/README.md b/README.md index 49364e4..3bbe0b8 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,13 @@ +[![R-CMD-check](https://github.com/tidymodels/orbital/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/orbital/actions/workflows/R-CMD-check.yaml) +[![CRAN +status](https://www.r-pkg.org/badges/version/orbital)](https://CRAN.R-project.org/package=orbital) [![Codecov test coverage](https://codecov.io/gh/tidymodels/orbital/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/orbital?branch=main) +[![Lifecycle: +experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) The goal of orbital is to enable running predictions of tidymodels @@ -112,3 +117,25 @@ predict(orbital_obj, as_tibble(mtcars)) Full list of supported models and recipes steps can be found here: \#’ `vignette("supported-models")`. + +## contributing + +This project is released with a [Contributor Code of +Conduct](https://github.com/tidymodels/orbital/blob/main/.github/CODE_OF_CONDUCT.md). +By contributing to this project, you agree to abide by its terms. + +- For questions and discussions about tidymodels packages, modeling, and + machine learning, please [post on Posit + Community](https://forum.posit.co/new-topic?category_id=15&tags=tidymodels,question). + +- If you think you have encountered a bug, please [submit an + issue](https://github.com/tidymodels/orbital/issues). + +- Either way, learn how to create and share a + [reprex](https://reprex.tidyverse.org/articles/articles/learn-reprex.html) + (a minimal, reproducible example), to clearly communicate about your + code. + +- Check out further details on [contributing guidelines for tidymodels + packages](https://www.tidymodels.org/contribute/) and [how to get + help](https://www.tidymodels.org/help/). From 1f1e0005490b52320b7747c7f56b14ad12d0a746 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Thu, 25 Jul 2024 22:02:06 -0700 Subject: [PATCH 3/3] show database prediction on readme --- README.Rmd | 25 ++++++++++++++++++++- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 89 insertions(+), 2 deletions(-) diff --git a/README.Rmd b/README.Rmd index bd54def..9661c08 100644 --- a/README.Rmd +++ b/README.Rmd @@ -47,7 +47,7 @@ Given a fitted workflow #| message: false library(tidymodels) -rec_spec <- recipe(mpg ~ ., data = mtcars) %>% +rec_spec <- recipe(mpg ~ ., data = mtcars) |> step_normalize(all_numeric_predictors()) lm_spec <- linear_reg() @@ -77,6 +77,29 @@ and then "predicting" with it using `predict()` to get the same results predict(orbital_obj, as_tibble(mtcars)) ``` +you can also predict in most SQL databases + +```{r} +library(DBI) +library(RSQLite) + +con <- dbConnect(SQLite(), path = ":memory:") +db_mtcars <- copy_to(con, mtcars) + +predict(orbital_obj, db_mtcars) +``` + +and spark databases + +```{r} +library(sparklyr) +sc <- spark_connect(master = "local") + +sc_mtcars <- copy_to(sc, mtcars, overwrite = TRUE) + +predict(orbital_obj, sc_mtcars) +``` + # Supported models and recipes steps Full list of supported models and recipes steps can be found here: diff --git a/README.md b/README.md index 3bbe0b8..1c2ce56 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Given a fitted workflow ``` r library(tidymodels) -rec_spec <- recipe(mpg ~ ., data = mtcars) %>% +rec_spec <- recipe(mpg ~ ., data = mtcars) |> step_normalize(all_numeric_predictors()) lm_spec <- linear_reg() @@ -113,6 +113,70 @@ predict(orbital_obj, as_tibble(mtcars)) #> # ℹ 22 more rows ``` +you can also predict in most SQL databases + +``` r +library(DBI) +library(RSQLite) + +con <- dbConnect(SQLite(), path = ":memory:") +db_mtcars <- copy_to(con, mtcars) + +predict(orbital_obj, db_mtcars) +#> # Source: SQL [?? x 1] +#> # Database: sqlite 3.46.0 [] +#> .pred +#> +#> 1 22.6 +#> 2 22.1 +#> 3 26.3 +#> 4 21.2 +#> 5 17.7 +#> 6 20.4 +#> 7 14.4 +#> 8 22.5 +#> 9 24.4 +#> 10 18.7 +#> # ℹ more rows +``` + +and spark databases + +``` r +library(sparklyr) +#> +#> Attaching package: 'sparklyr' +#> The following object is masked from 'package:purrr': +#> +#> invoke +#> The following object is masked from 'package:stats': +#> +#> filter +``` + +``` r +sc <- spark_connect(master = "local") + +sc_mtcars <- copy_to(sc, mtcars, overwrite = TRUE) + +predict(orbital_obj, sc_mtcars) +#> # Source: SQL [?? x 1] +#> # Database: spark_connection +#> .pred +#> +#> 1 22.6 +#> 2 22.1 +#> 3 26.3 +#> 4 21.2 +#> 5 17.7 +#> 6 20.4 +#> 7 14.4 +#> 8 22.5 +#> 9 24.4 +#> 10 18.7 +#> # ℹ more rows +``` + # Supported models and recipes steps Full list of supported models and recipes steps can be found here: \#’