client

Documentation

Index

• type Client
  • func MakeClient(logger *zap.Logger, psUrl string) *Client
  • func (c *Client) JobFinished(jobId string, exitErr error) error
  • func (c *Client) ListTasks() ([]byte, error)
  • func (c *Client) StartTask(task *api.TrainTask) error
  • func (c *Client) StopTask(id string) error
  • func (c *Client) UpdateMetrics(jobId string, update *api.MetricUpdate) error
  • func (c *Client) UpdateTask(task *api.TrainTask) error

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func MakeClient

func MakeClient(logger *zap.Logger, psUrl string) *Client

MakeClient creates a client for the parameterServer

func (*Client) JobFinished

func (c *Client) JobFinished(jobId string, exitErr error) error

JobFinished communicates to the parameter server that a job has finished. The PS will then clear its index, metrics and also communicate with the Scheduler

func (*Client) ListTasks

func (c *Client) ListTasks() ([]byte, error)

ListTasks returns the response of the tasks in a byte format since the usage will only be internally, the controller will just redirect the bytes to the requester

func (*Client) StartTask

func (c *Client) StartTask(task *api.TrainTask) error

StartTask sends a new task to the parameter server

func (*Client) StopTask

func (c *Client) StopTask(id string) error

StopTask stops the task given the task id

func (*Client) UpdateMetrics

func (c *Client) UpdateMetrics(jobId string, update *api.MetricUpdate) error

UpdateMetrics sends a new metric set to the parameter server from the Jobs so they can be exposed to prometheus

func (*Client) UpdateTask

func (c *Client) UpdateTask(task *api.TrainTask) error

UpdateTask sends the parameters to the PS for the next epoch of a particular training job