@things-factory/integration-mlflow 9.1.19

package/server/utils/mlflow-api-client.ts

@@ -0,0 +1,375 @@
+/**
+ * MLflow REST API Client
+ *
+ * Thin wrapper around MLflow REST API for Things-Factory integration
+ * Reference: https://mlflow.org/docs/latest/rest-api.html
+ */
+
+import { config } from '@things-factory/env'
+
+const MLFLOW_TRACKING_URI = config.get('mlflowTrackingUri', process.env.MLFLOW_TRACKING_URI || 'http://localhost:5000')
+
+interface MLflowResponse<T> {
+  data?: T
+  error?: string
+}
+
+class MLflowApiClient {
+  private baseUrl: string
+
+  constructor(baseUrl: string = MLFLOW_TRACKING_URI) {
+    this.baseUrl = baseUrl.replace(/\/$/, '') // Remove trailing slash
+  }
+
+  /**
+   * Generic HTTP request wrapper
+   */
+  private async request<T>(endpoint: string, options: RequestInit = {}): Promise<T> {
+    const url = `${this.baseUrl}${endpoint}`
+
+    const defaultHeaders = {
+      'Content-Type': 'application/json'
+    }
+
+    try {
+      const response = await fetch(url, {
+        ...options,
+        headers: {
+          ...defaultHeaders,
+          ...options.headers
+        }
+      })
+
+      if (!response.ok) {
+        const errorText = await response.text()
+        throw new Error(`MLflow API error: ${response.status} - ${errorText}`)
+      }
+
+      return await response.json()
+    } catch (error) {
+      console.error(`MLflow API request failed: ${endpoint}`, error)
+      throw error
+    }
+  }
+
+  // ========================================================================
+  // Experiments API
+  // ========================================================================
+
+  /**
+   * Create a new experiment
+   */
+  async createExperiment(params: {
+    name: string
+    artifact_location?: string
+    tags?: Array<{ key: string; value: string }>
+  }): Promise<{ experiment_id: string }> {
+    return this.request('/api/2.0/mlflow/experiments/create', {
+      method: 'POST',
+      body: JSON.stringify(params)
+    })
+  }
+
+  /**
+   * Get experiment by ID
+   */
+  async getExperiment(experimentId: string): Promise<{
+    experiment: {
+      experiment_id: string
+      name: string
+      artifact_location: string
+      lifecycle_stage: string
+      tags?: Array<{ key: string; value: string }>
+    }
+  }> {
+    return this.request(`/api/2.0/mlflow/experiments/get?experiment_id=${experimentId}`)
+  }
+
+  /**
+   * Search experiments
+   */
+  async searchExperiments(params?: { max_results?: number; filter?: string; order_by?: string[] }): Promise<{
+    experiments: Array<{
+      experiment_id: string
+      name: string
+      artifact_location: string
+      lifecycle_stage: string
+      tags?: Array<{ key: string; value: string }>
+    }>
+  }> {
+    const queryParams = new URLSearchParams()
+    if (params?.max_results) queryParams.append('max_results', String(params.max_results))
+    if (params?.filter) queryParams.append('filter', params.filter)
+
+    return this.request(`/api/2.0/mlflow/experiments/search?${queryParams}`)
+  }
+
+  /**
+   * Delete experiment
+   */
+  async deleteExperiment(experimentId: string): Promise<void> {
+    return this.request('/api/2.0/mlflow/experiments/delete', {
+      method: 'POST',
+      body: JSON.stringify({ experiment_id: experimentId })
+    })
+  }
+
+  // ========================================================================
+  // Runs API
+  // ========================================================================
+
+  /**
+   * Create a new run
+   */
+  async createRun(params: {
+    experiment_id: string
+    start_time?: number
+    tags?: Array<{ key: string; value: string }>
+  }): Promise<{
+    run: {
+      info: {
+        run_id: string
+        experiment_id: string
+        status: string
+        start_time: number
+        artifact_uri: string
+      }
+      data: any
+    }
+  }> {
+    return this.request('/api/2.0/mlflow/runs/create', {
+      method: 'POST',
+      body: JSON.stringify(params)
+    })
+  }
+
+  /**
+   * Get run by ID
+   */
+  async getRun(runId: string): Promise<{
+    run: {
+      info: {
+        run_id: string
+        experiment_id: string
+        status: string
+        start_time: number
+        end_time?: number
+        artifact_uri: string
+      }
+      data: {
+        metrics: Array<{ key: string; value: number; timestamp: number; step: number }>
+        params: Array<{ key: string; value: string }>
+        tags: Array<{ key: string; value: string }>
+      }
+    }
+  }> {
+    return this.request(`/api/2.0/mlflow/runs/get?run_id=${runId}`)
+  }
+
+  /**
+   * Search runs
+   */
+  async searchRuns(params: {
+    experiment_ids: string[]
+    filter?: string
+    max_results?: number
+    order_by?: string[]
+  }): Promise<{
+    runs: Array<{
+      info: {
+        run_id: string
+        experiment_id: string
+        status: string
+        start_time: number
+        end_time?: number
+        artifact_uri: string
+      }
+      data: any
+    }>
+  }> {
+    return this.request('/api/2.0/mlflow/runs/search', {
+      method: 'POST',
+      body: JSON.stringify(params)
+    })
+  }
+
+  /**
+   * Log metric for a run
+   */
+  async logMetric(params: {
+    run_id: string
+    key: string
+    value: number
+    timestamp?: number
+    step?: number
+  }): Promise<void> {
+    return this.request('/api/2.0/mlflow/runs/log-metric', {
+      method: 'POST',
+      body: JSON.stringify(params)
+    })
+  }
+
+  /**
+   * Log parameter for a run
+   */
+  async logParam(params: { run_id: string; key: string; value: string }): Promise<void> {
+    return this.request('/api/2.0/mlflow/runs/log-parameter', {
+      method: 'POST',
+      body: JSON.stringify(params)
+    })
+  }
+
+  /**
+   * Update run status
+   */
+  async updateRun(params: {
+    run_id: string
+    status?: 'RUNNING' | 'SCHEDULED' | 'FINISHED' | 'FAILED' | 'KILLED'
+    end_time?: number
+  }): Promise<void> {
+    return this.request('/api/2.0/mlflow/runs/update', {
+      method: 'POST',
+      body: JSON.stringify(params)
+    })
+  }
+
+  // ========================================================================
+  // Model Registry API
+  // ========================================================================
+
+  /**
+   * Create registered model
+   */
+  async createRegisteredModel(params: {
+    name: string
+    tags?: Array<{ key: string; value: string }>
+    description?: string
+  }): Promise<{
+    registered_model: {
+      name: string
+      creation_timestamp: number
+      last_updated_timestamp: number
+    }
+  }> {
+    return this.request('/api/2.0/mlflow/registered-models/create', {
+      method: 'POST',
+      body: JSON.stringify(params)
+    })
+  }
+
+  /**
+   * Get registered model
+   */
+  async getRegisteredModel(name: string): Promise<{
+    registered_model: {
+      name: string
+      creation_timestamp: number
+      last_updated_timestamp: number
+      description?: string
+      tags?: Array<{ key: string; value: string }>
+      latest_versions?: any[]
+    }
+  }> {
+    return this.request(`/api/2.0/mlflow/registered-models/get?name=${encodeURIComponent(name)}`)
+  }
+
+  /**
+   * Search registered models
+   */
+  async searchRegisteredModels(params?: { filter?: string; max_results?: number; order_by?: string[] }): Promise<{
+    registered_models: Array<{
+      name: string
+      creation_timestamp: number
+      last_updated_timestamp: number
+      description?: string
+      latest_versions?: any[]
+    }>
+  }> {
+    const queryParams = new URLSearchParams()
+    if (params?.filter) queryParams.append('filter', params.filter)
+    if (params?.max_results) queryParams.append('max_results', String(params.max_results))
+
+    return this.request(`/api/2.0/mlflow/registered-models/search?${queryParams}`)
+  }
+
+  /**
+   * Create model version
+   */
+  async createModelVersion(params: {
+    name: string
+    source: string
+    run_id?: string
+    tags?: Array<{ key: string; value: string }>
+    description?: string
+  }): Promise<{
+    model_version: {
+      name: string
+      version: string
+      creation_timestamp: number
+      last_updated_timestamp: number
+      source: string
+      status: string
+    }
+  }> {
+    return this.request('/api/2.0/mlflow/model-versions/create', {
+      method: 'POST',
+      body: JSON.stringify(params)
+    })
+  }
+
+  /**
+   * Get model version
+   */
+  async getModelVersion(params: { name: string; version: string }): Promise<{
+    model_version: {
+      name: string
+      version: string
+      creation_timestamp: number
+      current_stage: string
+      source: string
+      status: string
+      run_id?: string
+    }
+  }> {
+    return this.request(
+      `/api/2.0/mlflow/model-versions/get?name=${encodeURIComponent(params.name)}&version=${params.version}`
+    )
+  }
+
+  /**
+   * Transition model version stage
+   */
+  async transitionModelVersionStage(params: {
+    name: string
+    version: string
+    stage: 'None' | 'Staging' | 'Production' | 'Archived'
+    archive_existing_versions?: boolean
+  }): Promise<{
+    model_version: {
+      name: string
+      version: string
+      current_stage: string
+    }
+  }> {
+    return this.request('/api/2.0/mlflow/model-versions/transition-stage', {
+      method: 'POST',
+      body: JSON.stringify(params)
+    })
+  }
+
+  /**
+   * Delete model version
+   */
+  async deleteModelVersion(params: { name: string; version: string }): Promise<void> {
+    return this.request('/api/2.0/mlflow/model-versions/delete', {
+      method: 'DELETE',
+      body: JSON.stringify(params)
+    })
+  }
+}
+
+// Export singleton instance
+export const mlflowApi = new MLflowApiClient()
+
+// Export class for testing or custom instances
+export { MLflowApiClient }

