experiments
experiments API, 12 endpoints (generated)
MLflow 실험, 실행(run), 실행 비교, 지표 시계열 및 실행 등록.
GET /api/v1/experiments/tree
GET/api/v1/experiments/tree
프로젝트 -> 실험 -> 실행(run) 트리
호출자의 테넌트로 범위가 한정된 프로젝트 -> 실험 -> 실행(run) 계층 구조 반환(화면 2).
Permission: VIEW
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
max_runs | query | integer |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/runs/compare
GET/api/v1/runs/compare
여러 실행(run) 비교
여러 실행(run)의 파라미터와 지표를 나란히 비교.
Permission: VIEW
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_ids | query | string | ✓ | 쉼표로 구분된 run id 목록 |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/runs/{run_id}
GET/api/v1/runs/{run_id}
실행(run) 상세
단일 실행(run)에 대한 전체 MLflow 상세 객체 반환.
Permission: VIEW
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_id | path | string | ✓ |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
DELETE /api/v1/runs/{run_id}
DELETE/api/v1/runs/{run_id}
실행(run) 영구 삭제
실행(run)을 지표·파라미터·아티팩트까지 영구 삭제.
Permission: DEVELOP
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_id | path | string | ✓ |
Responses
| Status | Description |
|---|---|
| 204 | Successful Response |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/runs/{run_id}/metrics/{name}
GET/api/v1/runs/{run_id}/metrics/{name}
지표 시계열
실행(run)의 단일 지표에 대해 기록된 시계열 반환.
Permission: VIEW
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_id | path | string | ✓ | |
name | path | string | ✓ |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/runs/{run_id}/artifacts
GET/api/v1/runs/{run_id}/artifacts
실행(run) 아티팩트 목록
실행(run)의 아티팩트를 path 바로 아래 한 단계만 나열.
Permission: VIEW
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_id | path | string | ✓ | |
path | query | string | 기준 디렉터리(루트는 빈 문자열) |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/runs/{run_id}/artifact
GET/api/v1/runs/{run_id}/artifact
실행(run) 아티팩트 내용/다운로드
단일 아티팩트 파일의 바이트 스트리밍(프리뷰/다운로드 공용).
Permission: VIEW
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_id | path | string | ✓ | |
path | query | string | ✓ | 아티팩트 파일 경로(run 루트 기준) |
download | query | boolean | true면 attachment로 강제 다운로드 |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/runs/{run_id}/artifacts/download
GET/api/v1/runs/{run_id}/artifacts/download
실행(run) 아티팩트 일괄 다운로드
path 아래 아티팩트를 zip 하나로 묶어 전송.
Permission: VIEW
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_id | path | string | ✓ | |
path | query | string | 묶을 디렉터리(루트 전체는 빈 문자열) |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
POST /api/v1/experiments
POST/api/v1/experiments
실험 생성
호출자의 테넌트를 위해 지정한 프로젝트 아래에 새 실험 생성.
Permission: DEVELOP
Request body: application/json, ExperimentCreate
| Field | Type | Required | Description |
|---|---|---|---|
name | string | ✓ | Name |
project | string | Project |
Responses
| Status | Description |
|---|---|
| 201 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
POST /api/v1/runs/{run_id}/register
POST/api/v1/runs/{run_id}/register
실행(run) 등록
실행(run)의 아티팩트를 model_name 아래의 모델 레지스트리로 등록.
Permission: MODEL_REGISTER
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_id | path | string | ✓ |
Request body: application/json, RegisterRequest
| Field | Type | Required | Description |
|---|---|---|---|
model_name | string | ✓ | Model Name |
Responses
| Status | Description |
|---|---|
| 201 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
POST /api/v1/runs/{run_id}/terminate
POST/api/v1/runs/{run_id}/terminate
실행 중인 실행(run) 종료
활성 실행(run)을 종료(kill).
Permission: DEVELOP
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_id | path | string | ✓ |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
DELETE /api/v1/experiments/{experiment_id}
DELETE/api/v1/experiments/{experiment_id}
실험 영구 삭제
실험과 그 아래 모든 실행(run)·아티팩트를 영구 삭제.
Permission: DEVELOP
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
experiment_id | path | string | ✓ |
Responses
| Status | Description |
|---|---|
| 204 | Successful Response |
| 422 | Validation Error (HTTPValidationError) |