types

Documentation

Index

• Variables
• func ArtifactIDMap(artifacts []Artifact) map[string]Artifact
• func ArtifactIDs(artifacts []Artifact) []string
• func IsValidContentType(contentType string) bool
• func NewAlreadyInUseErr(s string) error
• func NewBadRequest(s string) error
• func NewInternalErr(s string) error
• func NewInvalidInputErr(s string) error
• func NewNotFoundErr(s string) error
• func NormalizeID(s string) string
• func ParseVal(s string) any
• type Artifact
  • func NewArtifact(name string, contentType string, content []byte) (Artifact, error)
• type CheckpointArtifact
  • func (c CheckpointArtifact) Content() []byte
  • func (c CheckpointArtifact) ContentType() ContentType
  • func (c CheckpointArtifact) Name() string
• type ContentType
• type Experiment
• type GenericMetric
  • func NewGenericMetric[T constraints.Ordered](key string, sizeAlloc int) *GenericMetric[T]
  • func (s *GenericMetric[T]) Add(v T)
  • func (s *GenericMetric[T]) AddVal(v any)
  • func (s *GenericMetric[T]) Commit()
  • func (s *GenericMetric[T]) LastVal() any
  • func (s GenericMetric[T]) Name() string
  • func (s *GenericMetric[T]) SetVals(vs []any)
  • func (s *GenericMetric[T]) UnCommited() []T
  • func (s GenericMetric[T]) Vals() []any
  • func (s GenericMetric[T]) ValsToCommit() []any
• type Metric
• type ModelEntry
• type ModelRegistry
  • func NewModelRegistry(name string) *ModelRegistry
  • func (m *ModelRegistry) Add(url string, tags ...string)
  • func (m *ModelRegistry) AddTag(tag string, version int) error
  • func (m ModelRegistry) LastModel() ModelEntry
  • func (m ModelRegistry) LatestVersion() int
  • func (m ModelRegistry) MarshalEntries() ([][]byte, error)
  • func (m ModelRegistry) ModelByTag(tag string) (ModelEntry, error)
  • func (m ModelRegistry) ModelByVersion(version int) (ModelEntry, error)
  • func (m ModelRegistry) ModelsByTag(tag string) ([]ModelEntry, error)
  • func (m ModelRegistry) VersionTag(version int) string
• type PlainTextArtifact
  • func (p PlainTextArtifact) Content() []byte
  • func (p PlainTextArtifact) ContentType() ContentType
  • func (p PlainTextArtifact) Name() string
• type Run
  • func NewRun(name string, expID string) Run
  • func (r Run) AddAritifact(name string, a Artifact) error
  • func (r *Run) AddMetric(name string, m Metric) error
  • func (r Run) ArtifactsSlice() []Artifact
• type SavedArtifact

Variables

var (
	ErrAlreadyInUse   = errors.New("already in use")
	ErrInvalidInput   = errors.New("invalid input")
	ErrInternal       = errors.New("internal error")
	ErrBadRequest     = errors.New("bad request")
	ErrNotFound       = errors.New("not found")
	ErrNotInitialized = errors.New("not initialized")
)

Functions

func ArtifactIDMap

func ArtifactIDMap(artifacts []Artifact) map[string]Artifact

func ArtifactIDs

func ArtifactIDs(artifacts []Artifact) []string

func IsValidContentType

func IsValidContentType(contentType string) bool

func NewAlreadyInUseErr

func NewAlreadyInUseErr(s string) error

func NewBadRequest

func NewBadRequest(s string) error

func NewInternalErr

func NewInternalErr(s string) error

func NewInvalidInputErr

func NewInvalidInputErr(s string) error

func NewNotFoundErr

func NewNotFoundErr(s string) error

func NormalizeID

func NormalizeID(s string) string

func ParseVal

func ParseVal(s string) any

Types

type Artifact

type Artifact interface {
	Name() string
	Content() []byte
	ContentType() ContentType
}

func NewArtifact

func NewArtifact(name string, contentType string, content []byte) (Artifact, error)

type CheckpointArtifact

type CheckpointArtifact struct {
	Model      string
	Checkpoint []byte
}

func (CheckpointArtifact) Content

