dot-Job: .Job Class

In DyfanJones/sagemaker-r-common: R6sagemaker lower level api calls

.Job Class

Description

Handle creating, starting and waiting for Amazon SageMaker jobs to finish.

Public fields

sagemaker_session

Sagemaker Session Class

job_name

name of job

Active bindings

name

Returns job name

Methods

Public methods

• .Job$new()

• .Job$start_new()

• .Job$wait()

• .Job$describe()

• .Job$stop()

• .Job$format()

• .Job$clone()

---

Method new()

Base class initializer. Subclasses which override “__init__“ should invoke “super()“

Usage

.Job$new(sagemaker_session = NULL, job_name = NULL)

Arguments

sagemaker_session

(sagemaker.session.Session): Session object which manages interactions with Amazon SageMaker APIs and any other AWS services needed. If not specified, the estimator creates one using the default AWS configuration chain.

job_name

(str): Prefix for training job name

---

Method start_new()

Create a new Amazon SageMaker job from the estimator.

Usage

.Job$start_new(estimator, inputs)

Arguments

estimator

(sagemaker.estimator.EstimatorBase): Estimator object created by the user.

inputs

(str): Parameters used when called :meth:'~sagemaker.estimator.EstimatorBase.fit'.

Returns

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

---

Method wait()

Wait for the Amazon SageMaker job to finish.

Usage

.Job$wait()

---

Method describe()

Describe the job.

Usage

.Job$describe()

---

Method stop()

Stop the job.

Usage

.Job$stop()

---

Method format()

format class

Usage

.Job$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

.Job$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Note

This class shouldn't be directly instantiated. Subclasses must define a way to create, start and wait for an Amazon SageMaker job.

DyfanJones/sagemaker-r-common documentation built on June 14, 2022, 10:31 p.m.