notebook

Documentation

Index

• func GetNotebookImageOptions(flavor string) types.ImageOptions
• func GetNotebookName(manifestPath string) string
• func NotebookService(remoteName string, manifestPath string, s3AccessKey string, ...) types.INotebookService
• type LocalNotebookService
  • func (s LocalNotebookService) CopyFile(srcPath string, dstPath string)
  • func (s LocalNotebookService) DownloadHyperpack()
  • func (s LocalNotebookService) FileExists(filepath string) bool
  • func (s LocalNotebookService) GetHyperpackArtifactPath() string
  • func (s LocalNotebookService) GetHyperpackSavePath() string
  • func (s LocalNotebookService) GetJobsPath() 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(jupyterOptions types.JupyterLaunchOptions, _ types.EC2StartOptions, ...)
  • 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(jupyterOptions types.JupyterLaunchOptions, ec2Options types.EC2StartOptions, ...)
  • func (s RemoteNotebookService) Stop(identifier string)
  • func (s RemoteNotebookService) UploadTrainingJobData()
  • func (s RemoteNotebookService) WaitForTrainingToComplete(timeout int)
• type TrainingStatus

Functions

func GetNotebookImageOptions

func GetNotebookImageOptions(flavor string) types.ImageOptions

func GetNotebookName

func GetNotebookName(manifestPath string) string

func NotebookService

func NotebookService(remoteName string, manifestPath string, s3AccessKey string, s3AccessSecret string, s3Region string) types.INotebookService

Types

type LocalNotebookService

type LocalNotebookService struct {
	ManifestPath  string
	S3Credentials types.S3Credentials
}

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) GetHyperpackArtifactPath

func (s LocalNotebookService) GetHyperpackArtifactPath() string

func (LocalNotebookService) GetHyperpackSavePath

func (s LocalNotebookService) GetHyperpackSavePath() string

func (LocalNotebookService) GetJobsPath

func (s LocalNotebookService) GetJobsPath() 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(jupyterOptions types.JupyterLaunchOptions, _ types.EC2StartOptions, _ types.WorkspaceSyncOptions)

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 types.ComputeRemoteConfiguration
	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(jupyterOptions types.JupyterLaunchOptions, ec2Options types.EC2StartOptions, syncOptions types.WorkspaceSyncOptions)

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"
)