ingest

type EventCallbackBase[V interface{}] func(string, float64, int64, V)

type Ingester interface {
	// FetchUpdates fetches updates from the TFRecord file incrementally.
	// User should call this function periodically in order to get the latest updates.
	// return error means unexpected file content, user should close the Ingester.
	// Notes: FetchUpdates is not thread-safe.
	// Return value is the number of events added to the run.
	FetchUpdates(ctx context.Context) (int, error)

	Close() error

	GetRun() *Run
}

type Run struct {
	Name    string
	Scalars map[string]*ScalarEvents
	Texts   map[string]*TextEvents
}

type ScalarEventCallback = EventCallbackBase[float32]

type ScalarEvents struct {
	// These three slices are parallel in order to save memory.
	// i.e. the i-th element of each slice corresponds to the same event.
	Timestamp []float64
	Step      []int64
	Value     []float32
}

type TextEventCallback = EventCallbackBase[string]

type TextEvents struct {
	// These three slices are parallel in order to save memory.
	// i.e. the i-th element of each slice corresponds to the same event.
	Timestamp []float64
	Step      []int64
	Value     []string
}