env

Documentation

Index

• Constants
• type Config
  • func ParseConfigFromEnv() (*Config, error)
  • func SingleMachineEnv(rank, size int) (*Config, error)

Constants

const (
	ConfigServerEnvKey       = `KUNGFU_CONFIG_SERVER`
	InitClusterVersionEnvKey = `KUNGFU_INIT_CLUSTER_VERSION`
	ParentIDEnvKey           = `KUNGFU_PARENT_ID`

	PeerListEnvKey          = `KUNGFU_INIT_PEERS`
	RunnerListEnvKey        = `KUNGFU_INIT_RUNNERS`
	SelfSpecEnvKey          = `KUNGFU_SELF_SPEC` // self spec should never change during the life of a process
	AllReduceStrategyEnvKey = `KUNGFU_ALLREDUCE_STRATEGY`

	JobStartTimestamp  = `KUNGFU_JOB_START_TIMESTAMP`
	ProcStartTimestamp = `KUNGFU_PROC_START_TIMESTAMP`

	AllowNvLink = `KUNGFU_ALLOW_NVLINK`
)

Internal environment variables set by kungfu-run, users should not set them.

Types

type Config

type Config struct {
	ConfigServer string
	Parent       plan.PeerID
	InitRunners  plan.PeerList
	Self         plan.PeerID
	Strategy     kb.Strategy

	InitClusterVersion string
	InitPeers          plan.PeerList

	Single bool
}

func ParseConfigFromEnv

func ParseConfigFromEnv() (*Config, error)

func SingleMachineEnv

func SingleMachineEnv(rank, size int) (*Config, error)