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