request

package
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 19, 2023 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateExperimentRequest 

type CreateExperimentRequest struct {
	Name             string                        `json:"name"`
	Tags             []ExperimentTagPartialRequest `json:"tags"`
	ArtifactLocation string                        `json:"artifact_location"`
}

CreateExperimentRequest is a request object for `POST /mlflow/experiments/create` endpoint.

type CreateRunRequest 

type CreateRunRequest struct {
	ExperimentID string                 `json:"experiment_id"`
	UserID       string                 `json:"user_id"`
	Name         string                 `json:"run_name"`
	StartTime    int64                  `json:"start_time"`
	Tags         []RunTagPartialRequest `json:"tags"`
}

CreateRunRequest is a request object for `POST /mlflow/runs/create` endpoint.

type DeleteExperimentRequest 

type DeleteExperimentRequest struct {
	ID string `json:"experiment_id"`
}

DeleteExperimentRequest is a request object for `POST /mlflow/experiments/delete` endpoint.

type DeleteRunRequest 

type DeleteRunRequest struct {
	RunID string `json:"run_id"`
}

DeleteRunRequest is a request object for `POST /mlflow/runs/delete` endpoint.

type DeleteRunTagRequest 

type DeleteRunTagRequest struct {
	RunID string `json:"run_id"`
	Key   string `json:"key"`
}

DeleteRunTagRequest is a request object for `POST /mlflow/runs/delete-tag` endpoint.

type ExperimentTagPartialRequest 

type ExperimentTagPartialRequest struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

ExperimentTagPartialRequest is a partial request object for different requests.

type GetExperimentRequest 

type GetExperimentRequest struct {
	ID   string `query:"experiment_id"`
	Name string `query:"experiment_name"`
}

GetExperimentRequest is a request object for `POST /mlflow/experiments/update` endpoint.

type GetMetricHistoriesRequest 

type GetMetricHistoriesRequest struct {
	ExperimentIDs []string `json:"experiment_ids"`
	RunIDs        []string `json:"run_ids"`
	MetricKeys    []string `json:"metric_keys"`
	ViewType      ViewType `json:"run_view_type"`
	MaxResults    int32    `json:"max_results"`
}

GetMetricHistoriesRequest is a request object for `POST /mlflow/metrics/get-histories` endpoint.

type GetMetricHistoryBulkRequest 

type GetMetricHistoryBulkRequest struct {
	RunIDs     []string `query:"run_id"`
	MetricKey  string   `query:"metric_key"`
	MaxResults int      `query:"max_results"`
}

GetMetricHistoryBulkRequest is a request object for `GET /mlflow/metrics/get-history-bulk` endpoint.

type GetMetricHistoryRequest 

type GetMetricHistoryRequest struct {
	RunID     string `query:"run_id"`
	RunUUID   string `query:"run_uuid"`
	MetricKey string `query:"metric_key"`
}

GetMetricHistoryRequest is a request object for `GET /mlflow/metrics/get-history` endpoint.

func (GetMetricHistoryRequest) GetRunID 

func (r GetMetricHistoryRequest) GetRunID() string

GetRunID returns Run RunID.

type GetRunRequest 

type GetRunRequest struct {
	RunID   string `query:"run_id"`
	RunUUID string `query:"run_uuid"`
}

GetRunRequest is a request object for `GET /mlflow/runs/get` endpoint.

func (GetRunRequest) GetRunID 

func (r GetRunRequest) GetRunID() string

GetRunID returns Run RunID.

type ListArtifactsRequest 

type ListArtifactsRequest struct {
	Path    string `query:"path"`
	RunID   string `query:"run_id"`
	RunUUID string `query:"run_uuid"`
}

ListArtifactsRequest is a request object for `GET /mlflow/artifacts/list` endpoint.

func (ListArtifactsRequest) GetRunID 

func (r ListArtifactsRequest) GetRunID() string

GetRunID returns Run ID.

type LogBatchRequest 

type LogBatchRequest struct {
	RunID   string                 `json:"run_id"`
	Tags    []TagPartialRequest    `json:"tags,omitempty"`
	Params  []ParamPartialRequest  `json:"params,omitempty"`
	Metrics []MetricPartialRequest `json:"metrics,omitempty"`
}

LogBatchRequest is a request object for `POST mlflow/runs/log-batch` endpoint.

type LogMetricRequest 

type LogMetricRequest struct {
	RunID     string `json:"run_id"`
	RunUUID   string `json:"run_uuid"`
	Key       string `json:"key"`
	Value     any    `json:"value"`
	Timestamp int64  `json:"timestamp"`
	Step      int64  `json:"step"`
}