func (c CheckpointArtifact) Content() []byte

func (CheckpointArtifact) ContentType

func (c CheckpointArtifact) ContentType() ContentType

func (CheckpointArtifact) Name

func (c CheckpointArtifact) Name() string

type ContentType

type ContentType string

const (
	TextContentType  ContentType = "content-type/text"
	ModelContentType ContentType = "content-type/model"
)

type Experiment

type Experiment struct {
	Name string
	Runs []*Run
}

type GenericMetric

type GenericMetric[T constraints.Ordered] struct {
	Key    string
	Values []T
	// contains filtered or unexported fields
}

func NewGenericMetric

func NewGenericMetric[T constraints.Ordered](key string, sizeAlloc int) *GenericMetric[T]

func (*GenericMetric[T]) Add

func (s *GenericMetric[T]) Add(v T)

func (*GenericMetric[T]) AddVal

func (s *GenericMetric[T]) AddVal(v any)

func (*GenericMetric[T]) Commit

func (s *GenericMetric[T]) Commit()

func (*GenericMetric[T]) LastVal

func (s *GenericMetric[T]) LastVal() any

func (GenericMetric[T]) Name

func (s GenericMetric[T]) Name() string

func (*GenericMetric[T]) SetVals

func (s *GenericMetric[T]) SetVals(vs []any)

func (*GenericMetric[T]) UnCommited

func (s *GenericMetric[T]) UnCommited() []T

func (GenericMetric[T]) Vals

func (s GenericMetric[T]) Vals() []any

func (GenericMetric[T]) ValsToCommit

func (s GenericMetric[T]) ValsToCommit() []any

type Metric

type Metric interface {
	Name() string
	Vals() []any
	SetVals(vs []any)
	ValsToCommit() []any
	Commit()
	LastVal() any
	AddVal(v any)
}

type ModelEntry

type ModelEntry struct {
	URL  string
	Tags []string
}

type ModelRegistry

type ModelRegistry struct {
	Name   string
	Models []ModelEntry
	Tags   map[string][]int
}

func NewModelRegistry

func NewModelRegistry(name string) *ModelRegistry

func (*ModelRegistry) Add

func (m *ModelRegistry) Add(url string, tags ...string)

Add registers a model checkpoint with a highest version number. Additional tags can be supplied such (`latest`, `prod`, `dev`)

func (*ModelRegistry) AddTag

func (m *ModelRegistry) AddTag(tag string, version int) error

func (ModelRegistry) LastModel

func (m ModelRegistry) LastModel() ModelEntry

func (ModelRegistry) LatestVersion

func (m ModelRegistry) LatestVersion() int

func (ModelRegistry) MarshalEntries

func (m ModelRegistry) MarshalEntries() ([][]byte, error)

func (ModelRegistry) ModelByTag

func (m ModelRegistry) ModelByTag(tag string) (ModelEntry, error)

func (ModelRegistry) ModelByVersion

func (m ModelRegistry) ModelByVersion(version int) (ModelEntry, error)

func (ModelRegistry) ModelsByTag

func (m ModelRegistry) ModelsByTag(tag string) ([]ModelEntry, error)

func (ModelRegistry) VersionTag

func (m ModelRegistry) VersionTag(version int) string

type PlainTextArtifact

type PlainTextArtifact struct {
	FileName    string
	FileContent string
}

func (PlainTextArtifact) Content

func (p PlainTextArtifact) Content() []byte

func (PlainTextArtifact) ContentType

func (p PlainTextArtifact) ContentType() ContentType

func (PlainTextArtifact) Name

func (p PlainTextArtifact) Name() string

type Run

type Run struct {
	Name         string
	Timestamp    time.Time
	ExperimentID string
	Metrics      map[string]Metric
	Artifacts    map[string]Artifact
}

func NewRun

func NewRun(name string, expID string) Run

func (Run) AddAritifact

func (r Run) AddAritifact(name string, a Artifact) error

func (*Run) AddMetric

func (r *Run) AddMetric(name string, m Metric) error

func (Run) ArtifactsSlice

func (r Run) ArtifactsSlice() []Artifact

type SavedArtifact

type SavedArtifact struct {
	Name        string
	ContentType ContentType
	S3Key       string
}