DALEXverse 0.19.8 release summer 2019
pbiecek opened this issue · 3 comments
pbiecek commented
DALEXverse 0.19.8 release summer 2019
Integration
- readability: vignettes
- readability: NEWS
- readability: DESCRIPTION
- consistency: pkgdown website
- consistency: entry at DrWhy.AI webpage
assigned: @pbiecek
Code review
- consistency: names of functions
- consistency: names of files
- consistency: names of variables in functions (local and global)
- length: functions
- readability: code (comments, constructions)
assigned: @hbaniecki
Feature review
- readability: documentation (title, description, details)
- readability: examples (relevant, complete, with comments)
- reproducibility: tests (code coverage)
- links to functions: \code
assigned: @WojciechKretowicz
WojciechKretowicz commented
- in your vignette there is a pictures that are not loaded, using mozilla, ubuntu
- sentence There is no big difference bewtween Python versions when downloading conda therefore it is recommended to choose Python 3.7 (newer Anaconda version) and then downloading python 2.7. is completely ununderstandable for me
- in my opinion you could more describe the paragraph Packages useful with explanations, what are these packages, if they are necessary
- spelling in loading data paragraph proviede -> provide, targer -> target
- there is colloquialism in loading data, scikit-learn models do not like it
- the description of the
explain_scikitlearn
arguments in the main vignette could be moved to the top of the paragraph in my opinion - i think good idea is to put a link to dalex, at the beginning and in Creating explanations paragraph
- 2 spellings in first sentence of Create your conda virtual env with DALEX
- example in Create your conda virtual env with DALEX is very confusing for me
- whole description of the
create_env
could be more accurate in my opinion - spelling in Create explainer from your h2o model in
data
andprecalculate
parameters description - in Wrapper for Python Keras Models easy -> *easily
- in Wrapper for Python Keras Models's Conda cannot find specified packages at channels you have provided. there is Of of
- in explain scikit learn there is no machine code
hbaniecki commented
- file names
other.R
tohelper_functions.R
or anything else http://r-pkgs.had.co.nz/style.htmlonLoad.R
toon_attach.R
- too many blank code lines in many files, great example:
- https://github.com/ModelOriented/DALEXtra/blob/master/R/other.R#L63
- https://github.com/ModelOriented/DALEXtra/blob/master/R/yhat.R#L76
- add comments
- write
} else {
-
explain_h2o
has other permutation of parameters thanexplain
https://github.com/ModelOriented/DALEXtra/blob/master/R/explain_h2o.R
same : https://github.com/ModelOriented/DALEXtra/blob/master/R/explain_mljar.R -
other permutation of parameters in doc and function
- other
- lacking documentation https://github.com/ModelOriented/DALEXtra/blob/master/R/print.scikitlearn_set.R
- format of this function is sad, function name same as variable (?) https://github.com/ModelOriented/DALEXtra/blob/master/R/other.R#L85
function_name <- function(x)
looks better in the same line and is consistent
https://github.com/ModelOriented/DALEXtra/blob/master/R/explain_mljar.R#L47
hbaniecki commented