SearchGrid: SearchGrid Class

In five-dots/ml4e: Machine Learning for Everyone

Description

A class defines a grid search task specification.

Usage

new_search_grid(options = NULL, keys = NULL)

Arguments

options	A Options class object.
keys	A named character vector of keys.

Value

A new SearchGrid class object

Super classes

ml4e::Task -> ml4e::SearchBase -> SearchGrid

Active bindings

progress

A list of grid calculation progress.

progress_str

A character of progress.

done

A logical if finished

Methods

Public methods

• SearchGrid$new()

• SearchGrid$print()

• SearchGrid$do()

• SearchGrid$get_count_by_param()

• SearchGrid$clone()

Inherited methods

• ml4e::Task$eval_call_args()

• ml4e::Task$print_task()

• ml4e::SearchBase$get_best_param()

• ml4e::SearchBase$get_rank()

---

Method new()

Construct a new SearchGrid class object.

Usage

SearchGrid$new(options = NULL, keys = NULL)

Arguments

options

A Options class object.

keys

A named character vector of keys.

Returns

A new SearchGrid class object

---

Method print()

Print object.

Usage

SearchGrid$print()

---

Method do()

Run a grid search. The result will be stored in self$result.

Usage

SearchGrid$do(num = NULL)

Arguments

num

A integer scalar of how many parameters to be calculated. If NULL, all parameters in param set will be calculated.

---

Method get_count_by_param()

Get paramter's counts.

Usage

SearchGrid$get_count_by_param()

Returns

A data.frame of parameter count.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SearchGrid$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

five-dots/ml4e documentation built on June 19, 2020, 4:26 p.m.