Documentation
¶
Index ¶
- type App
- type AppState
- type Dashboard
- type DeleteExperiment
- type Error
- type ExperimentRun
- type Experiments
- type GetExperiment
- type GetExperimentActivity
- type GetExperimentRuns
- type GetProjectResponse
- type GetRunInfo
- type GetRunInfoExperiment
- type GetRunInfoParams
- type GetRunInfoProps
- type GetRunInfoTraces
- type GetRunInfoTracesMetric
- type GetRunMetrics
- type GetRunsActive
- type ProjectActivityResponse
- type ProjectParamsResponse
- type RunMetrics
- type Success
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App struct {
ID uuid.UUID `json:"id"`
Type string `json:"type"`
State AppState `json:"state"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
App represents the response json in App endpoints
type Dashboard ¶
type Dashboard struct {
ID uuid.UUID `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
AppID uuid.UUID `json:"app_id"`
AppType string `json:"app_type"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
Dashboard represents the response json in Dashboard endpoints
type DeleteExperiment ¶
DeleteExperiment represents the response json fot the DeleteExperimnt endpoint.
type ExperimentRun ¶
type ExperimentRun struct {
ID string `json:"run_id"`
Name string `json:"name"`
CreationTime float64 `json:"creation_time"`
EndTime float64 `json:"end_time"`
Archived bool `json:"archived"`
}
ExperimentRun represents a run of an experiment.
type Experiments ¶
type Experiments []GetExperiment
Experiments is the response struct for the GetExperiments endpoint (slice of GetExperiment).
type GetExperiment ¶
type GetExperiment struct {
ID string `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
Archived bool `json:"archived"`
RunCount int `json:"run_count"`
CreationTime float64 `json:"creation_time"`
}
GetExperiment represents the response json fot the GetExperimnt endpoint.
type GetExperimentActivity ¶
type GetExperimentActivity struct {
NumRuns int `json:"num_runs"`
NumArchivedRuns int `json:"num_archived_runs"`
NumActiveRuns int `json:"num_active_runs"`
ActivityMap map[string]int `json:"activity_map"`
}
GetExperimentActivity represents the response json fot the GetExperimentActivity endpoint.
type GetExperimentRuns ¶
type GetExperimentRuns struct {
ID string `json:"id"`
Runs []ExperimentRun `json:"runs"`
}
GetExperimentRuns represents the response json fot the GetExperimentRuns endpoint.
type GetProjectResponse ¶ added in v0.3.2
type GetProjectResponse struct {
Name string `json:"name"`
Path string `json:"path"`
Description string `json:"description"`
TelemetryEnabled int `json:"telementry_enabled"`
}
GetProjectResponse represents the response json for the `GET aim/projects` endpoint.
type GetRunInfo ¶
type GetRunInfo struct {
Params GetRunInfoParams `json:"params"`
Traces GetRunInfoTraces `json:"traces"`
Props GetRunInfoProps `json:"props"`
}
GetRunInfo represents the response struct for GetRunInfo endpoint
type GetRunInfoExperiment ¶
GetRunInfoExperiment experiment properties
type GetRunInfoParams ¶
GetRunInfoParams is a partial response object for GetRunInfo.
type GetRunInfoProps ¶
type GetRunInfoProps struct {
Name string `json:"name"`
Description string `json:"description"`
Experiment GetRunInfoExperiment `json:"experiment"`
Tags []string `json:"tags"`
CreationTime float64 `json:"creation_time"`
EndTime float64 `json:"end_time"`
Archived bool `json:"archived"`
Active bool `json:"active"`
}
GetRunInfoProps is a partial response object for GetRunInfo.
type GetRunInfoTraces ¶
type GetRunInfoTraces struct {
Tags map[string]string `json:"tags"`
Metric []GetRunInfoTracesMetric `json:"metric"`
}
GetRunInfoTraces is a partial response object for GetRunInfo.
type GetRunInfoTracesMetric ¶ added in v0.5.0
type GetRunInfoTracesMetric struct {
Name string `json:"name"`
Context json.RawMessage `json:"context"`
LastValue float64 `json:"last_value"`
}
GetRunInfoTracesMetric is a partial response object for GetRunInfoTraces.
type GetRunMetrics ¶
type GetRunMetrics []RunMetrics
GetRunMetrics is the reponse struct for GetRunMetrics endpoint (slice of RunMetric)
type GetRunsActive ¶
type GetRunsActive map[string]GetRunInfo
GetRunsActive represents the response struct for GetRunsActive endpoint
type ProjectActivityResponse ¶ added in v0.3.2
type ProjectActivityResponse struct {
NumExperiments int `json:"num_experiments"`
NumRuns int `json:"num_runs"`
NumActiveRuns int `json:"num_active_runs"`
NumArchivedRuns int `json:"num_archived_runs"`
ActivityMap map[string]int `json:"activity_map"`
}
ProjectActivityResponse represents the response json for the `GET aim/projects/activity` endpoint.
type ProjectParamsResponse ¶
type ProjectParamsResponse struct {
Metric map[string][]fiber.Map `json:"metric"`
Params map[string]interface{} `json:"params"`
}
ProjectParamsResponse is a response object for `GET aim/projects/params` endpoint.
type RunMetrics ¶
type RunMetrics struct {
Name string `json:"name"`
Context json.RawMessage `json:"context"`
Values []float64 `json:"values"`
Iters []int64 `json:"iters"`
}
RunMetrics is one run metrics