}}
\describe{
-\item{\code{label}}{(\code{character(1)})\cr
-Label for this object.
-Can be used in tables, plot and text output instead of the ID.}
-
-\item{\code{param_set}}{(\link[paradox:ParamSet]{paradox::ParamSet})\cr
-Set of hyperparameters.}
-
\item{\code{instance}}{(any)\cr
During \code{instantiate()}, the instance is stored in this slot in an arbitrary format.
Note that if a grouping variable is present in the \link{Task}, a \link{Resampling} may operate on the
@@ -171,27 +167,14 @@ The number of observations of the \link{Task} which was passed to \code{r$instan
If \code{TRUE}, duplicated rows can occur within a single training set or within a single test set.
E.g., this is \code{TRUE} for Bootstrap, and \code{FALSE} for cross-validation.
Only used internally.}
-
-\item{\code{man}}{(\code{character(1)})\cr
-String in the format \verb{[pkg]::[topic]} pointing to a manual page for this object.
-Defaults to \code{NA}, but can be set by child classes.}
}
\if{html}{\out{
}}
}
\section{Active bindings}{
\if{html}{\out{}}
\describe{
-\item{\code{id}}{(\code{character(1)})\cr
-Identifier of the object.
-Used in tables, plot and text output.}
-
\item{\code{is_instantiated}}{(\code{logical(1)})\cr
Is \code{TRUE} if the resampling has been instantiated.}
-
-\item{\code{hash}}{(\code{character(1)})\cr
-Hash (unique identifier) for this object.
-If the object has not been instantiated yet, \code{NA_character_} is returned.
-The hash is calculated based on the class name, the id, the parameter set, and the instance.}
}
\if{html}{\out{
}}
}
@@ -199,28 +182,31 @@ The hash is calculated based on the class name, the id, the parameter set, and t
\subsection{Public methods}{
\itemize{
\item \href{#method-Resampling-new}{\code{Resampling$new()}}
-\item \href{#method-Resampling-format}{\code{Resampling$format()}}
\item \href{#method-Resampling-print}{\code{Resampling$print()}}
-\item \href{#method-Resampling-help}{\code{Resampling$help()}}
\item \href{#method-Resampling-instantiate}{\code{Resampling$instantiate()}}
\item \href{#method-Resampling-train_set}{\code{Resampling$train_set()}}
\item \href{#method-Resampling-test_set}{\code{Resampling$test_set()}}
\item \href{#method-Resampling-clone}{\code{Resampling$clone()}}
}
}
+\if{html}{\out{
+}}\preformatted{Resampling$new(
- id,
- param_set = ps(),
- duplicated_ids = FALSE,
- label = NA_character_,
- man = NA_character_
-)}\if{html}{\out{
}}
+\if{html}{\out{}}\preformatted{Resampling$new(id, param_set = ps(), duplicated_ids = FALSE, label, man)}\if{html}{\out{
}}
}
\subsection{Arguments}{
@@ -248,23 +234,6 @@ The referenced help package can be opened via method \verb{$help()}.}
}
}
\if{html}{\out{}}
\describe{
-\item{\code{label}}{(\code{character(1)})\cr
-Label for this object.
-Can be used in tables, plot and text output instead of the ID.}
-
\item{\code{task_type}}{(\code{character(1)})\cr
Task type, e.g. \code{"classif"} or \code{"regr"}.
@@ -261,10 +260,6 @@ need to be reordered after querying the data from the \link{DataBackend}.
Note that all columns of the \link{DataBackend}, also columns which are not selected or have any role, are listed
in this table.}
-\item{\code{man}}{(\code{character(1)})\cr
-String in the format \verb{[pkg]::[topic]} pointing to a manual page for this object.
-Defaults to \code{NA}, but can be set by child classes.}
-
\item{\code{extra_args}}{(named \code{list()})\cr
Additional arguments set during construction.
Required for \code{\link[=convert_task]{convert_task()}}.}
@@ -277,10 +272,6 @@ Package version of \code{mlr3} used to create the task.}
\section{Active bindings}{
\if{html}{\out{
}}
\describe{
-\item{\code{id}}{(\code{character(1)})\cr
-Identifier of the object.
-Used in tables, plot and text output.}
-
\item{\code{internal_valid_task}}{(\code{Task} or \code{integer()} or \code{NULL})\cr
Optional validation task that can, e.g., be used for early stopping with learners such as XGBoost.
See also the \verb{$validate} field of \code{\link{Learner}}.
@@ -288,11 +279,6 @@ If integers are assigned they are removed from the primary task and an internal
with those ids is created from the primary task using only those ids.
When assigning a new task, it is always cloned.}
-\item{\code{hash}}{(\code{character(1)})\cr
-Hash (unique identifier) for this object.
-The hash is calculated based on the complete task object and \verb{$row_ids}.
-If an internal validation task is set, the hash is recalculated.}
-
\item{\code{row_hash}}{(\code{character(1)})\cr
Hash (unique identifier) calculated based on the row ids.}
@@ -482,8 +468,6 @@ This is different from \verb{$row_ids} which only returns rows with role "use".}
\itemize{
\item \href{#method-Task-new}{\code{Task$new()}}
\item \href{#method-Task-divide}{\code{Task$divide()}}
-\item \href{#method-Task-help}{\code{Task$help()}}
-\item \href{#method-Task-format}{\code{Task$format()}}
\item \href{#method-Task-print}{\code{Task$print()}}
\item \href{#method-Task-data}{\code{Task$data()}}
\item \href{#method-Task-formula}{\code{Task$formula()}}
@@ -504,6 +488,17 @@ This is different from \verb{$row_ids} which only returns rows with role "use".}
\item \href{#method-Task-clone}{\code{Task$clone()}}
}
}
+\if{html}{\out{
+
Inherited methods
+
+
+}}
\if{html}{\out{
}}
\if{html}{\out{
}}
\if{latex}{\out{\hypertarget{method-Task-new}{}}}
@@ -512,7 +507,7 @@ Creates a new instance of this \link[R6:R6Class]{R6} class.
Note that this object is typically constructed via a derived classes, e.g. \link{TaskClassif} or \link{TaskRegr}.
\subsection{Usage}{
-\if{html}{\out{
}}\preformatted{Task$new(id, task_type, backend, label = NA_character_, extra_args = list())}\if{html}{\out{
}}
+\if{html}{\out{
}}\preformatted{Task$new(id, task_type, backend, extra_args = list(), label, man)}\if{html}{\out{
}}
}
\subsection{Arguments}{
@@ -529,12 +524,12 @@ Must be an element of \link[=mlr_reflections]{mlr_reflections$task_types$type}.}
Either a \link{DataBackend}, or any object which is convertible to a \link{DataBackend} with \code{as_data_backend()}.
E.g., a \code{data.frame()} will be converted to a \link{DataBackendDataTable}.}
-\item{\code{label}}{(\code{character(1)})\cr
-Label for the new instance.}
-
\item{\code{extra_args}}{(named \code{list()})\cr
Named list of constructor arguments, required for converting task types
via \code{\link[=convert_task]{convert_task()}}.}
+
+\item{\code{label}}{(\code{character(1)})\cr
+Label for the new instance.}
}
\if{html}{\out{
}}
}
@@ -568,33 +563,6 @@ Modified \code{Self}.
}
}
\if{html}{\out{
}}
-\if{html}{\out{
}}
-\if{latex}{\out{\hypertarget{method-Task-help}{}}}
-\subsection{Method \code{help()}}{
-Opens the corresponding help page referenced by field \verb{$man}.
-\subsection{Usage}{
-\if{html}{\out{
}}\preformatted{Task$help()}\if{html}{\out{
}}
-}
-
-}
-\if{html}{\out{
}}
-\if{html}{\out{
}}
-\if{latex}{\out{\hypertarget{method-Task-format}{}}}
-\subsection{Method \code{format()}}{
-Helper for print outputs.
-\subsection{Usage}{
-\if{html}{\out{
}}\preformatted{Task$format(...)}\if{html}{\out{
}}
-}
-
-\subsection{Arguments}{
-\if{html}{\out{
}}
-\describe{
-\item{\code{...}}{(ignored).}
-}
-\if{html}{\out{
}}
-}
-}
-\if{html}{\out{
}}
\if{html}{\out{
}}
\if{latex}{\out{\hypertarget{method-Task-print}{}}}
\subsection{Method \code{print()}}{
diff --git a/man/TaskClassif.Rd b/man/TaskClassif.Rd
index 4aba71d86..d9f576867 100644
--- a/man/TaskClassif.Rd
+++ b/man/TaskClassif.Rd
@@ -65,7 +65,7 @@ Other Task:
}
\concept{Task}
\section{Super classes}{
-\code{\link[mlr3:Task]{mlr3::Task}} -> \code{\link[mlr3:TaskSupervised]{mlr3::TaskSupervised}} -> \code{TaskClassif}
+\code{\link[mlr3misc:Mlr3Component]{mlr3misc::Mlr3Component}} -> \code{\link[mlr3:Task]{mlr3::Task}} -> \code{\link[mlr3:TaskSupervised]{mlr3::TaskSupervised}} -> \code{TaskClassif}
}
\section{Active bindings}{
\if{html}{\out{
}}
@@ -94,15 +94,18 @@ Stores the negative class for binary classification tasks, and \code{NA} for mul
\if{html}{\out{
Inherited methods
}}
}
diff --git a/man/TaskGenerator.Rd b/man/TaskGenerator.Rd
index 854b8d7eb..f898b0180 100644
--- a/man/TaskGenerator.Rd
+++ b/man/TaskGenerator.Rd
@@ -33,33 +33,17 @@ Other TaskGenerator:
\code{\link{mlr_task_generators_xor}}
}
\concept{TaskGenerator}
+\section{Super class}{
+\code{\link[mlr3misc:Mlr3Component]{mlr3misc::Mlr3Component}} -> \code{TaskGenerator}
+}
\section{Public fields}{
\if{html}{\out{
}}
\describe{
-\item{\code{id}}{(\code{character(1)})\cr
-Identifier of the object.
-Used in tables, plot and text output.}
-
-\item{\code{label}}{(\code{character(1)})\cr
-Label for this object.
-Can be used in tables, plot and text output instead of the ID.}
-
\item{\code{task_type}}{(\code{character(1)})\cr
Task type, e.g. \code{"classif"} or \code{"regr"}.
For a complete list of possible task types (depending on the loaded packages),
see \code{\link[=mlr_reflections]{mlr_reflections$task_types$type}}.}
-
-\item{\code{param_set}}{(\link[paradox:ParamSet]{paradox::ParamSet})\cr
-Set of hyperparameters.}
-
-\item{\code{packages}}{(\code{character(1)})\cr
-Set of required packages.
-These packages are loaded, but not attached.}
-
-\item{\code{man}}{(\code{character(1)})\cr
-String in the format \verb{[pkg]::[topic]} pointing to a manual page for this object.
-Defaults to \code{NA}, but can be set by child classes.}
}
\if{html}{\out{
}}
}
@@ -67,12 +51,22 @@ Defaults to \code{NA}, but can be set by child classes.}
\subsection{Public methods}{
\itemize{
\item \href{#method-TaskGenerator-new}{\code{TaskGenerator$new()}}
-\item \href{#method-TaskGenerator-format}{\code{TaskGenerator$format()}}
\item \href{#method-TaskGenerator-print}{\code{TaskGenerator$print()}}
\item \href{#method-TaskGenerator-generate}{\code{TaskGenerator$generate()}}
\item \href{#method-TaskGenerator-clone}{\code{TaskGenerator$clone()}}
}
}
+\if{html}{\out{
+
Inherited methods
+
+
+}}
\if{html}{\out{
}}
\if{html}{\out{
}}
\if{latex}{\out{\hypertarget{method-TaskGenerator-new}{}}}
@@ -82,10 +76,10 @@ Creates a new instance of this \link[R6:R6Class]{R6} class.
\if{html}{\out{
}}\preformatted{TaskGenerator$new(
id,
task_type,
- packages = character(),
+ packages = character(0),
param_set = ps(),
- label = NA_character_,
- man = NA_character_
+ label,
+ man
)}\if{html}{\out{
}}
}
@@ -118,23 +112,6 @@ The referenced help package can be opened via method \verb{$help()}.}
}
}
\if{html}{\out{
}}
-\if{html}{\out{
}}
-\if{latex}{\out{\hypertarget{method-TaskGenerator-format}{}}}
-\subsection{Method \code{format()}}{
-Helper for print outputs.
-\subsection{Usage}{
-\if{html}{\out{
}}\preformatted{TaskGenerator$format(...)}\if{html}{\out{
}}
-}
-
-\subsection{Arguments}{
-\if{html}{\out{
}}
-\describe{
-\item{\code{...}}{(ignored).}
-}
-\if{html}{\out{
}}
-}
-}
-\if{html}{\out{
}}
\if{html}{\out{
}}
\if{latex}{\out{\hypertarget{method-TaskGenerator-print}{}}}
\subsection{Method \code{print()}}{
diff --git a/man/TaskRegr.Rd b/man/TaskRegr.Rd
index 8c38eb6ef..3a49f6f14 100644
--- a/man/TaskRegr.Rd
+++ b/man/TaskRegr.Rd
@@ -55,7 +55,7 @@ Other Task:
}
\concept{Task}
\section{Super classes}{
-\code{\link[mlr3:Task]{mlr3::Task}} -> \code{\link[mlr3:TaskSupervised]{mlr3::TaskSupervised}} -> \code{TaskRegr}
+\code{\link[mlr3misc:Mlr3Component]{mlr3misc::Mlr3Component}} -> \code{\link[mlr3:Task]{mlr3::Task}} -> \code{\link[mlr3:TaskSupervised]{mlr3::TaskSupervised}} -> \code{TaskRegr}
}
\section{Methods}{
\subsection{Public methods}{
@@ -68,16 +68,19 @@ Other Task:
\if{html}{\out{
Inherited methods
+mlr3misc::Mlr3Component$configure()mlr3misc::Mlr3Component$format()mlr3misc::Mlr3Component$help()mlr3misc::Mlr3Component$override_info()mlr3misc::Mlr3Component$require_namespaces()mlr3::Task$add_strata()mlr3::Task$cbind()mlr3::Task$data()mlr3::Task$divide()mlr3::Task$droplevels()mlr3::Task$filter()mlr3::Task$format()mlr3::Task$formula()mlr3::Task$head()mlr3::Task$help()mlr3::Task$levels()mlr3::Task$materialize_view()mlr3::Task$missings()}}\preformatted{TaskRegr$new(id, backend, target, label = NA_character_, extra_args = list())}\if{html}{\out{
}}
+\if{html}{\out{}}\preformatted{TaskRegr$new(id, backend, target, label, man, extra_args = list())}\if{html}{\out{
}}
}
\subsection{Arguments}{
diff --git a/man/TaskSupervised.Rd b/man/TaskSupervised.Rd
index 27bcdec90..15e3f50dd 100644
--- a/man/TaskSupervised.Rd
+++ b/man/TaskSupervised.Rd
@@ -50,8 +50,8 @@ Other Task:
}
\concept{Task}
\keyword{internal}
-\section{Super class}{
-\code{\link[mlr3:Task]{mlr3::Task}} -> \code{TaskSupervised}
+\section{Super classes}{
+\code{\link[mlr3misc:Mlr3Component]{mlr3misc::Mlr3Component}} -> \code{\link[mlr3:Task]{mlr3::Task}} -> \code{TaskSupervised}
}
\section{Methods}{
\subsection{Public methods}{
@@ -64,16 +64,19 @@ Other Task:
\if{html}{\out{
Inherited methods