AnalyticsMetricsBase: AnalyticsMetricsBase Class

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

AnalyticsMetricsBase Class

Description

Base class for tuning job or training job analytics classes. Understands common functionality like persistence and caching.

Methods

Public methods

• AnalyticsMetricsBase$new()

• AnalyticsMetricsBase$export_csv()

• AnalyticsMetricsBase$dataframe()

• AnalyticsMetricsBase$clear_cache()

• AnalyticsMetricsBase$format()

• AnalyticsMetricsBase$clone()

---

Method new()

Initialize a “AnalyticsMetricsBase“ instance.

Usage

AnalyticsMetricsBase$new()

---

Method export_csv()

ersists the analytics dataframe to a file.

Usage

AnalyticsMetricsBase$export_csv(filename)

Arguments

filename

(str): The name of the file to save to.

---

Method dataframe()

A dataframe with lots of interesting results about this object. Created by calling SageMaker List and Describe APIs and converting them into a convenient tabular summary.

Usage

AnalyticsMetricsBase$dataframe(force_refresh = FALSE)

Arguments

force_refresh

(bool): Set to True to fetch the latest data from SageMaker API.

---

Method clear_cache()

Clear the object of all local caches of API methods, so that the next time any properties are accessed they will be refreshed from the service.

Usage

AnalyticsMetricsBase$clear_cache()

---

Method format()

format class

Usage

AnalyticsMetricsBase$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AnalyticsMetricsBase$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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