Pin Experiment

POST

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

POST

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

$ curl -X POST https://host.com/apis/intake/v2/workspaces/workspace/experiments/name/pin \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "id": "exp-9f8b7c6d-1234-4a56-b789-0cdef1234567",
3   "name": "Image Classification Experiment",
4   "workspace": "vision-team",
5   "experiment_group_id": "grp-4a5b6c7d-8901-4e23-b456-7fghijklmno8",
6   "dataset_name": "ImageNet",
7   "dataset_version": "2023.2",
8   "source_link": "https://github.com/vision-team/image-classification",
9   "metadata": {
10     "framework": "PyTorch",
11     "hardware": "NVIDIA A100",
12     "notes": "Initial run with augmented data"
13   },
14   "description": "Experiment to evaluate ResNet50 on ImageNet with data augmentation.",
15   "summary": "Achieved 76.5% top-1 accuracy with standard augmentation.",
16   "created_at": "2024-01-15T09:30:00Z",
17   "updated_at": "2024-01-15T09:30:00Z",
18   "pinned_at": "2024-01-15T09:30:00Z",
19   "evaluator_names": [
20     "accuracy",
21     "f1_score"
22   ],
23   "model_names": [
24     "ResNet50"
25   ],
26   "agent_names": [
27     "training-agent-v1"
28   ],
29   "agent_versions": [
30     "1.3.0"
31   ],
32   "aggregate_scores": {
33     "accuracy": {
34       "sum": 7650,
35       "mean": 0.765,
36       "median": 0.766,
37       "p90": 0.78,
38       "p95": 0.79,
39       "p99": 0.8,
40       "count": 10000
41     },
42     "f1_score": {
43       "sum": 7400,
44       "mean": 0.74,
45       "median": 0.742,
46       "p90": 0.75,
47       "p95": 0.76,
48       "p99": 0.77,
49       "count": 10000
50     }
51   },
52   "run_count": 15,
53   "cost_usd": {
54     "sum": 120.5,
55     "mean": 8.03,
56     "median": 7.95,
57     "p90": 10,
58     "p95": 11,
59     "p99": 12.5,
60     "count": 15
61   },
62   "latency_ms": {
63     "sum": 450000,
64     "mean": 30000,
65     "median": 29500,
66     "p90": 35000,
67     "p95": 36000,
68     "p99": 40000,
69     "count": 15
70   }
71 }

Pin an experiment to the top of the list (workspace-shared).

Re-pinning an already-pinned experiment refreshes pinned_at to the current timestamp, which is intentional (most-recently-pinned sorts first).

Path parameters

workspacestringRequired

namestringRequired

Response

Successful Response

idstring

namestring

workspacestring

experiment_group_idstring

Entity id of the owning ExperimentGroup. Required for every Experiment.

dataset_namestring

dataset_versionstring

source_linkstringformat: "uri">=1 character

metadatamap from strings to any

descriptionstring

summarystring

created_atdatetime

updated_atdatetime

pinned_atdatetime or null

Timestamp at which the experiment was pinned, or null if unpinned. Managed via POST/DELETE /experiments/{name}/pin.

evaluator_nameslist of strings

model_nameslist of strings

Distinct model names observed across ingested sessions for this experiment.

agent_nameslist of strings

Distinct agent names observed across ingested sessions for this experiment.

agent_versionslist of strings

Distinct agent versions 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