LogMetricRequest is a request object for `POST mlflow/runs/log-metric` endpoint.

func (LogMetricRequest) GetRunID 

func (r LogMetricRequest) GetRunID() string

GetRunID returns Run ID.

type LogParamRequest 

type LogParamRequest struct {
	RunID   string `json:"run_id"`
	RunUUID string `json:"run_uuid"`
	Key     string `json:"key"`
	Value   string `json:"value"`
}

LogParamRequest is a request object for `POST mlflow/runs/log-parameter` endpoint.

func (LogParamRequest) GetRunID 

func (r LogParamRequest) GetRunID() string

GetRunID returns Run ID.

type MetricPartialRequest 

type MetricPartialRequest struct {
	Key       string `json:"key"`
	Value     any    `json:"value"`
	Timestamp int64  `json:"timestamp"`
	Step      int64  `json:"step"`
}

MetricPartialRequest is a partial request object for different requests.

type PageToken 

type PageToken struct {
	Offset int32 `json:"offset"`
}

type ParamPartialRequest 

type ParamPartialRequest struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

ParamPartialRequest is a partial request object for different requests.

type RestoreExperimentRequest 

type RestoreExperimentRequest struct {
	ID string `json:"experiment_id"`
}

RestoreExperimentRequest is a request object for `POST /mlflow/experiments/restore` endpoint.

type RestoreRunRequest 

type RestoreRunRequest struct {
	RunID string `json:"run_id"`
}

RestoreRunRequest is a request object for `POST /mlflow/runs/restore` endpoint.

type RunTagPartialRequest 

type RunTagPartialRequest struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

RunTagPartialRequest is a partial request object for different requests.

type SearchExperimentsRequest 

type SearchExperimentsRequest struct {
	MaxResults int64    `json:"max_results" query:"max_results"`
	PageToken  string   `json:"page_token"  query:"page_token"`
	Filter     string   `json:"filter"      query:"filter"`
	OrderBy    []string `json:"order_by"    query:"order_by"`
	ViewType   ViewType `json:"view_type"   query:"view_type"`
}

SearchExperimentsRequest is a request object for `POST /mlflow/experiments/list` or `POST /mlflow/experiments/search` or `GET /mlflow/experiments/search` endpoints.

type SearchRunsRequest 

type SearchRunsRequest struct {
	ExperimentIDs []string `json:"experiment_ids"`
	Filter        string   `json:"filter"`
	ViewType      ViewType `json:"run_view_type"`
	MaxResults    int32    `json:"max_results"`
	OrderBy       []string `json:"order_by"`
	PageToken     string   `json:"page_token"`
}

SearchRunsRequest is a request object for `POST /mlflow/runs/search` endpoint.

type SetExperimentTagRequest 

type SetExperimentTagRequest struct {
	ID    string `json:"experiment_id"`
	Key   string `json:"key"`
	Value string `json:"value"`
}

SetExperimentTagRequest is a request object for `POST /mlflow/experiments/set-experiment-tag` endpoint.

type SetRunTagRequest 

type SetRunTagRequest struct {
	RunID   string `json:"run_id"`
	RunUUID string `json:"run_uuid"`
	Key     string `json:"key"`
	Value   string `json:"value"`
}

SetRunTagRequest is a request object for `POST /mlflow/runs/set-tag` endpoint.

func (SetRunTagRequest) GetRunID 

func (r SetRunTagRequest) GetRunID() string

GetRunID returns Run RunID.

type TagPartialRequest 

type TagPartialRequest struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

TagPartialRequest is a partial request object for different requests.

type UpdateExperimentRequest 

type UpdateExperimentRequest struct {
	ID   string `json:"experiment_id"`
	Name string `json:"new_name"`
}

UpdateExperimentRequest is a request object for `POST /mlflow/experiments/update` endpoint.

type UpdateRunRequest 

type UpdateRunRequest struct {
	RunID   string `json:"run_id"`
	RunUUID string `json:"run_uuid"`
	Name    string `json:"run_name"`
	Status  string `json:"status"`
	EndTime int64  `json:"end_time"`
}

UpdateRunRequest is a request object for `POST /mlflow/runs/update` endpoint.

func (UpdateRunRequest) GetRunID 

func (r UpdateRunRequest) GetRunID() string

GetRunID returns Run RunID.

type ViewType 

type ViewType string
const (
	ViewTypeAll         ViewType = "ALL"
	ViewTypeActiveOnly  ViewType = "ACTIVE_ONLY"
	ViewTypeDeletedOnly ViewType = "DELETED_ONLY"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.