config

package
v0.16.6 Latest Latest
Warning

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

 Go to latest Published: Aug 25, 2025 License: Apache-2.0 Imports: 23 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	MinimumMajorPythonVersion               int = 3
	MinimumMinorPythonVersion               int = 8
	MinimumMinorPythonVersionForConcurrency int = 11
	MinimumMajorCudaVersion                 int = 11
)

Variables

View Source 
var (
	BuildSourceEpochTimestamp int64 = -1
	BuildXCachePath           string
	PipPackageNameRegex       = regexp.MustCompile(`^([^>=<~ \n[#]+)`)
)
View Source 
var CUDABaseImages []CUDABaseImage
View Source 
var EnvironmentVariableDenyList = []string{

	"PATH",
	"LD_LIBRARY_PATH",
	"PYTHONPATH",
	"VIRTUAL_ENV",
	"PYTHONUNBUFFERED",

	"R8_*",
	"REPLICATE_*",

	"LIBRARY_PATH",
	"CUDA_*",
	"NVIDIA_*",
	"NV_*",

	"PGET_*",
	"HF_ENDPOINT",
	"HF_HUB_ENABLE_HF_TRANSFER",

	"KUBERNETES_*",
}

EnvironmentVariableDenyList is a list of environment variable patterns that are used internally during build or runtime and thus not allowed to be set by the user. There are ways around this restriction, but it's likely to cause unexpected behavior and hard to debug issues. So on Cog's predict-build-push happy path, we don't allow these to be set. This list may change at any time. For more context, see: https://github.com/replicate/cog/pull/2274/#issuecomment-2831823185

View Source 
var TFCompatibilityMatrix []TFCompatibility
View Source 
var TorchCompatibilityMatrix []TorchCompatibility

Functions

func BaseDockerImageName added in v0.0.8 

func BaseDockerImageName(projectDir string) string

BaseDockerImageName returns the Docker image name for base images

func CUDABaseImageFor added in v0.0.8 

func CUDABaseImageFor(cuda string, cuDNN string) (string, error)

func DockerImageName added in v0.0.8 

func DockerImageName(projectDir string) string

DockerImageName returns the default Docker image name for images

func GetProjectDir 

func GetProjectDir(configFilename string) (string, error)

Returns the project's root directory, or the directory specified by the --project-dir flag

func Validate added in v0.0.19 

func Validate(yamlConfig string, version string) error

func ValidateConfig added in v0.0.19 

func ValidateConfig(config *Config, version string) error

func ValidateCudaVersion added in v0.9.10 

func ValidateCudaVersion(cudaVersion string) error

func ValidateModelPythonVersion added in v0.9.6 

func ValidateModelPythonVersion(cfg *Config) error

func ValidateSchema added in v0.0.19 

func ValidateSchema(schemaLoader, dataLoader gojsonschema.JSONLoader) error

Types

type ArgumentType added in v0.0.8 

type ArgumentType string
const (
	ArgumentTypeString ArgumentType = "str"
	ArgumentTypeInt    ArgumentType = "int"
	ArgumentTypeFloat  ArgumentType = "float"
	ArgumentTypeBool   ArgumentType = "bool"
	ArgumentTypePath   ArgumentType = "Path"
)

type Build added in v0.0.8 

type Build struct {
	GPU                bool      `json:"gpu,omitempty" yaml:"gpu,omitempty"`
	PythonVersion      string    `json:"python_version,omitempty" yaml:"python_version"`
	PythonRequirements string    `json:"python_requirements,omitempty" yaml:"python_requirements,omitempty"`
	PythonPackages     []string  `json:"python_packages,omitempty" yaml:"python_packages,omitempty"` // Deprecated, but included for backwards compatibility
	Run                []RunItem `json:"run,omitempty" yaml:"run,omitempty"`
	SystemPackages     []string  `json:"system_packages,omitempty" yaml:"system_packages,omitempty"`
	PreInstall         []string  `json:"pre_install,omitempty" yaml:"pre_install,omitempty"` // Deprecated, but included for backwards compatibility
	CUDA               string    `json:"cuda,omitempty" yaml:"cuda,omitempty"`
	CuDNN              string    `json:"cudnn,omitempty" yaml:"cudnn,omitempty"`
	Fast               bool      `json:"fast,omitempty" yaml:"fast,omitempty"`
	CogRuntime         *bool     `json:"cog_runtime,omitempty" yaml:"cog_runtime,omitempty"`
	PythonOverrides    string    `json:"python_overrides,omitempty" yaml:"python_overrides,omitempty"`
	// contains filtered or unexported fields
}

type CUDABaseImage added in v0.0.8 

type CUDABaseImage struct {
	Tag     string
	CUDA    string
	CuDNN   string
	IsDevel bool
	Ubuntu  string
}

func (*CUDABaseImage) ImageTag added in v0.0.8 

func (i *CUDABaseImage) ImageTag() string

type Concurrency added in v0.13.7 

type Concurrency struct {
	Max int `json:"max,omitempty" yaml:"max"`
}

type Config added in v0.0.8 

