Class: DatadogAPIClient::V2::ExperimentsBanditResultsV2DTODataAttributes

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb

Overview

What the bandit's refreshes have learned.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



63
64
65
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 63

def additional_properties
  @additional_properties
end

#confidence_level ⇒ Object

The probability mass of each confidence interval.



25
26
27
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 25

def confidence_level
  @confidence_level
end

#config_version ⇒ Object

The configuration version the latest saved refresh used. It can be older than the bandit's, because changes such as a new end date don't invalidate results.



28
29
30
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 28

def config_version
  @config_version
end

#data_as_of ⇒ Object

The timestamp of the most recent warehouse data that the latest saved refresh read.



31
32
33
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 31

def data_as_of
  @data_as_of
end

#desired_change ⇒ Object

The direction the bandit optimizes the metric in. It's fixed when the bandit starts. null before the first saved refresh.



34
35
36
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 34

def desired_change
  @desired_change
end

#next_refresh_at ⇒ Object

An estimate of when the next scheduled refresh starts. null when the bandit isn't running or the time can't be estimated. Only daily and hourly schedules get an estimate.



37
38
39
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 37

def next_refresh_at
  @next_refresh_at
end

#optimal_variant_key ⇒ Object

The key of the arm most likely to be best, when one arm leads and the bandit is outside warmup. null otherwise.



40
41
42
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 40

def optimal_variant_key
  @optimal_variant_key
end

#optimal_variant_unavailable_reason ⇒ Object

Why no optimal variant is reported. Absent when one is, or when the cause isn't known.



43
44
45
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 43

def optimal_variant_unavailable_reason
  @optimal_variant_unavailable_reason
end

#point_estimates ⇒ Object

Each arm's point estimate from up to the latest 400 saved refreshes in the requested range, oldest first.



46
47
48
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 46

def point_estimates
  @point_estimates
end

#refresh_id ⇒ Object

The latest refresh that saved results. The estimates come from it.



49
50
51
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 49

def refresh_id
  @refresh_id
end

#results_last_updated ⇒ Object

When the latest saved refresh saved its results.



52
53
54
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 52

def results_last_updated
  @results_last_updated
end

#state ⇒ Object

WAITING_FOR_FIRST_REFRESH until a refresh saves results. STATS_UNAVAILABLE when the latest saved refresh has no complete probabilities of being optimal. ENDED after the bandit is stopped or completed, and its last estimates are kept. Otherwise, WARMUP or OPTIMIZING indicates which policy the bandit serves. A paused bandit keeps its state.



55
56
57
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 55

def state
  @state
end

#statistics_status ⇒ Object

Whether the latest saved refresh calculated its statistics. Absent for older refreshes.



58
59
60
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 58

def statistics_status
  @statistics_status
end

#variants ⇒ Object

One row per arm, in arm order.



61
62
63
# File 'lib/datadog_api_client/v2/models/experiments_bandit_results_v2_dto_data_attributes.rb', line 61

def variants
  @variants
end