Comments (4)
-1. readability: DESCRIPTION change URL to https://github.com/ModelOriented/ingredients
update demo.png in README
-
in many places in documentation
x
should be documented as explainer first and
data/y/predict
_function should be placed as last parameters in function
ex: conditional_dependency.R, feature_importance.R, ... -
placement of
...
parameter is inconsistent across many functions
- accumulated_dependency.R
- aspect_importance.R
- conditional_dependency.R
- feature_importance.R
- partial_dependency.R
- more
- parameters in documentation are in different order than in function call
- aggregate_profiles.R
- cluster_profiles.R
- change parameter name
- aspect_importance.R
aspects_list
could be justaspects
(likevariables
) - plot_ceteris_paribus_2d_explainer.R
split_ncol
tofacet_ncol
-
In many functions
N
andB
are beeing used. There is no consistency -
check
x
class and produce error in calculate_oscillations.R could also appear in
- aggregate_profiles.R
- cluster_profiles.R
- plot_aggregated_profiles_explainer.R
- plot_ceteris_paribus_2d_explainer.R
- plot_ceteris_paribus_explainer.R
- more
=
instead of<-
- https://github.com/ModelOriented/ingredients/blob/master/R/calculate_oscillations.R#L61
- https://github.com/ModelOriented/ingredients/blob/master/R/ceteris_paribus_2d.R#L88
- https://github.com/ModelOriented/ingredients/blob/master/R/cluster_profiles.R#L138
- https://github.com/ModelOriented/ingredients/blob/master/R/aspect_importance.R#L171
- https://github.com/ModelOriented/ingredients/blob/master/R/ceteris_paribus.R#L167
- https://github.com/ModelOriented/ingredients/blob/master/R/describe_aggregatedprofiles.R#L74
- https://github.com/ModelOriented/ingredients/blob/master/R/describe_ceterisparibus.R#L102
- https://github.com/ModelOriented/ingredients/blob/master/R/describe_featureimportance.R#L56
- https://github.com/ModelOriented/ingredients/blob/master/R/describe_ceterisparibus.R#L312
- https://github.com/ModelOriented/ingredients/blob/master/R/describe_ceterisparibus.R#L338 (all
sufix =
)
- CODE NOTES
ifelse
https://github.com/ModelOriented/ingredients/blob/master/R/describe_aggregatedprofiles.R#L267->
https://github.com/ModelOriented/ingredients/blob/master/R/calculate_oscillations.R#L53- could use some comments https://github.com/ModelOriented/ingredients/blob/master/R/ceteris_paribus_2d.R
- could use some comments https://github.com/ModelOriented/ingredients/blob/master/R/describe_ceterisparibus.R#L307
- could use some comments https://github.com/ModelOriented/ingredients/blob/master/R/describe_ceterisparibus.R#L321
- this is prone to ERROR - needs to be changed https://github.com/ModelOriented/ingredients/blob/master/R/conditional_dependency.R#L84
and https://github.com/ModelOriented/ingredients/blob/master/R/conditional_dependency.R#L85 - take care of class logical (?) https://github.com/ModelOriented/ingredients/blob/master/R/describe_aggregatedprofiles.R#L56
https://github.com/ModelOriented/ingredients/blob/master/R/describe_ceterisparibus.R#L82 - add
predict
as default https://github.com/ModelOriented/ingredients/blob/master/R/feature_importance.R#L162 - this could be default parameter value in function call https://github.com/ModelOriented/ingredients/blob/master/R/plotD3_aggregated_profiles_explainer.R#L150 the same in other plotD3
-
calculate_variable_profile.R has no support for
DALEX explainer use
+ sad documentation -
ceteris_paribus_2d.R all parameters are inconsistent with the rest of ingredients
-
describe.R could be deleted?
-
Change file name:
-
describe_aggregatedprofiles.R
-
describe_ceterisparibus.R
-
describe_featureimportance.R
-
plotD3_aggregated_profiles_explainer.R
-
plotD3_ceteris_paribus_explainer.R
-
plotD3_feature_importance_explainer.R
-
plot_aggregated_profiles_explainer.R
-
and more..... (cut
_explainer
everywhere) -
cut
s
: print_ceteris_paribus_descriptions.R
- weird/no parameter documentation
- describe_aggregatedprofiles.R
- describe_ceterisparibus.R
- describe_featureimportance.R
https://github.com/ModelOriented/ingredients/blob/master/R/select_samples.R#L11
-
ingredients has theme_drwhy.R
-
add
@noRd
to not exported functions
from ingredients.
(Key functions)
readability: documentation (title, description, details)
feature_importance()
- Make descriptions consistent with https://pbiecek.github.io/PM_VEE/
possible change: "This function calculates permutation based feature importance." - Arguments:
x
should the description include model or just class explainer (Argument in favour of deleting the model option: functionfeature_importance
needs arguments that are additional and are on the low end of the list in order to work with model.)
typos,
'type' possible change "a string specifying which ... . Possible values are ... "
punctuation is not consistent it's either a comma or dot after argument class and before the description
- Make descriptions consistent with https://pbiecek.github.io/PM_VEE/
ceteris_paribus()
3. description: The first sentence should communicate what the function does. possible change: "This function calculates a one dimensional ceteris paribus profile for the selected variables."
4. Arguments order is not consistent, new_observation is needed for the function to work and should be second in order.
new_observation
should the observation contain the decision (y) variable?calculate_oscillations()
2 appliesceteris_paribus_2d()
description that could serve as an example for other functions, arguments 'variables' in not clear how to usepartial_dependency()
2 applies,conditional_dependency()
1,3`
readability: examples (relevant, complete, with comments)
feature_importance()
ifx
can be a model, then an example how to use the function with models should be addedceteris_paribus()
5. examples could be commented, more different arguments could be demonstrated on the same explainerceteris_paribus_2d()
6. example for using variables argument should be provided, it is not always workingpartial_dependency()
5 and 6 appliesconditional_dependency()
5,6aggregate_profiles()
warnings are generated, 6
reproducibility: tests (code coverage)
- describe_aggregated_profiles.R - test on inputs with continuous variable
- aggregated_profiles.R - test accumulated profiles on non null groups and non-numeric variables, test conditional_profiles for nonnumeric variables, those examples can be ploted too.
links to functions: \code
All functions need link to DALEX::explain in arguments
argument x linked to ceteris_paribus()
in aggregate_profiles()
, accumulated_dependency()
from ingredients.
Try to get rid of titanic package suggest
from ingredients.
add demo gif to ingredients and iBreakDown
from ingredients.
Related Issues (20)
- [plot CP] auto change the color parameter to '_label_' with multiple models (more than 1 unique label) HOT 2
- CP observation original value isn't always apparent in variable splits HOT 5
- Use drwhy colors in CP
- Use data y_hat mean centering in ale plot
- package ingredients goes to CRAN
- notes HOT 1
- CRAN NOTE
- Ceteris Paribus profiles for sparse.model.matrix HOT 1
- N = NULL in pdp/ale/cd returns error
- update CRAN version
- Add facet options to plots HOT 1
- Error in FI/PDP on model with one variable HOT 2
- Can't use `coord_flip()` with `plot.aggregated_profiles_explainer`
- Update GH actions HOT 1
- Effect sizes HOT 3
- `calculate_variable_profile` coerces `integer`s to `numeric`s HOT 5
- Order variables by factor levels for feature importance plot HOT 2
- https://github.com/ModelOriented/DALEX/issues/540 HOT 2
- NOTE in winbuilder
- Default color theme, make it consistent with in DALEX
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ingredients.