type Config struct {
	Build       *Build       `json:"build" yaml:"build"`
	Image       string       `json:"image,omitempty" yaml:"image,omitempty"`
	Predict     string       `json:"predict,omitempty" yaml:"predict"`
	Train       string       `json:"train,omitempty" yaml:"train,omitempty"`
	Concurrency *Concurrency `json:"concurrency,omitempty" yaml:"concurrency,omitempty"`
	Environment []string     `json:"environment,omitempty" yaml:"environment,omitempty"`
	// contains filtered or unexported fields
}

func DefaultConfig added in v0.0.8 

func DefaultConfig() *Config

func FromYAML added in v0.0.16 

func FromYAML(contents []byte) (*Config, error)

func GetConfig 

func GetConfig(configFilename string) (*Config, string, error)

Loads and instantiates a Config object customDir can be specified to override the default - current working directory

func GetRawConfig added in v0.14.9 

func GetRawConfig(configFilename string) (*Config, string, error)

func (*Config) CUDABaseImageTag added in v0.0.8 

func (c *Config) CUDABaseImageTag() (string, error)

func (*Config) ContainsCoglet added in v0.15.10 

func (c *Config) ContainsCoglet() bool

func (*Config) Filename added in v0.16.3 

func (c *Config) Filename() string

func (*Config) ParsedEnvironment added in v0.14.9 

func (c *Config) ParsedEnvironment() map[string]string

func (*Config) PythonRequirementsForArch added in v0.5.0 

func (c *Config) PythonRequirementsForArch(goos string, goarch string, includePackages []string) (string, error)

PythonRequirementsForArch returns a requirements.txt file with all the GPU packages resolved for given OS and architecture.

func (*Config) RequirementsFile added in v0.15.2 

func (c *Config) RequirementsFile(projectDir string) string

func (*Config) TensorFlowVersion added in v0.9.7 

func (c *Config) TensorFlowVersion() (string, bool)

func (*Config) TorchVersion added in v0.9.7 

func (c *Config) TorchVersion() (string, bool)

func (*Config) TorchaudioVersion added in v0.9.21 

func (c *Config) TorchaudioVersion() (string, bool)

func (*Config) TorchvisionVersion added in v0.9.7 

func (c *Config) TorchvisionVersion() (string, bool)

func (*Config) ValidateAndComplete added in v0.5.0 

func (c *Config) ValidateAndComplete(projectDir string) error

type Example added in v0.0.8 

type Example struct {
	Input  map[string]string `json:"input" yaml:"input"`
	Output string            `json:"output" yaml:"output"`
}

type Image added in v0.0.8 

type Image struct {
	URI          string                  `json:"uri"`
	Created      time.Time               `json:"created"`
	RunArguments map[string]*RunArgument `json:"run_arguments"`
	TestStats    *Stats                  `json:"test_stats"`
	BuildFailed  bool                    `json:"build_failed"`
}

type RunArgument added in v0.0.8 

type RunArgument struct {
	Type    ArgumentType `json:"type"`
	Default *string      `json:"default"`
	Min     *string      `json:"min"`
	Max     *string      `json:"max"`
	Options *[]string    `json:"options"`
	Help    *string      `json:"help"`
}

type RunItem added in v0.7.0 

type RunItem struct {
	Command string `json:"command,omitempty" yaml:"command"`
	Mounts  []struct {
		Type   string `json:"type,omitempty" yaml:"type"`
		ID     string `json:"id,omitempty" yaml:"id"`
		Target string `json:"target,omitempty" yaml:"target"`
	} `json:"mounts,omitempty" yaml:"mounts,omitempty"`
}

func (*RunItem) UnmarshalJSON added in v0.7.1 

func (r *RunItem) UnmarshalJSON(data []byte) error

func (*RunItem) UnmarshalYAML added in v0.7.0 

func (r *RunItem) UnmarshalYAML(unmarshal func(interface{}) error) error

type Stats added in v0.0.8 

type Stats struct {
	BootTime    float64 `json:"boot_time"`
	SetupTime   float64 `json:"setup_time"`
	RunTime     float64 `json:"run_time"`
	MemoryUsage uint64  `json:"memory_usage"`
	CPUUsage    float64 `json:"cpu_usage"`
}

type TFCompatibility added in v0.0.8 

type TFCompatibility struct {
	TF           string
	TFCPUPackage string
	TFGPUPackage string
	CUDA         string
	CuDNN        string
	Pythons      []string
}

func (*TFCompatibility) UnmarshalJSON added in v0.0.8 

func (compat *TFCompatibility) UnmarshalJSON(data []byte) error

type TorchCompatibility added in v0.0.8 

type TorchCompatibility struct {
	Torch         string
	Torchvision   string
	Torchaudio    string
	FindLinks     string
	ExtraIndexURL string
	CUDA          *string
	Pythons       []string
}

func (*TorchCompatibility) TorchVersion added in v0.0.8 

func (c *TorchCompatibility) TorchVersion() string

func (*TorchCompatibility) TorchvisionVersion added in v0.0.8 

func (c *TorchCompatibility) TorchvisionVersion() string

type Version added in v0.0.8 

type Version struct {
	ID       string            `json:"id"`
	Config   *Config           `json:"config"`
	Created  time.Time         `json:"created"`
	BuildIDs map[string]string `json:"build_ids"`
}

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.