Make updates to reflect code reorganisation around addition of MLJTransforms.jl #1177
Conversation
docs/src/list_of_supported_models.md
Outdated
| [MLJModels.jl](https://github.com/JuliaAI/MLJModels.jl) (built-in) | - | ConstantClassifier, ConstantRegressor, ContinuousEncoder, DeterministicConstantClassifier, DeterministicConstantRegressor, FillImputer, InteractionTransformer, OneHotEncoder, Standardizer, UnivariateBoxCoxTransformer, UnivariateDiscretizer, UnivariateFillImputer, UnivariateTimeTypeToContinuous, Standardizer, BinaryThreshholdPredictor | medium | | ||
| [MLJModels.jl](https://github.com/JuliaAI/MLJModels.jl) (built-in) | - | ConstantClassifier, ConstantRegressor, DeterministicConstantClassifier, DeterministicConstantRegressor, BinaryThreshholdPredictor | mature | | ||
| [MLJText.jl](https://github.com/JuliaAI/MLJText.jl) | - | TfidfTransformer, BM25Transformer, CountTransformer | low | | ||
| [MLJTransforms.jl](https://github.com/JuliaAI/MLJTransforms.jl) (built-in) | - | ContinuousEncoder, FillImputer, InteractionTransformer, OneHotEncoder, Standardizer, UnivariateBoxCoxTransformer, UnivariateDiscretizer, UnivariateFillImputer, UnivariateTimeTypeToContinuous, Standardizer, OrdinalEncoder, FrequencyEncoder, TargetEncoder, ContrastEncoder, CardinalityReducer, MissingnessEncoder | medium | |
There was a problem hiding this comment.
| [MLJTransforms.jl](https://github.com/JuliaAI/MLJTransforms.jl) (built-in) | - | ContinuousEncoder, FillImputer, InteractionTransformer, OneHotEncoder, Standardizer, UnivariateBoxCoxTransformer, UnivariateDiscretizer, UnivariateFillImputer, UnivariateTimeTypeToContinuous, Standardizer, OrdinalEncoder, FrequencyEncoder, TargetEncoder, ContrastEncoder, CardinalityReducer, MissingnessEncoder | medium | | |
| [MLJTransforms.jl](https://github.com/JuliaAI/MLJTransforms.jl) (built-in) | - | ContinuousEncoder, FillImputer, InteractionTransformer, OneHotEncoder, Standardizer, UnivariateBoxCoxTransformer, UnivariateDiscretizer, UnivariateFillImputer, UnivariateTimeTypeToContinuous, UnivariateStandardizer, OrdinalEncoder, FrequencyEncoder, TargetEncoder, ContrastEncoder, CardinalityReducer, MissingnessEncoder | medium | |
There was a problem hiding this comment.
The omission is intentional. UnvariateStandardizer is effectively deprecated, as you can use Standardizer for univariate input as well. We cannot remove the model for now, as Standardizer uses it.
There was a problem hiding this comment.
Okay but there is another Standardizer entry so just remove UnivariateStandardizer.
There was a problem hiding this comment.
| [MLJTransforms.jl](https://github.com/JuliaAI/MLJTransforms.jl) (built-in) | - | ContinuousEncoder, FillImputer, InteractionTransformer, OneHotEncoder, Standardizer, UnivariateBoxCoxTransformer, UnivariateDiscretizer, UnivariateFillImputer, UnivariateTimeTypeToContinuous, Standardizer, OrdinalEncoder, FrequencyEncoder, TargetEncoder, ContrastEncoder, CardinalityReducer, MissingnessEncoder | medium | | |
| [MLJTransforms.jl](https://github.com/JuliaAI/MLJTransforms.jl) (built-in) | - | ContinuousEncoder, FillImputer, InteractionTransformer, OneHotEncoder, Standardizer, UnivariateBoxCoxTransformer, UnivariateDiscretizer, UnivariateFillImputer, UnivariateTimeTypeToContinuous, OrdinalEncoder, FrequencyEncoder, TargetEncoder, ContrastEncoder, CardinalityReducer, MissingnessEncoder | medium | |
There was a problem hiding this comment.
Oh, right. There's a duplicate. Removed.
|
I think that's all thank you so much. |
| UnivariateBoxCoxTransformer_MLJTransforms = ["encoders"] | ||
| UnivariateDiscretizer_MLJTransforms = ["encoders"] | ||
| UnivariateFillImputer_MLJTransforms = ["missing_value_imputation"] | ||
| UnivariateStandardizer_MLJTransforms = ["encoders"] |
There was a problem hiding this comment.
If UnivariateStandardizer is deprecated then do we still need it here?
There was a problem hiding this comment.
Because while it is deprecated, it will still appear when the doc generating tools scrape the package code. I don't want to have to special case it. The docstring states explicitly that you can just use Standardizer. I don't see any harm.
There was a problem hiding this comment.
Okay I was just pointing out in case you missed it. Thank you for clarifying.
docs/ModelDescriptors.toml
Outdated
| ConstantClassifier_MLJModels = ["classification"] | ||
| ConstantRegressor_MLJModels = ["regression"] | ||
| ContinuousEncoder_MLJTransforms = ["encoders"] | ||
| ContrastEncoder_MLJTransforms = ["encoders"] |
There was a problem hiding this comment.
I think it exists and includes many models inside? Or I could be misunderstanding.
There was a problem hiding this comment.
Oops. I removed the wrong one.
Fixed just now.
|
@EssamWisam If you are happy now, please formally approve the PR. |
Context: JuliaAI/MLJModels.jl#591
For the release notes:
@loadto load them):OrdinalEncoder,FrequencyEncoder,TargetEncoder,ContrastEncoder,CardinalityReducer,MissingnessEncoder.ContinuousEncoder,FillImputer,InteractionTransformer,OneHotEncoder,Standardizer,UnivariateBoxCoxTransformer,UnivariateDiscretizer,UnivariateFillImputer,UnivariateTimeTypeToContinuous,Standardizer.Guide for possible source of breakage: While it was never necessary to use
@loadto load one of the models in the last list (assuming you have first runusing MLJ) this is frequently not realised by users, and one sees things like@load OneHotEncoder pkg=MLJModels, which this release will break. If such a call is preceded byusing MLJorusing MLJTransformsyou can remove the loading command altogether (OneHotEncoder()already works), and in any case you can instead use@load OneHotEncoder pkg=MLJTransforms.This PR includes some documentation cleanup and closes #1162 and #1173.
Waiting on: