store

package
v0.1.3 Latest Latest
Warning

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

 Go to latest Published: May 6, 2026 License: GPL-3.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// APIKeyPattern pattern that represents a api key.
	APIKeyPattern = "api-key:%s"

	// ExpInfoKeyPattern is a pattern to a key that holds
	// information on experiments.
	ExpInfoKeyPattern = "info:exp:%s"

	// ExpKeyPattern is a pattern to an experiment key
	// that holds index of all runs linked to that exp.
	ExpKeyPattern = "exp:%s"

	// RunKeyPattern pattern of a Run's key
	// Example:
	// run:linear-regression
	RunKeyPattern = "run:%s"

	// MetricKeyPattern pattern of a metric metric:<metric_name>:<run_id>
	// Example
	// metric:mse:linear-regression
	MetricKeyPattern = "metric:%s:%s"

	// ArtifactKeyPattern pattern of a artifact's key
	// Example
	// artifact:logs:linear-regression
	ArtifactKeyPattern = "artifact:%s:%s"

	// ModelRegistryInfoKeyPattern pattern of model registry's data info value.
	ModelRegistryInfoKeyPattern = "info:registry:%s"

	// ModelRegistryKeyPattern pattern of a model registry key
	// Example
	// registry:yolov12 maps to a list of model entries
	ModelRegistryKeyPattern = "registry:%s"

	// ModelRegistryMatchPattern match pattern for all model registries.
	ModelRegistryMatchPattern = "registry:*"

	// ModelRegistryTagsKeyPattern pattern a model registry's tags
	// Example
	// tag:registry:yolov12 -> [prod, latest, ...]
	ModelRegistryTagsKeyPattern = "tag:registry:%s"

	// ModelRegistryTagKeyPattern pattern a model registry tag
	// Example
	// tag:registry:yolov12:prod
	ModelRegistryTagKeyPattern = "tag:registry:%s:%s"

	// ModelRegistryBenchmarksIndexPattern (Set holding all linked benchmarks)
	// form: index:registry:<registry-name>:benchs
	ModelRegistryBenchmarksIndexPattern = "index:registry:%s:benchs"

	// BenchmarksKey.
	BenchmarksKey = "index:benchs"

	// BenchmarkKeyPattern.
	BenchmarkKeyPattern = "bench:%s"

	// BenchmarkMetricsKeyPattern.
	BenchmarkMetricsKeyPattern = "bench:%s:metrics"

	// BenchmarkRegistriesKeyPattern.
	BenchmarkRegistriesKeyPattern = "bench:%s:registries"

	// BenchmarkRunsKeyPattern index used to pull all benchmark runs
	// It follows this form: index:bench:<bench-id>:runs.
	BenchmarkRunsKeyPattern = "index:bench:%s:runs"

	// BenchmarkRunKeyPattern key pattern used to save a benchmark run
	// It follows this order: bench:<bench-id>:run:<registry-name>:<version>.
	BenchmarkRunKeyPattern = "bench:%s:run:%s:%d"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type RedisStore 

type RedisStore struct {
	Client redis.Client
}

func (*RedisStore) AddBenchmarkMetrics added in v0.1.3 

func (r *RedisStore) AddBenchmarkMetrics(ctx context.Context, benchID string, metrics []types.BenchMetric) error

AddBenchmarkMetrics adds metrics to a benchmark.

func (*RedisStore) AddBenchmarkRegistries added in v0.1.3 

func (r *RedisStore) AddBenchmarkRegistries(ctx context.Context, benchID string, registries []string) error

AddBenchmarkRegistries adds registries to a benchmark.

func (*RedisStore) AddModel 

func (r *RedisStore) AddModel(ctx context.Context, name string, m types.ModelEntry, tags ...string) error

func (*RedisStore) Artifact 

func (r *RedisStore) Artifact(ctx context.Context, runID string, id string) (types.SavedArtifact, error)

func (*RedisStore) ArtifactExist 

func (r *RedisStore) ArtifactExist(ctx context.Context, runID string, id string) error

func (*RedisStore) Artifacts 

func (r *RedisStore) Artifacts(ctx context.Context, runID string) (map[string]types.SavedArtifact, error)

func (*RedisStore) ArtifactsExist 

func (r *RedisStore) ArtifactsExist(ctx context.Context, runID string, ids []string) map[string]error

func (*RedisStore) Benchmark added in v0.1.3 

func (r *RedisStore) Benchmark(ctx context.Context, benchID string) (*types.Bench, error)

Benchmark pulls a benchmark by its name from the redis store.

func (*RedisStore) BenchmarkExists added in v0.1.3 

func (r *RedisStore) BenchmarkExists(ctx context.Context, benchID string) (bool, error)

BenchmarkExists checks if a benchmark with BenchName exists.

func (*RedisStore) BenchmarkMetrics added in v0.1.3 

func (r *RedisStore) BenchmarkMetrics(ctx context.Context, benchID string) ([]types.BenchMetric, error)

BenchmarkMetrics pulls metrics linked to a benchmark.

func (*RedisStore) BenchmarkRegistries added in v0.1.3 

func (r *RedisStore) BenchmarkRegistries(ctx context.Context, benchID string) ([]string, error)

BenchmarkRegistries pulls model registries linked to a benchmark.

func (*RedisStore) BenchmarkRuns added in v0.1.3 

func (r *RedisStore) BenchmarkRuns(ctx context.Context, benchID string) ([]*types.BenchRun, error)

BenchmarkRuns returns all benchmark runs recorded.

func (*RedisStore) Benchmarks added in v0.1.3 

func (r *RedisStore) Benchmarks(ctx context.Context) ([]string, error)

Benchmarks returns all known benchmarks.

func (*RedisStore) CreateBenchmark added in v0.1.3 

func (r *RedisStore) CreateBenchmark(ctx context.Context, b types.Bench) (bool, error)

CreateBenchmark creates a new benchmark.

func (*RedisStore) CreateModelRegistry 

func (r *RedisStore) CreateModelRegistry(ctx context.Context, m types.ModelRegistry) error

func (*RedisStore) Exp 

func (r *RedisStore) Exp(ctx context.Context, expID string) (*types.Experiment, error)

func (*RedisStore) ExpExists 

func (r *RedisStore) ExpExists(ctx context.Context, expID string) error

func (*RedisStore) ExpInfo 

func (r *RedisStore) ExpInfo(ctx context.Context, expID string) (types.ExperimentInfo, error)

ExpInfo pulls an experiment's info data.

func (*RedisStore) ExpRunIDs 

func (r *RedisStore) ExpRunIDs(ctx context.Context, expID string) ([]string, error)

func (*RedisStore) Exps 

func (r *RedisStore) Exps(ctx context.Context) ([]string, error)

func (*RedisStore) GenerateKey added in v0.1.3 

func (r *RedisStore) GenerateKey(ctx context.Context) (string, error)

GenerateKey generates a new key and saves it to the store.

func (*RedisStore) IsValidAPIKey added in v0.1.3 

func (r *RedisStore) IsValidAPIKey(ctx context.Context, key string) (bool, error)

IsValidAPIKey returns true if the API key is valid.

func (*RedisStore) LastModel 

func (r *RedisStore) LastModel(ctx context.Context, name string) (types.ModelEntry, error)

func (*RedisStore) Metrics 

func (r *RedisStore) Metrics(ctx context.Context, runID string) (map[string]types.Metric, error)

func (*RedisStore) ModelByTag 

func (r *RedisStore) ModelByTag(ctx context.Context, name string, tag string) (types.ModelEntry, error)

func (*RedisStore) ModelByVersion 

func (r *RedisStore) ModelByVersion(ctx context.Context, name string, version int) (types.ModelEntry, error)

func (*RedisStore) ModelRegistries 

func (r *RedisStore) ModelRegistries(ctx context.Context) ([]*types.ModelRegistry, error)

ModelRegistries returns a slice of all known registries.

func (*RedisStore) ModelRegistriesID 

func (r *RedisStore) ModelRegistriesID(ctx context.Context) ([]string, error)

ModelRegistriesID returns a slice of all known registry ids.

func (*RedisStore) ModelRegistry 

func (r *RedisStore) ModelRegistry(ctx context.Context, name string) (*types.ModelRegistry, error)

func (*RedisStore) ModelRegistryExists 

func (r *RedisStore) ModelRegistryExists(ctx context.Context, name string) error

ModelRegistryExists returns non-nil error if registry was not found.

func (*RedisStore) RecordRuns added in v0.1.3 

func (r *RedisStore) RecordRuns(ctx context.Context, benchID string, runs []types.BenchRun) error

RecordRuns records new benchmark runs to the store.

func (*RedisStore) RegistryBenchmarks added in v0.1.3 

func (r *RedisStore) RegistryBenchmarks(ctx context.Context, registry string) ([]string, error)

RegistryBenchmarks returns all benchmarks linked with a registry.

func (*RedisStore) RemBenchmarkMetrics added in v0.1.3 

func (r *RedisStore) RemBenchmarkMetrics(ctx context.Context, benchID string, metrics []string) error

RemBenchmarkMetrics removes metrics from a benchmark.

func (*RedisStore) RemBenchmarkRegistries added in v0.1.3 

func (r *RedisStore) RemBenchmarkRegistries(ctx context.Context, benchID string, registries []string) error

RemBenchmarkRegistries removes model registries from a benchmark.

func (*RedisStore) Run 

func (r *RedisStore) Run(ctx context.Context, id string) (*types.Run, error)

func (*RedisStore) RunExists 

func (r *RedisStore) RunExists(ctx context.Context, runID string) (bool, error)

RunExists checks if a run exists in the redis store.

func (*RedisStore) RunMetrics 

func (r *RedisStore) RunMetrics(ctx context.Context, runID string) ([]string, error)

func (*RedisStore) Runs 

func (r *RedisStore) Runs(ctx context.Context, ids []string) ([]*types.Run, error)

func (*RedisStore) SelectBenchmarkMetrics added in v0.1.3 

func (r *RedisStore) SelectBenchmarkMetrics(ctx context.Context, benchID string,
	metrics []string,
) ([]types.BenchMetric, error)

SelectBenchmarkMetrics searches for metrics linked to a benchmark.

func (*RedisStore) SetArtifact 

func (r *RedisStore) SetArtifact(ctx context.Context, runID string, a types.SavedArtifact) error

func (*RedisStore) SetArtifacts 

func (r *RedisStore) SetArtifacts(ctx context.Context, runID string, as []types.SavedArtifact) error

func (*RedisStore) SetExpInfo 

func (r *RedisStore) SetExpInfo(ctx context.Context, expID string, info types.ExperimentInfo) error

SetExpInfo sets an experiment's info data. returns non-nil error if operation was not successful.

func (*RedisStore) SetMetric 

func (r *RedisStore) SetMetric(ctx context.Context, runID string, m types.Metric) error

func (*RedisStore) SetMetrics 

func (r *RedisStore) SetMetrics(ctx context.Context, runID string, ms map[string]types.Metric) error

func (*RedisStore) SetRun 

func (r *RedisStore) SetRun(ctx context.Context, run types.Run) error

SetRun saves a run to the redis store. Saving a run involves: 1 - runKey (run:runId) is where the run data is stored 2 - expKey (exp:expId) key index for all runs of an experiment 3 - metrics (metric:metricName:runId) where each metric of the run is stored.

func (*RedisStore) ToggleBenchmark added in v0.1.3 

func (r *RedisStore) ToggleBenchmark(ctx context.Context, benchID string, paused bool) error

ToggleBenchmark toggles a benchmark state between paused and unpaused.

func (*RedisStore) UpdateBenchmark added in v0.1.3 

func (r *RedisStore) UpdateBenchmark(ctx context.Context, benchID string, update types.UpdateBench) error

UpdateBenchmark updates the settings fields of a benchmark.

func (*RedisStore) UpdateModelRegistry 

func (r *RedisStore) UpdateModelRegistry(ctx context.Context, m types.ModelRegistry) error

func (*RedisStore) UpdateRegistryDockerImage added in v0.1.3 

func (r *RedisStore) UpdateRegistryDockerImage(ctx context.Context, registry, dockerImage string) error

UpdateRegistryDockerImage updates the benchmark image of a registry.

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.