Class: Phronomy::Eval::EvalResult

Inherits:
Data
  • Object
show all
Defined in:
lib/phronomy/eval/eval_result.rb

Overview

An immutable record holding the outcome of evaluating one EvalCase.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(eval_case:, actual:, score:, usage:, latency_ms:, error: nil) ⇒ EvalResult

Returns a new instance of EvalResult.



14
15
16
 
# File 'lib/phronomy/eval/eval_result.rb', line 14

def initialize(eval_case:, actual:, score:, usage:, latency_ms:, error: nil)
  super
end

Instance Attribute Details

#actual ⇒ Object (readonly)

Returns the value of attribute actual

Returns:

  • (Object) —

    the current value of actual



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/phronomy/eval/eval_result.rb', line 13

EvalResult = Data.define(:eval_case, :actual, :score, :usage, :latency_ms, :error) do
  def initialize(eval_case:, actual:, score:, usage:, latency_ms:, error: nil)
    super
  end

  # Returns true when the scorer assigned a perfect score of 1.0.
  def pass?
    score >= 1.0
  end

  # Returns true when the scorer raised an exception.
  def scorer_error?
    !error.nil?
  end
end

#error ⇒ Object (readonly)

Returns the value of attribute error

Returns:

  • (Object) —

    the current value of error



13
14
15
 
# File 'lib/phronomy/eval/eval_result.rb', line 13

def error
  @error
end

#eval_case ⇒ Object (readonly)

Returns the value of attribute eval_case

Returns:

  • (Object) —

    the current value of eval_case



13
14
15
 
# File 'lib/phronomy/eval/eval_result.rb', line 13

def eval_case
  @eval_case
end

#latency_ms ⇒ Object (readonly)

Returns the value of attribute latency_ms

Returns:

  • (Object) —

    the current value of latency_ms



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/phronomy/eval/eval_result.rb', line 13

EvalResult = Data.define(:eval_case, :actual, :score, :usage, :latency_ms, :error) do
  def initialize(eval_case:, actual:, score:, usage:, latency_ms:, error: nil)
    super
  end

  # Returns true when the scorer assigned a perfect score of 1.0.
  def pass?
    score >= 1.0
  end

  # Returns true when the scorer raised an exception.
  def scorer_error?
    !error.nil?
  end
end

#score ⇒ Object (readonly)

Returns the value of attribute score

Returns:

  • (Object) —

    the current value of score



13
14
15
 
# File 'lib/phronomy/eval/eval_result.rb', line 13

def score
  @score
end

#usage ⇒ Object (readonly)

Returns the value of attribute usage

Returns:

  • (Object) —

    the current value of usage



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/phronomy/eval/eval_result.rb', line 13

EvalResult = Data.define(:eval_case, :actual, :score, :usage, :latency_ms, :error) do
  def initialize(eval_case:, actual:, score:, usage:, latency_ms:, error: nil)
    super
  end

  # Returns true when the scorer assigned a perfect score of 1.0.
  def pass?
    score >= 1.0
  end

  # Returns true when the scorer raised an exception.
  def scorer_error?
    !error.nil?
  end
end

Instance Method Details

#error=(value) ⇒ Object (readonly)

set when the scorer raised an exception



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/phronomy/eval/eval_result.rb', line 13

EvalResult = Data.define(:eval_case, :actual, :score, :usage, :latency_ms, :error) do
  def initialize(eval_case:, actual:, score:, usage:, latency_ms:, error: nil)
    super
  end

  # Returns true when the scorer assigned a perfect score of 1.0.
  def pass?
    score >= 1.0
  end

  # Returns true when the scorer raised an exception.
  def scorer_error?
    !error.nil?
  end
end

#eval_case=(value) ⇒ Object (readonly)

the original sample



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/phronomy/eval/eval_result.rb', line 13

EvalResult = Data.define(:eval_case, :actual, :score, :usage, :latency_ms, :error) do
  def initialize(eval_case:, actual:, score:, usage:, latency_ms:, error: nil)
    super
  end

  # Returns true when the scorer assigned a perfect score of 1.0.
  def pass?
    score >= 1.0
  end

  # Returns true when the scorer raised an exception.
  def scorer_error?
    !error.nil?
  end
end

#pass? ⇒ Boolean

Returns true when the scorer assigned a perfect score of 1.0.

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/phronomy/eval/eval_result.rb', line 19

def pass?
  score >= 1.0
end

#score=(value) ⇒ Object (readonly)

scorer-assigned value in [0.0, 1.0]



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/phronomy/eval/eval_result.rb', line 13

EvalResult = Data.define(:eval_case, :actual, :score, :usage, :latency_ms, :error) do
  def initialize(eval_case:, actual:, score:, usage:, latency_ms:, error: nil)
    super
  end

  # Returns true when the scorer assigned a perfect score of 1.0.
  def pass?
    score >= 1.0
  end

  # Returns true when the scorer raised an exception.
  def scorer_error?
    !error.nil?
  end
end

#scorer_error? ⇒ Boolean

Returns true when the scorer raised an exception.

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/phronomy/eval/eval_result.rb', line 24

def scorer_error?
  !error.nil?
end