From 6e57ca0c429c2d8828d8f41ba16f58b0832e9288 Mon Sep 17 00:00:00 2001 From: be-marc <33069354+be-marc@users.noreply.github.com> Date: Wed, 18 Dec 2024 10:03:02 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20mlr-org/?= =?UTF-8?q?bbotk@39adac2c59457f3c172a5041c4858c8d594efbd7=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 2 +- LICENSE-text.html | 2 +- authors.html | 6 +- index.html | 2 +- news/index.html | 9 +- pkgdown.yml | 2 +- reference/Archive.html | 2 +- reference/ArchiveAsync.html | 2 +- reference/ArchiveAsyncFrozen.html | 327 +++++++++++ reference/ArchiveBatch.html | 2 +- reference/CallbackAsync.html | 2 +- reference/CallbackBatch.html | 2 +- reference/Codomain.html | 37 +- reference/ContextAsync.html | 2 +- reference/ContextBatch.html | 2 +- reference/Objective.html | 2 +- reference/ObjectiveRFun.html | 2 +- reference/ObjectiveRFunDt.html | 2 +- reference/ObjectiveRFunMany.html | 2 +- reference/OptimInstance.html | 2 +- reference/OptimInstanceAsync.html | 2 +- reference/OptimInstanceAsyncMultiCrit.html | 2 +- reference/OptimInstanceAsyncSingleCrit.html | 2 +- reference/OptimInstanceBatch.html | 2 +- reference/OptimInstanceBatchMultiCrit.html | 2 +- reference/OptimInstanceBatchSingleCrit.html | 2 +- reference/OptimInstanceMultiCrit.html | 2 +- reference/OptimInstanceSingleCrit.html | 2 +- reference/Optimizer.html | 2 +- reference/OptimizerAsync.html | 2 +- reference/OptimizerBatch.html | 2 +- reference/Progressor.html | 2 +- reference/Terminator.html | 2 +- reference/as_terminator.html | 2 +- reference/assign_result_default.html | 2 +- reference/bb_optimize.html | 2 +- reference/bbotk-package.html | 2 +- reference/bbotk.async_freeze_archive.html | 77 +++ reference/bbotk.backup.html | 2 +- reference/bbotk_assertions.html | 2 +- reference/bbotk_reflections.html | 2 +- reference/bbotk_worker_loop.html | 2 +- reference/branin.html | 2 +- reference/callback_async.html | 2 +- reference/callback_batch.html | 2 +- reference/index.html | 14 +- reference/is_dominated.html | 2 +- reference/mlr_optimizers.html | 2 +- .../mlr_optimizers_async_design_points.html | 2 +- .../mlr_optimizers_async_grid_search.html | 2 +- .../mlr_optimizers_async_random_search.html | 2 +- reference/mlr_optimizers_chain.html | 2 +- reference/mlr_optimizers_cmaes.html | 22 +- reference/mlr_optimizers_design_points.html | 6 +- reference/mlr_optimizers_focus_search.html | 202 +++---- reference/mlr_optimizers_gensa.html | 22 +- reference/mlr_optimizers_grid_search.html | 22 +- reference/mlr_optimizers_irace.html | 539 +++++++++++------- reference/mlr_optimizers_local_search.html | 214 +++---- reference/mlr_optimizers_nloptr.html | 29 +- reference/mlr_optimizers_random_search.html | 26 +- reference/mlr_terminators.html | 2 +- reference/mlr_terminators_clock_time.html | 2 +- reference/mlr_terminators_combo.html | 2 +- reference/mlr_terminators_evals.html | 2 +- reference/mlr_terminators_none.html | 2 +- reference/mlr_terminators_perf_reached.html | 2 +- reference/mlr_terminators_run_time.html | 2 +- reference/mlr_terminators_stagnation.html | 2 +- .../mlr_terminators_stagnation_batch.html | 2 +- ...lr_terminators_stagnation_hypervolume.html | 2 +- reference/nds_selection.html | 2 +- reference/oi.html | 2 +- reference/oi_async.html | 2 +- reference/opt.html | 2 +- reference/optimize_async_default.html | 2 +- reference/optimize_batch_default.html | 2 +- reference/reexports.html | 2 +- reference/search_start.html | 2 +- reference/shrink_ps.html | 2 +- reference/terminated_error.html | 2 +- reference/trafo_xs.html | 2 +- reference/transform_xdt_to_xss.html | 2 +- reference/trm.html | 2 +- search.json | 2 +- sitemap.xml | 2 + 86 files changed, 1114 insertions(+), 580 deletions(-) create mode 100644 reference/ArchiveAsyncFrozen.html create mode 100644 reference/bbotk.async_freeze_archive.html diff --git a/404.html b/404.html index 9839b664..d1d925e4 100644 --- a/404.html +++ b/404.html @@ -29,7 +29,7 @@ bbotk - 1.4.1 + 1.5.0 + + + + + +
+
+
+ +
+

Freezes the Redis data base of an ArchiveAsync to a data.table::data.table(). +No further points can be added to the archive but the data can be accessed and analyzed. +Useful when the Redis data base is not permanently available. +Use the callback bbotk.async_freeze_archive to freeze the archive after the optimization has finished.

