AutoMLJob: AutoMLJob class

In DyfanJones/sagemaker-r-mlframework: sagemaker machine learning developed by amazon

AutoMLJob class

Description

A class for interacting with CreateAutoMLJob API.

Super class

sagemaker.common::.Job -> AutoMLJob

Methods

Public methods

• AutoMLJob$new()

• AutoMLJob$start_new()

• AutoMLJob$describe()

• AutoMLJob$wait()

• AutoMLJob$format()

• AutoMLJob$clone()

Inherited methods

• sagemaker.common::.Job$stop()

---

Method new()

Initialize AutoMLJob class

Usage

AutoMLJob$new(sagemaker_session, job_name = NULL, inputs = NULL)

Arguments

sagemaker_session

(sagemaker.session.Session): A SageMaker Session object, used for SageMaker interactions (default: None). If not specified, the one originally associated with the “AutoMLJob“ instance is used.

job_name

:

inputs

(str, list[str]): Parameters used when called :meth:'~sagemaker.automl.AutoML.fit'.

---

Method start_new()

Create a new Amazon SageMaker AutoML job from auto_ml.

Usage

AutoMLJob$start_new(auto_ml, inputs)

Arguments

auto_ml

(sagemaker.automl.AutoML): AutoML object created by the user.

inputs

(str, list[str]): Parameters used when called :meth:'~sagemaker.automl.AutoML.fit'.

Returns

sagemaker.automl.AutoMLJob: Constructed object that captures all information about the started AutoML job.

---

Method describe()

Prints out a response from the DescribeAutoMLJob API call.

Usage

AutoMLJob$describe()

---

Method wait()

Wait for the AutoML job to finish.

Usage

AutoMLJob$wait(logs = TRUE)

Arguments

logs

(bool): indicate whether to output logs.

---

Method format()

format class

Usage

AutoMLJob$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AutoMLJob$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-mlframework documentation built on March 18, 2022, 7:41 a.m.