https://github.com/tidymodels/probably
Tools for post-processing class probability estimates
https://github.com/tidymodels/probably
Last synced: about 1 month ago
JSON representation
Tools for post-processing class probability estimates
- Host: GitHub
- URL: https://github.com/tidymodels/probably
- Owner: tidymodels
- License: other
- Created: 2018-09-11T19:02:58.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-10T22:43:12.000Z (4 months ago)
- Last Synced: 2025-04-03T15:11:12.483Z (about 2 months ago)
- Language: R
- Homepage: https://probably.tidymodels.org/
- Size: 16.3 MB
- Stars: 116
- Watchers: 8
- Forks: 15
- Open Issues: 21
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
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%"
)
```
# probably 
[](https://app.codecov.io/gh/tidymodels/probably?branch=main)
[](https://lifecycle.r-lib.org/articles/stages.html)
[](https://github.com/tidymodels/probably/actions/workflows/R-CMD-check.yaml)
## Introduction
probably contains tools to facilitate activities such as:
* Conversion of probabilities to discrete class predictions.
* Investigating and estimating optimal probability thresholds.
* Calibration assessments and remediation for classification and regression models.
* Inclusion of _equivocal zones_ where the probabilities are too uncertain to report a prediction.
## Installation
You can install probably from CRAN with:
```{r, eval = FALSE}
install.packages("probably")
```
You can install the development version of probably from GitHub with:
```{r, eval = FALSE}
# install.packages("pak")
pak::pak("tidymodels/probably")
```
## Examples
Good places to look for examples of using probably are the vignettes.
* `vignette("equivocal-zones", "probably")` discusses the new `class_pred` class that probably provides for working with equivocal zones.
* `vignette("where-to-use", "probably")` discusses how probably fits in with the rest of the tidymodels ecosystem, and provides an example of optimizing class probability thresholds.
## Contributing
This project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/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 RStudio Community](https://community.rstudio.com/new-topic?category_id=15&tags=tidymodels,question).
- If you think you have encountered a bug, please [submit an issue](https://github.com/tidymodels/probably/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/).