Class MlflowClient

Client for MLflow tracing operations

Index

Constructors

Methods

createExperiment createTrace deleteExperiment getTrace getTraceInfo uploadTraceData

Constructors

constructor

new MlflowClient(
options: { databricksToken?: string; host: string; trackingUri: string },
): MlflowClient
Parameters
- options: { databricksToken?: string; host: string; trackingUri: string }
Returns MlflowClient
- Defined in clients/client.ts:19

Methods

createExperiment

createExperiment(
    name: string,
    artifactLocation?: string,
    tags?: Record<string, string>,
): Promise<string>
Create a new experiment
Parameters
- name: string
- OptionalartifactLocation: string
- Optionaltags: Record<string, string>
Returns Promise<string>
- Defined in clients/client.ts:92

createTrace

createTrace(traceInfo: TraceInfo): Promise<TraceInfo>
Create a new TraceInfo record in the backend store. Corresponding to the Python SDK's start_trace_v3() method.

Note: the backend API is named as "Start" due to unfortunate miscommunication. The API is indeed called at the "end" of a trace, not the "start".
Parameters
- traceInfo: TraceInfo
Returns Promise<TraceInfo>
- Defined in clients/client.ts:37

deleteExperiment

deleteExperiment(experimentId: string): Promise<void>
Delete an experiment
Parameters
- experimentId: string
Returns Promise<void>
- Defined in clients/client.ts:111

getTrace

getTrace(traceId: string): Promise<Trace>
Get a single trace by ID Fetches both trace info and trace data from backend Corresponds to Python: client.get_trace()
Parameters
- traceId: string
Returns Promise<Trace>
- Defined in clients/client.ts:55

getTraceInfo

getTraceInfo(traceId: string): Promise<TraceInfo>
Get trace info using V3 API Endpoint: GET /api/3.0/mlflow/traces/{trace_id}
Parameters
- traceId: string
Returns Promise<TraceInfo>
- Defined in clients/client.ts:65

uploadTraceData

uploadTraceData(traceInfo: TraceInfo, traceData: TraceData): Promise<void>
Upload trace data to the artifact store.
Parameters
- traceInfo: TraceInfo
- traceData: TraceData
Returns Promise<void>
- Defined in clients/client.ts:84