Nous.Eval.Reporter (nous v0.13.3)

View Source

Report generation for evaluation results.

Example

{:ok, result} = Nous.Eval.run(suite)

# Print to console
Nous.Eval.Reporter.print(result)

# Generate JSON
json = Nous.Eval.Reporter.to_json(result)

# Write to file
Nous.Eval.Reporter.to_file(result, "report.json")

Summary

Functions

print(result, opts \\ [])

Print results to console.

print_detailed(result, opts \\ [])

Print detailed results (including failures) to console.

to_file(result, path)

Write report to JSON file.

to_json(result)

Generate JSON report.

to_markdown(result)

Generate markdown report.

Functions

print(result, opts \\ [])

@spec print(
  Nous.Eval.SuiteResult.t(),
  keyword()
) :: :ok

Print results to console.

to_file(result, path)

@spec to_file(Nous.Eval.SuiteResult.t(), String.t()) :: :ok | {:error, term()}

Write report to JSON file.

to_json(result)

@spec to_json(Nous.Eval.SuiteResult.t()) :: String.t()

Generate JSON report.

to_markdown(result)

@spec to_markdown(Nous.Eval.SuiteResult.t()) :: String.t()

Generate markdown report.