@arizeai/phoenix-evals
Version:
A library for running evaluations for AI use cases
26 lines • 922 B
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.createF1Evaluator = createF1Evaluator;
const createFBetaEvaluator_1 = require("./createFBetaEvaluator");
/**
* Creates a code evaluator that computes the F1 score: the harmonic mean of
* precision and recall.
*
* Supports binary classification (via `positiveLabel`, or auto-detected when
* labels are the numeric set `{0, 1}`) and multi-class classification (via
* the `average` strategy).
*
* @example
* ```typescript
* const f1 = createF1Evaluator();
* const result = await f1.evaluate({
* expected: ["cat", "dog", "cat", "bird"],
* output: ["cat", "cat", "cat", "bird"],
* });
* // { score: 0.6 }
* ```
*/
function createF1Evaluator(options = {}) {
return (0, createFBetaEvaluator_1.createFBetaEvaluator)(Object.assign(Object.assign({}, options), { beta: 1 }));
}
//# sourceMappingURL=createF1Evaluator.js.map