Evaluations

Get Evaluation

Get one evaluation by ID.

Returns:

  • evaluation_id, status (QUEUED, PROCESSING, READY, FAILED)
  • model_id, benchmark_id, progress
  • n_samples_completed, n_samples, avg_time_per_sample, eta_seconds
  • created_at, completed_at, updated_at
get/api/v3/evaluations/{evaluation_id}

Request

  • Base URL
    https://api.nugen.in
  • Auth
    HTTP bearer

Path parameters

evaluation_idstring required

ID of the evaluation, returned when it was created

Response

Returns the evaluation's own record: status, progress, models under test and timestamps. Scores are served by the results endpoint.

evaluation_idstring required

Unique identifier of the evaluation.

evaluation_namestring nullable

Display name of the evaluation.

status'QUEUED' | 'PROCESSING' | 'READY' | 'FAILED' | 'STOPPED' required

Lifecycle status of a resource that runs asynchronously. Stored as is and returned as is, with no translation in between.

  • QUEUED: accepted and waiting for its workflow to start
  • PROCESSING: running
  • READY: finished successfully
  • FAILED: failed at any stage
  • STOPPED: stopped by the user before completion
model_idstring nullable

Model under evaluation.

benchmark_idstring nullable

Benchmark the evaluation runs against.

progressnumber nullable

Completion progress, 0 to 100.

n_samples_completedinteger nullable

Number of samples completed

n_samplesinteger nullable

Total number of samples

avg_time_per_samplenumber nullable

Average time per sample in seconds

eta_secondsinteger nullable

Estimated time remaining in seconds. Not wired up yet, always null.

created_atstring nullable

Creation timestamp.

completed_atstring nullable

Timestamp when the evaluation completed; null while still running.

updated_atstring nullable

Last update timestamp.

Example response

{
  "n_samples_completed": 3,
  "n_samples": 10,
  "avg_time_per_sample": 15.5
}

Changes

No recorded changes to this operation across all 1 revision of this API.