oml_object: Abstract Base Class for OpenML objects.

In mlr-org/mlr3oml: Connector Between 'mlr3' and 'OpenML'

Abstract Base Class for OpenML objects.

Description

All OML Objects inherit from this class. Don't use his class directly.

Active bindings

desc

(list())
Description of OpenML object.

cache_dir

(logical(1) | character(1))
Stores the location of the cache for objects retrieved from OpenML. If set to FALSE, caching is disabled. Objects from the test server are stored in the subdirectory 'test', those from the public server are stored in the subdirectory 'public'.

The package qs is required for caching.

id

(integer(1))
OpenML data id.

server

(character(1))
The server for this object.

man

(character(1))
The manual entry.

name

(character(1))
The name of the object.

type

(character())
The type of OpenML object (e.g. task, run, ...).

test_server

(logical(1))
Whether the object is using the test server.

Methods

Public methods

• OMLObject$new()

• OMLObject$help()

• OMLObject$clone()

---

Method new()

Creates a new instance of this R6 class.

Usage

OMLObject$new(id, test_server = test_server_default(), type)

Arguments

id

(integer(1))
OpenML id for the object.

test_server

(character(1))
Whether to use the OpenML test server or public server. Defaults to value of option "mlr3oml.test_server", or FALSE if not set.

type

(charcater())
The type of OpenML object (e.g. run, task, ...).

---

Method help()

Opens the corresponding help page referenced by field ⁠$man⁠.

Usage

OMLObject$help()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

OMLObject$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

mlr-org/mlr3oml documentation built on Aug. 12, 2024, 7:32 p.m.