ExperimentAnalytics: ExperimentAnalytics class

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

ExperimentAnalytics class

Description

Fetch trial component data and make them accessible for analytics.

Super class

sagemaker.common::AnalyticsMetricsBase -> ExperimentAnalytics

Public fields

MAX_TRIAL_COMPONENTS

class metadata

Active bindings

name

Name of the Experiment being analyzed

Methods

Public methods

• ExperimentAnalytics$new()

• ExperimentAnalytics$clear_cache()

• ExperimentAnalytics$clone()

Inherited methods

• sagemaker.common::AnalyticsMetricsBase$dataframe()
• sagemaker.common::AnalyticsMetricsBase$export_csv()
• sagemaker.common::AnalyticsMetricsBase$format()

---

Method new()

Initialize a “ExperimentAnalytics“ instance.

Usage

ExperimentAnalytics$new(
  experiment_name = NULL,
  search_expression = NULL,
  sort_by = NULL,
  sort_order = NULL,
  metric_names = NULL,
  parameter_names = NULL,
  sagemaker_session = NULL
)

Arguments

experiment_name

(str, optional): Name of the experiment if you want to constrain the search to only trial components belonging to an experiment.

search_expression

(dict, optional): The search query to find the set of trial components to use to populate the data frame.

sort_by

(str, optional): The name of the resource property used to sort the set of trial components.

sort_order

(str optional): How trial components are ordered, valid values are Ascending and Descending. The default is Descending.

metric_names

(list, optional): string names of all the metrics to be shown in the data frame. If not specified, all metrics will be shown of all trials.

parameter_names

(list, optional): string names of the parameters to be shown in the data frame. If not specified, all parameters will be shown of all trials.

sagemaker_session

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

---

Method clear_cache()

Clear the object of all local caches of API methods.

Usage

ExperimentAnalytics$clear_cache()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ExperimentAnalytics$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.