+
+ + +
+

S3 Methods

+ + +
  • as.data.table(archive)
    ArchiveAsync -> data.table::data.table()
    +Returns a tabular view of all performed function calls of the Objective. +The x_domain column is unnested to separate columns.

  • +
+
+

Super classes

+

bbotk::Archive -> bbotk::ArchiveAsync -> ArchiveAsyncFrozen

+
+
+

Active bindings

+

data
+

(data.table::data.table)
+Data table with all finished points.

+ + +
queued_data
+

(data.table::data.table)
+Data table with all queued points.

+ + +
running_data
+

(data.table::data.table)
+Data table with all running points.

+ + +
finished_data
+

(data.table::data.table)
+Data table with all finished points.

+ + +
failed_data
+

(data.table::data.table)
+Data table with all failed points.

+ + +
n_queued
+

(integer(1))
+Number of queued points.

+ + +
n_running
+

(integer(1))
+Number of running points.

+ + +
n_finished
+

(integer(1))
+Number of finished points.

+ + +
n_failed
+

(integer(1))
+Number of failed points.

+ + +
n_evals
+

(integer(1))
+Number of evaluations stored in the archive.

+ + +

+
+
+

Methods

+ +

Inherited methods


+

Method new()

+

Creates a new instance of this R6 class.

+

Usage

+

ArchiveAsyncFrozen$new(archive)

+
+ +
+

Arguments

+

archive
+

(ArchiveAsync)
+The archive to freeze.

+ + +

+
+ +


+

Method push_points()

+

Push queued points to the archive.

+

Usage

+

ArchiveAsyncFrozen$push_points(xss)

+
+ +
+

Arguments

+

xss
+

(list of named list())
+List of named lists of point values.

+ + +

+
+ +


+

Method pop_point()

+

Pop a point from the queue.

+

Usage

+

ArchiveAsyncFrozen$pop_point()

+
+ + +


+

Method push_running_point()

+

Push running point to the archive.

+

Usage

+

ArchiveAsyncFrozen$push_running_point(xs, extra = NULL)

+
+ +
+

Arguments

+

xs
+

(named list)
+Named list of point values.

+ + +
extra
+

(list())
+Named list of additional information.

+ + +

+
+ +


+

Method push_result()

+

Push result to the archive.

+

Usage

+

ArchiveAsyncFrozen$push_result(key, ys, x_domain, extra = NULL)

+
+ +
+

Arguments

+

key
+

(character())
+Key of the point.

+ + +
ys
+

(list())
+Named list of results.

+ + +
x_domain
+

(list())
+Named list of transformed point values.

+ + +
extra
+

(list())
+Named list of additional information.

+ + +

+
+ +


+

Method push_failed_point()

+

Push failed point to the archive.

+

Usage

+

ArchiveAsyncFrozen$push_failed_point(key, message)

+
+ +
+

Arguments

+

key
+

(character())
+Key of the point.

+ + +
message
+

(character())
+Error message.

+ + +

+
+ +


+

Method data_with_state()

+

Fetch points with a specific state.

+

Usage

+

ArchiveAsyncFrozen$data_with_state(
+  fields = c("xs", "ys", "xs_extra", "worker_extra", "ys_extra", "condition"),
+  states = c("queued", "running", "finished", "failed"),
+  reset_cache = FALSE
+)

+
+ +
+

Arguments

+

fields
+

(character())
+Fields to fetch. +Defaults to c("xs", "ys", "xs_extra", "worker_extra", "ys_extra").

+ + +
states
+

(character())
+States of the tasks to be fetched. +Defaults to c("queued", "running", "finished", "failed").

+ + +
reset_cache
+

(logical(1))
+Whether to reset the cache of the finished points.

+ + +

+
+ +


+

Method clear()

+

Clear all evaluation results from archive.

+

Usage

+

ArchiveAsyncFrozen$clear()

+
+ + +
+ +
+ +
+ + +
+ + + + + + + diff --git a/reference/ArchiveBatch.html b/reference/ArchiveBatch.html index e19e9c8e..27d40fd5 100644 --- a/reference/ArchiveBatch.html +++ b/reference/ArchiveBatch.html @@ -7,7 +7,7 @@ bbotk - 1.4.1 + 1.5.0 + + + + + +
+
+
+ +
+

This CallbackAsync freezes the ArchiveAsync to ArchiveAsyncFrozen after the optimization has finished.

+
+ + + +
+

Examples

+
clbk("bbotk.async_freeze_archive")
+#> <CallbackAsync:bbotk.async_freeze_archive>: Archive Freeze Callback
+#> * Active Stages: on_optimization_end
+
+
+
+ + +
+ + + + + + + diff --git a/reference/bbotk.backup.html b/reference/bbotk.backup.html index c4330fd6..e5e35810 100644 --- a/reference/bbotk.backup.html +++ b/reference/bbotk.backup.html @@ -7,7 +7,7 @@ bbotk - 1.4.1 + 1.5.0