{"id":13400669,"url":"https://github.com/ModelOriented/ingredients","last_synced_at":"2025-03-14T06:31:51.845Z","repository":{"id":34560915,"uuid":"164164514","full_name":"ModelOriented/ingredients","owner":"ModelOriented","description":"Effects and Importances of Model Ingredients","archived":false,"fork":false,"pushed_at":"2023-03-15T21:16:09.000Z","size":228284,"stargazers_count":37,"open_issues_count":5,"forks_count":18,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-05-01T19:36:29.752Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://modeloriented.github.io/ingredients/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ModelOriented.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-01-04T23:25:22.000Z","updated_at":"2024-03-18T14:50:58.000Z","dependencies_parsed_at":"2024-01-15T03:58:07.455Z","dependency_job_id":null,"html_url":"https://github.com/ModelOriented/ingredients","commit_stats":{"total_commits":306,"total_committers":20,"mean_commits":15.3,"dds":0.3921568627450981,"last_synced_commit":"d405a01b391731513f890db03e4949056679a009"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModelOriented%2Fingredients","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModelOriented%2Fingredients/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModelOriented%2Fingredients/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModelOriented%2Fingredients/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ModelOriented","download_url":"https://codeload.github.com/ModelOriented/ingredients/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243537866,"owners_count":20307098,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T19:00:54.473Z","updated_at":"2025-03-14T06:31:51.833Z","avatar_url":"https://github.com/ModelOriented.png","language":"R","funding_links":[],"categories":["R","Technical Resources"],"sub_categories":["Open Source/Access Responsible AI Software Packages"],"readme":"# Model Ingredients \u003cimg src=\"man/figures/logo.png\" align=\"right\" width=\"150\"/\u003e\n\n[![R build status](https://github.com/ModelOriented/ingredients/workflows/R-CMD-check/badge.svg)](https://github.com/ModelOriented/ingredients/actions?query=workflow%3AR-CMD-check)\n[![Coverage Status](https://img.shields.io/codecov/c/github/ModelOriented/ingredients/master.svg)](https://codecov.io/github/ModelOriented/ingredients?branch=master)\n[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/ingredients)](https://cran.r-project.org/package=ingredients)\n[![Total Downloads](http://cranlogs.r-pkg.org/badges/grand-total/ingredients?color=orange)](http://cranlogs.r-pkg.org/badges/grand-total/ingredients)\n\n## Overview\n\nThe `ingredients` package is a collection of tools for assessment of feature importance and feature effects. It is imported and used to compute model explanations in multiple packages e.g. [`DALEX`](https://github.com/ModelOriented/DALEX), [`modelStudio`](https://github.com/ModelOriented/modelStudio), [`arenar`](https://github.com/ModelOriented/ArenaR).\n\nThe philosophy behind `ingredients` explanations is described in the [Explanatory Model Analysis: Explore, Explain, and Examine Predictive Models](https://pbiecek.github.io/ema/) e-book. The `ingredients` package is a part of [DrWhy.AI](http://DrWhy.AI) universe. \n\nKey functions: \n\n* `feature_importance()` for assessment of global level feature importance, \n* `ceteris_paribus()` for calculation of the Ceteris Paribus / What-If Profiles (read more at https://ema.drwhy.ai/ceterisParibus.html),\n* `partial_dependence()` for Partial Dependence Plots,\n* `conditional_dependence()` for Conditional Dependence Plots also called M Plots,\n* `accumulated_dependence()` for Accumulated Local Effects Plots,\n* `aggregate_profiles()` and `cluster_profiles()` for aggregation of Ceteris Paribus Profiles,\n* `calculate_oscillations()` for calculation of the Ceteris Paribus Oscillations (read more at https://ema.drwhy.ai/ceterisParibusOscillations.html),\n* `ceteris_paribus_2d()` for Ceteris Paribus 2D Profiles,\n* generic `print()` and `plot()` for better usability of selected explanations,\n* generic `plotD3()` for interactive, D3 based explanations,\n* generic `describe()` for explanations in natural language.\n\n## Installation\n\n```r\n# the easiest way to get ingredients is to install it from CRAN:\ninstall.packages(\"ingredients\")\n\n# Or the the development version from GitHub:\n# install.packages(\"devtools\")\ndevtools::install_github(\"ModelOriented/ingredients\")\n```\n\n## Interactive plots with D3\n\n`feature_importance()`, `ceteris_paribus()` and `aggregated_profiles()` also work with **D3**:\n[see an example](https://modeloriented.github.io/ingredients/ceterisParibusDemo.html).\n\n![plotD3](man/figures/demo.gif)\n\n## Acknowledgments\n\nWork on this package was financially supported by the `NCN Opus grant 2016/21/B/ST6/02176`.\n    \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FModelOriented%2Fingredients","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FModelOriented%2Fingredients","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FModelOriented%2Fingredients/lists"}