https://github.com/tidymodels/dials

Tools for creating tuning parameter values
https://github.com/tidymodels/dials

Last synced: 3 days ago
JSON representation

Tools for creating tuning parameter values

• Host: GitHub
• URL: https://github.com/tidymodels/dials
• Owner: tidymodels
• License: other
• Created: 2018-07-23T03:07:49.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-11-08T19:23:54.000Z (4 days ago)
• Last Synced: 2024-11-08T20:25:13.188Z (4 days ago)
• Language: R
• Homepage: https://dials.tidymodels.org/
• Size: 9.32 MB
• Stars: 113
• Watchers: 10
• Forks: 27
• Open Issues: 15
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - tidymodels/dials - Tools for creating tuning parameter values (R)

README

        
---

output: github_document

editor_options: 

  chunk_output_type: console

---

```{r setup, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# dials 

[![R-CMD-check](https://github.com/tidymodels/dials/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/dials/actions/workflows/R-CMD-check.yaml)

[![Codecov test coverage](https://codecov.io/gh/tidymodels/dials/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/dials?branch=main)

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/dials)](https://CRAN.R-project.org/package=dials)

[![Downloads](http://cranlogs.r-pkg.org/badges/dials)](https://CRAN.R-project.org/package=dials)

[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)

[![R-CMD-check-hard](https://github.com/tidymodels/dials/actions/workflows/R-CMD-check-hard.yaml/badge.svg)](https://github.com/tidymodels/dials/actions/workflows/R-CMD-check-hard.yaml)

## Overview

This package contains _infrastructure_ to create and manage values of tuning parameters for the tidymodels packages. If you are looking for _how to_ tune parameters in tidymodels, please look at the [tune](https://tune.tidymodels.org/) package and [tidymodels.org](https://www.tidymodels.org/). 

The name reflects the idea that tuning predictive models can be like turning a set of dials on a complex machine under duress. 



## Installation

You can install the released version of dials from [CRAN](https://CRAN.R-project.org) with:

```{r}

#| eval: false

install.packages("dials")

```

You can install the development version from Github with:

```{r}

#| eval: false

# install.packages("pak")

pak::pak("tidymodels/dials")

```

## Contributing

Please note that the dials project is released with a [Contributor Code of Conduct](https://dials.tidymodels.org/CODE_OF_CONDUCT.html). 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/dials/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/).