package/things-factory.config.js

@@ -0,0 +1,13 @@
+import route from './dist-client/route'
+import bootstrap from './dist-client/bootstrap'
+
+export default {
+  route,
+  routes: [
+    { tagname: 'mlflow-experiments-page', page: 'mlflow-experiments' },
+    { tagname: 'mlflow-runs-page', page: 'mlflow-runs' },
+    { tagname: 'mlflow-models-page', page: 'mlflow-models' },
+    { tagname: 'mlflow-viewer-page', page: 'mlflow-viewer' }
+  ],
+  bootstrap
+}

package/translations/en.json

@@ -0,0 +1,28 @@
+{
+  "menu": {
+    "mlflow": "MLflow",
+    "experiments": "Experiments",
+    "runs": "Runs",
+    "models": "Model Registry",
+    "mlflow-ui": "MLflow UI"
+  },
+  "label": {
+    "experiment-name": "Experiment Name",
+    "experiment-id": "Experiment ID",
+    "run-id": "Run ID",
+    "run-status": "Status",
+    "model-name": "Model Name",
+    "model-version": "Version",
+    "model-stage": "Stage",
+    "metrics": "Metrics",
+    "parameters": "Parameters",
+    "artifacts": "Artifacts"
+  },
+  "button": {
+    "create-experiment": "Create Experiment",
+    "create-run": "Create Run",
+    "register-model": "Register Model",
+    "transition-stage": "Transition Stage",
+    "view-mlflow": "Open MLflow UI"
+  }
+}

package/translations/ko.json

@@ -0,0 +1,28 @@
+{
+  "menu": {
+    "mlflow": "MLflow",
+    "experiments": "실험",
+    "runs": "실행",
+    "models": "모델 레지스트리",
+    "mlflow-ui": "MLflow UI"
+  },
+  "label": {
+    "experiment-name": "실험 이름",
+    "experiment-id": "실험 ID",
+    "run-id": "실행 ID",
+    "run-status": "상태",
+    "model-name": "모델 이름",
+    "model-version": "버전",
+    "model-stage": "단계",
+    "metrics": "메트릭",
+    "parameters": "파라미터",
+    "artifacts": "아티팩트"
+  },
+  "button": {
+    "create-experiment": "실험 생성",
+    "create-run": "실행 생성",
+    "register-model": "모델 등록",
+    "transition-stage": "단계 전환",
+    "view-mlflow": "MLflow UI 열기"
+  }
+}