Class: Braintrust::Models::MetricSummary

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/braintrust/models/metric_summary.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #initialize, #inspect, #to_h, #to_s

Constructor Details

This class inherits a constructor from Braintrust::BaseModel

Instance Attribute Details

#diff ⇒ Float

Difference in metric between the current and comparison experiment

Returns:

  • (Float) 


34
 
# File 'lib/braintrust/models/metric_summary.rb', line 34

optional :diff, Float

#improvements ⇒ Integer

Number of improvements in the metric

Returns:

  • (Integer) 


9
 
# File 'lib/braintrust/models/metric_summary.rb', line 9

required :improvements, Integer

#metric ⇒ Float

Average metric across all examples

Returns:

  • (Float) 


14
 
# File 'lib/braintrust/models/metric_summary.rb', line 14

required :metric, Float

#name_ ⇒ String

Name of the metric

Returns:

  • (String) 


19
 
# File 'lib/braintrust/models/metric_summary.rb', line 19

required :name_, String

#regressions ⇒ Integer

Number of regressions in the metric

Returns:

  • (Integer) 


24
 
# File 'lib/braintrust/models/metric_summary.rb', line 24

required :regressions, Integer

#unit ⇒ String

Unit label for the metric

Returns:

  • (String) 


29
 
# File 'lib/braintrust/models/metric_summary.rb', line 29

required :unit, String