package
0.0.0-20240816234238-c0d581acaa8c
Repository: https://github.com/leaf-ai/studio-go-runner.git
Documentation: pkg.go.dev
# Functions
CacheProbe can be used to test the validity of the cache for a previously cached item.
ClearObjStore can be used by clients to erase the contents of the object store cache
.
ExtractMergeDoc uses two JSON-marshalable values x1 and x2 performing a merge and returns the results.
GetBackoffs retrieves a reference to a singleton of the Backoffs structure.
GetCancelWrapper will provide cancel function with some additional tracing capabilities for debugging.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GoGetConst will retrieve data structures from source code within the code directories that can contain useful information to utilities visiting the code for testing purposes.
InitObjStore sets up the backing store for our object store cache.
No description provided by the author
IsInTest will examine the OS arguments passed into the software being run to detect if the go test framework is present.
JSONEditor will accept a source JSON document and an array of change edits for the source document and will process them as either RFC7386, or RFC6902 edits if they validate as either.
MergeExperiment merges the two JSON-marshalable values x1 and x2, preferring x1 over x2 except where x1 and x2 are JSON objects, in which case the keys from both objects are included and their values merged recursively.
NewArtifactCache initializes a hash tracker for artifact related files and passes it back to the caller.
No description provided by the author
NewLocalStorage is used to allocate and initialize a struct that acts as a receiver.
NewObjStore is used to instantiate an object store for the running that includes a cache
.
NewStorage is used to create a receiver for a storage implementation
.
NewTimeEMA creates a new exponential moving average of a time duration for a set of time windows with an initial execution time duration set.
NewTrigger accepts a timer and a channel that together can be used to send messages into a channel that is encapsulated within the returned t data structure
.
NewVirtualEnv builds the VirtualEnv data structure from data received across the wire from a studioml client.
ObjStoreFootPrint can be used to determine what the current footprint of the artifact cache is
.
ParseBytes returns a value for the input string.
No description provided by the author
Run will use a generated script file and will run it to completion while marshalling results and files from the computation.
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
# Structs
ArtifactCache is used to encapsulate and store hashes, typically file hashes, and prevent duplicated uploads from occurring needlessly.
Backoffs uses a cache with TTL on the cache items to maintain a set of blocking directive for resources, where the cache expiry time is the applicable time for the blocker.
No description provided by the author
No description provided by the author
LocalQueue "project" is basically a local root directory containing queues sub-directories.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StoreOpts is used to encapsulate a storage implementation with the runner and studioml data needed
.
TimeEMA is used to store exponential moving averages for a time duration.
Trigger is a data structure that encapsulates a timer and a channel which together are used to in turn to send messages to a downstream go channel.
VirtualEnv encapsulated the context that a python virtual environment is to be instantiated from including items such as the list of pip installables that should be loaded and shell script to run.
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
No description provided by the author
Storage defines an interface for implementations of a studioml artifact store
.
# Type aliases
No description provided by the author