Get Experiment

GET

https://host.com/apis/intake/v2/workspaces/:workspace/experiments/:name

GET

/apis/intake/v2/workspaces/:workspace/experiments/:name

$ curl https://host.com/apis/intake/v2/workspaces/workspace/experiments/name \
>      -H "Content-Type: application/json"

1 {
2   "id": "exp_9f8b7c6d-1234-4a56-8e9f-0a1b2c3d4e5f",
3   "name": "Image Classification Benchmark",
4   "workspace": "vision-team",
5   "agent_name": "NemoAgent",
6   "agent_version": "2.3.1",
7   "dataset_name": "ImageNet",
8   "experiment_group_id": "grp_4a3b2c1d-5678-4e90-b123-456789abcdef",
9   "dataset_version": "2023.09",
10   "source_link": "https://github.com/nemo-platform/experiments/image-classification",
11   "metadata": {
12     "framework": "PyTorch",
13     "hardware": "NVIDIA A100",
14     "notes": "Baseline run with default hyperparameters"
15   },
16   "description": "Benchmark experiment for image classification models on ImageNet dataset.",
17   "summary": "Evaluates multiple models for accuracy and latency on ImageNet.",
18   "created_at": "2024-01-15T09:30:00Z",
19   "updated_at": "2024-01-15T09:30:00Z",
20   "evaluator_names": [
21     "accuracy",
22     "latency"
23   ],
24   "model_names": [
25     "resnet50",
26     "efficientnet_b0"
27   ],
28   "aggregate_scores": {
29     "accuracy": {
30       "sum": 189.5,
31       "mean": 94.75,
32       "median": 94.8,
33       "p90": 95,
34       "p95": 95.2,
35       "p99": 95.5,
36       "count": 2
37     },
38     "latency": {
39       "sum": 120,
40       "mean": 60,
41       "median": 60,
42       "p90": 62,
43       "p95": 63,
44       "p99": 65,
45       "count": 2
46     }
47   },
48   "run_count": 5,
49   "cost_usd": {
50     "sum": 12.5,
51     "mean": 2.5,
52     "median": 2.4,
53     "p90": 3,
54     "p95": 3.2,
55     "p99": 3.5,
56     "count": 5
57   },
58   "latency_ms": {
59     "sum": 3000,
60     "mean": 600,
61     "median": 590,
62     "p90": 650,
63     "p95": 670,
64     "p99": 700,
65     "count": 5
66   }
67 }

Path parameters

workspacestringRequired

namestringRequired

Response

Successful Response

idstring

namestring

workspacestring

agent_namestring

agent_versionstring

dataset_namestring

experiment_group_idstring

Entity id of the owning ExperimentGroup; null when ungrouped. Soft reference, not validated.

dataset_versionstring

source_linkstringformat: "uri">=1 character

metadatamap from strings to any

descriptionstring

summarystring

created_atdatetime

updated_atdatetime

evaluator_nameslist of strings

model_nameslist of strings

Distinct model names observed across ingested sessions for this experiment.

aggregate_scoresmap from strings to objects

run_countintegerDefaults to 0

Number of distinct ingested experiment sessions; one session is treated as one run.

cost_usdobject

Aggregate statistics over evaluator scores or session-level metric values.

latency_msobject

Aggregate statistics over evaluator scores or session-level metric values.

Errors

404

Not Found Error

422

Unprocessable Entity Error