notebook

Documentation

Index

• func GetNotebookName(manifestPath string) string
• type INotebookService
  • func NotebookService(remoteName string, manifestPath string) INotebookService
• type ImageOptions
  • func GetNotebookImageOptions(flavor string) ImageOptions
• type LocalNotebookService
  • func (s LocalNotebookService) CopyFile(srcPath string, dstPath string)
  • func (s LocalNotebookService) DownloadHyperpack()
  • func (s LocalNotebookService) FileExists(filepath string) bool
  • func (s LocalNotebookService) GetGitRoot() string
  • func (s LocalNotebookService) GetHyperpackSavePath() string
  • func (s LocalNotebookService) GetRemoteHyperpackPath() string
  • func (s LocalNotebookService) GetServerPath(rootPath string) string
  • func (s LocalNotebookService) GetStudyRoot() string
  • func (s LocalNotebookService) GetTrainingStatus(studyDir string) TrainingStatus
  • func (s LocalNotebookService) List()
  • func (s LocalNotebookService) Start(flavor string, pullImage bool, jupyterBrowser bool)
  • func (s LocalNotebookService) Stop(mountPoint string)
  • func (s LocalNotebookService) UploadTrainingJobData()
  • func (s LocalNotebookService) WaitForTrainingToComplete(timeout int)
• type RemoteNotebookService
  • func (s RemoteNotebookService) DownloadHyperpack()
  • func (s RemoteNotebookService) GetHyperpackSavePath() string
  • func (s RemoteNotebookService) GetRemoteHyperpackPath() string
  • func (s RemoteNotebookService) GetStudyRoot() string
  • func (s RemoteNotebookService) List()
  • func (s RemoteNotebookService) Start(flavor string, pullImage bool, jupyterBrowser bool)
  • func (s RemoteNotebookService) Stop(identifier string)
  • func (s RemoteNotebookService) UploadTrainingJobData()
  • func (s RemoteNotebookService) WaitForTrainingToComplete(timeout int)
• type TrainingStatus

Functions

func GetNotebookName

func GetNotebookName(manifestPath string) string

Types

type INotebookService

type INotebookService interface {
	Start(image string, pullImage bool, jupyterBrowser bool)
	List()
	Stop(mountPointOrIdentifier string)
	UploadTrainingJobData()
	WaitForTrainingToComplete(timeout int)
	DownloadHyperpack()
}

func NotebookService

func NotebookService(remoteName string, manifestPath string) INotebookService

type ImageOptions

type ImageOptions struct {
	Image   string
	RepoTag string
	Profile string
}

func GetNotebookImageOptions

func GetNotebookImageOptions(flavor string) ImageOptions

type LocalNotebookService

type LocalNotebookService struct {
	ManifestPath string
}

func (LocalNotebookService) CopyFile

func (s LocalNotebookService) CopyFile(srcPath string, dstPath string)

func (LocalNotebookService) DownloadHyperpack

func (s LocalNotebookService) DownloadHyperpack()

func (LocalNotebookService) FileExists

func (s LocalNotebookService) FileExists(filepath string) bool

func (LocalNotebookService) GetGitRoot

func (s LocalNotebookService) GetGitRoot() string

func (LocalNotebookService) GetHyperpackSavePath

func (s LocalNotebookService) GetHyperpackSavePath() string

func (LocalNotebookService) GetRemoteHyperpackPath

func (s LocalNotebookService) GetRemoteHyperpackPath() string

func (LocalNotebookService) GetServerPath

func (s LocalNotebookService) GetServerPath(rootPath string) string

func (LocalNotebookService) GetStudyRoot

func (s LocalNotebookService) GetStudyRoot() string

func (LocalNotebookService) GetTrainingStatus

func (s LocalNotebookService) GetTrainingStatus(studyDir string) TrainingStatus

func (LocalNotebookService) List

func (s LocalNotebookService) List()

func (LocalNotebookService) Start

func (s LocalNotebookService) Start(flavor string, pullImage bool, jupyterBrowser bool)

func (LocalNotebookService) Stop

func (s LocalNotebookService) Stop(mountPoint string)

func (LocalNotebookService) UploadTrainingJobData

func (s LocalNotebookService) UploadTrainingJobData()

func (LocalNotebookService) WaitForTrainingToComplete

func (s LocalNotebookService) WaitForTrainingToComplete(timeout int)

type RemoteNotebookService

type RemoteNotebookService struct {
	RemoteConfiguration config.RemoteConfiguration
	ManifestPath        string
}

func (RemoteNotebookService) DownloadHyperpack

func (s RemoteNotebookService) DownloadHyperpack()

func (RemoteNotebookService) GetHyperpackSavePath

func (s RemoteNotebookService) GetHyperpackSavePath() string

func (RemoteNotebookService) GetRemoteHyperpackPath

func (s RemoteNotebookService) GetRemoteHyperpackPath() string

func (RemoteNotebookService) GetStudyRoot

func (s RemoteNotebookService) GetStudyRoot() string

func (RemoteNotebookService) List

func (s RemoteNotebookService) List()

func (RemoteNotebookService) Start

func (s RemoteNotebookService) Start(flavor string, pullImage bool, jupyterBrowser bool)

func (RemoteNotebookService) Stop

func (s RemoteNotebookService) Stop(identifier string)

func (RemoteNotebookService) UploadTrainingJobData

func (s RemoteNotebookService) UploadTrainingJobData()

func (RemoteNotebookService) WaitForTrainingToComplete

func (s RemoteNotebookService) WaitForTrainingToComplete(timeout int)

type TrainingStatus

type TrainingStatus string

const (
	TrainingPending  TrainingStatus = "pending"
	TrainingStarted  TrainingStatus = "started"
	TrainingComplete TrainingStatus = "completed"
)