Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release: 1.0.0 #107

Merged
merged 8 commits into from
Jun 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: mlr3fselect
Title: Feature Selection for 'mlr3'
Version: 0.12.0.9000
Version: 1.0.0
Authors@R: c(
person("Marc", "Becker", , "marcbecker@posteo.de", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-8115-0400")),
Expand All @@ -27,7 +27,7 @@ Depends:
mlr3 (>= 0.12.0),
R (>= 3.1.0)
Imports:
bbotk (>= 0.8.0.9000),
bbotk (>= 1.0.0),
checkmate (>= 2.0.0),
data.table,
lgr,
Expand All @@ -42,8 +42,6 @@ Suggests:
mlr3pipelines,
rpart,
testthat (>= 3.0.0)
Remotes:
mlr-org/bbotk
Config/testthat/edition: 3
Config/testthat/parallel: true
Encoding: UTF-8
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# mlr3fselect (development version)
# mlr3fselect 1.0.0

* feat: Add ensemble feature selection function `ensemble_fselect()`.
* BREAKING CHANGE: The `FSelector` class is `FSelectorBatch` now.
Expand Down
2 changes: 1 addition & 1 deletion R/AutoFSelector.R
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ AutoFSelector = R6Class("AutoFSelector",
#' @param recursive (`integer(1)`)\cr
#' Depth of recursion for multiple nested objects.
#'
#' @return [Learner].
#' @return [mlr3::Learner].
base_learner = function(recursive = Inf) {
if (recursive == 0L) self$learner else self$learner$base_learner(recursive - 1L)
},
Expand Down
2 changes: 1 addition & 1 deletion R/CallbackBatchFSelect.R
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ CallbackBatchFSelect = R6Class("CallbackBatchFSelect",
#' This context can be used to customize the evaluation of a batch of feature sets.
#' Changes to the state of callback are lost after the evaluation of a batch and changes to the fselect instance or the fselector are not possible.
#' Persistent data should be written to the archive via `$aggregated_performance` (see [ContextBatchFSelect]).
#' The other stages access [ContextBatch].
#' The other stages access [bbotk::ContextBatch].
#' This context can be used to modify the fselect instance, archive, fselector and final result.
#' There are two different contexts because the evaluation can be parallelized i.e. multiple instances of [ContextBatchFSelect] exists on different workers at the same time.
#'
Expand Down
1 change: 0 additions & 1 deletion R/bibentries.R
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@ bibentries = c(

das1999 = bibentry("article",
author = "Das, I",
doi = "10.1007/BF01195985/METRICS",
issn = "09344373",
journal = "Structural Optimization",
month = "may",
Expand Down
2 changes: 1 addition & 1 deletion R/ensemble_fselect.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#' @param init_resampling ([mlr3::Resampling])\cr
#' The initial resampling strategy of the data, from which each train set
#' will be passed on to the learners.
#' Can only be [mlr_resamplings_subsampling] or [mlr_resamplings_bootstrap].
#' Can only be [mlr3::ResamplingSubsampling] or [mlr3::ResamplingBootstrap].
#' @param inner_resampling ([mlr3::Resampling])\cr
#' The inner resampling strategy used by the [FSelector].
#' @param store_benchmark_result (`logical(1)`)\cr
Expand Down
10 changes: 5 additions & 5 deletions R/fselect.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
#' The [ArchiveBatchFSelect] (`$archive`) stores all evaluated hyperparameter configurations and performance scores.
#'
#' @details
#' The [mlr3::Task], [mlr3::Learner], [mlr3::Resampling], [mlr3::Measure] and [Terminator] are used to construct a [FSelectInstanceBatchSingleCrit].
#' If multiple performance [Measures][Measure] are supplied, a [FSelectInstanceBatchMultiCrit] is created.
#' The parameter `term_evals` and `term_time` are shortcuts to create a [Terminator].
#' If both parameters are passed, a [TerminatorCombo] is constructed.
#' For other [Terminators][Terminator], pass one with `terminator`.
#' The [mlr3::Task], [mlr3::Learner], [mlr3::Resampling], [mlr3::Measure] and [bbotk::Terminator] are used to construct a [FSelectInstanceBatchSingleCrit].
#' If multiple performance [Measures][mlr3::Measure] are supplied, a [FSelectInstanceBatchMultiCrit] is created.
#' The parameter `term_evals` and `term_time` are shortcuts to create a [bbotk::Terminator].
#' If both parameters are passed, a [bbotk::TerminatorCombo] is constructed.
#' For other [Terminators][bbotk::Terminator], pass one with `terminator`.
#' If no termination criterion is needed, set `term_evals`, `term_time` and `terminator` to `NULL`.
#'
#' @inheritSection FSelectInstanceBatchSingleCrit Resources
Expand Down
4 changes: 2 additions & 2 deletions R/sugar.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
#'
#' * `fs()` for a [FSelector] from [mlr_fselectors].
#' * `fss()` for a list of a [FSelector] from [mlr_fselectors].
#' * `trm()` for a [Terminator] from [mlr_terminators].
#' * `trms()` for a list of [Terminators][Terminator] from [mlr_terminators].
#' * `trm()` for a [bbotk::Terminator] from [mlr_terminators].
#' * `trms()` for a list of [Terminators][bbotk::Terminator] from [mlr_terminators].
#'
#' @inheritParams mlr3::mlr_sugar
#' @return [R6::R6Class] object of the respective type, or a list of [R6::R6Class] objects for the plural versions.
Expand Down
2 changes: 1 addition & 1 deletion man-roxygen/param_terminator.R
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
#' @param terminator ([Terminator])\cr
#' @param terminator ([bbotk::Terminator])\cr
#' Stop criterion of the feature selection.
4 changes: 2 additions & 2 deletions man/AutoFSelector.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/FSelectInstanceBatchMultiCrit.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/FSelectInstanceBatchSingleCrit.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/auto_fselector.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/callback_batch_fselect.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ensemble_fs_result.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/ensemble_fselect.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/fs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions man/fselect.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/fselect_nested.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/fsi.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading