Documentation ¶
Index ¶
- Constants
- type AppError
- type Configuration
- type Endpoints
- type Error
- type IPythonNotebook
- type Image
- type Job
- type JobDetail
- type JobFile
- type JobFiles
- type JobLog
- type JobLogs
- type NgcImage
- type Notebook
- type NotebookDetail
- type Repository
- type RescaleApplication
- type RescaleApplicationVersion
- type RescaleCoreType
- type RescaleCoreTypeResources
- type Session
- type Version
- type Versions
- type Workspace
Constants ¶
const ( // ConfigurationMustSignedInYes captures enum value "yes" ConfigurationMustSignedInYes string = "yes" // ConfigurationMustSignedInNo captures enum value "no" ConfigurationMustSignedInNo string = "no" )
const ( // ConfigurationRescalePlatformHTTPSPlatformRescaleCom captures enum value "https://platform.rescale.com" ConfigurationRescalePlatformHTTPSPlatformRescaleCom string = "https://platform.rescale.com" // ConfigurationRescalePlatformHTTPSPlatformRescaleJp captures enum value "https://platform.rescale.jp" ConfigurationRescalePlatformHTTPSPlatformRescaleJp string = "https://platform.rescale.jp" // ConfigurationRescalePlatformHTTPSKrRescaleCom captures enum value "https://kr.rescale.com" ConfigurationRescalePlatformHTTPSKrRescaleCom string = "https://kr.rescale.com" // ConfigurationRescalePlatformHTTPSEuRescaleCom captures enum value "https://eu.rescale.com" ConfigurationRescalePlatformHTTPSEuRescaleCom string = "https://eu.rescale.com" )
const ( // ConfigurationUseK8sYes captures enum value "yes" ConfigurationUseK8sYes string = "yes" // ConfigurationUseK8sNo captures enum value "no" ConfigurationUseK8sNo string = "no" )
const ( // ConfigurationUseNgcYes captures enum value "yes" ConfigurationUseNgcYes string = "yes" // ConfigurationUseNgcNo captures enum value "no" ConfigurationUseNgcNo string = "no" )
const ( // ConfigurationUsePrivateRegistryYes captures enum value "yes" ConfigurationUsePrivateRegistryYes string = "yes" // ConfigurationUsePrivateRegistryNo captures enum value "no" ConfigurationUsePrivateRegistryNo string = "no" )
const ( // ConfigurationUseRescaleYes captures enum value "yes" ConfigurationUseRescaleYes string = "yes" // ConfigurationUseRescaleNo captures enum value "no" ConfigurationUseRescaleNo string = "no" )
const ( // JobPlatformKubernetes captures enum value "kubernetes" JobPlatformKubernetes string = "kubernetes" // JobPlatformRescale captures enum value "rescale" JobPlatformRescale string = "rescale" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppError ¶
type AppError struct { // caption // Required: true Caption *string `json:"caption"` // condition Condition string `json:"condition,omitempty"` // detail Detail string `json:"detail,omitempty"` // when it happened // Format: date-time OccursAt strfmt.DateTime `json:"occursAt,omitempty"` // owner Owner string `json:"owner,omitempty"` }
AppError Application Error
swagger:model AppError
func (*AppError) MarshalBinary ¶
MarshalBinary interface implementation
func (*AppError) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Configuration ¶
type Configuration struct { // Hostname for the private Docker registry DockerHostname string `json:"docker_hostname,omitempty"` // Fist 3 chars of the password of the private Docker registry DockerPassword string `json:"docker_password,omitempty"` // Docker Registry endpoint DockerRegistry string `json:"docker_registry,omitempty"` // Username for the private Docker registry DockerUsername string `json:"docker_username,omitempty"` // kubecfg K8sConfig string `json:"k8s_config,omitempty"` // Number of the host GPUs // Required: true LocalGpus *int64 `json:"local_gpus"` // Number of GPUs per container // Required: true LocalGpusPerContainer *int64 `json:"local_gpus_per_container"` // Users should be signed in // Required: true // Enum: [yes no] MustSignedIn *string `json:"must_signed_in"` // Fist 5 chars of NGC API Key NgcApikey string `json:"ngc_apikey,omitempty"` // E-mail address for NGC console // Format: email NgcEmail strfmt.Email `json:"ngc_email,omitempty"` // Fist 3 chars of the password for NGC console NgcPassword string `json:"ngc_password,omitempty"` // Fist 5 chars of Rescal API Key RescaleKey string `json:"rescale_key,omitempty"` // rescale platform // Enum: [https://platform.rescale.com https://platform.rescale.jp https://kr.rescale.com https://eu.rescale.com] RescalePlatform string `json:"rescale_platform,omitempty"` // Kubernetes will be used or not // Enum: [yes no] UseK8s string `json:"use_k8s,omitempty"` // NGC will be used or not // Enum: [yes no] UseNgc string `json:"use_ngc,omitempty"` // Private registry will be used or not // Enum: [yes no] UsePrivateRegistry string `json:"use_private_registry,omitempty"` // Rescale will be used or not // Enum: [yes no] UseRescale string `json:"use_rescale,omitempty"` }
Configuration app's configurations
swagger:model Configuration
func (*Configuration) MarshalBinary ¶
func (m *Configuration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Configuration) UnmarshalBinary ¶
func (m *Configuration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Endpoints ¶
type Endpoints struct { // The endpoint for private docker registry DockerRegistry string `json:"docker_registry,omitempty"` // The endpoint for Kubernetes API KubernetesAPI string `json:"kubernetes_api,omitempty"` // The endpoint for NGC registry NgcRegistry string `json:"ngc_registry,omitempty"` // The endpoint for Rescale API RescaleAPI string `json:"rescale_api,omitempty"` }
Endpoints third-party endpoints
swagger:model Endpoints
func (*Endpoints) MarshalBinary ¶
MarshalBinary interface implementation
func (*Endpoints) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Error ¶
type Error struct { // code // Required: true Code *string `json:"code"` // message // Required: true Message *string `json:"message"` }
Error error
swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type IPythonNotebook ¶
type IPythonNotebook struct { // file name // Required: true Name *string `json:"name"` }
IPythonNotebook .ipynb file attributes
swagger:model IPythonNotebook
func (*IPythonNotebook) MarshalBinary ¶
func (m *IPythonNotebook) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IPythonNotebook) UnmarshalBinary ¶
func (m *IPythonNotebook) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Image ¶
type Image struct { // created unix timestamp Created string `json:"created,omitempty"` // the image ID // Required: true ID *string `json:"id"` // the image parent ID ParentID string `json:"parentID,omitempty"` // the image digests RepoDigests []string `json:"repoDigests"` // the image name/tag // Required: true RepoTags []string `json:"repoTags"` // size of the image Size int64 `json:"size,omitempty"` // status of the image Status string `json:"status,omitempty"` // virtual size of the image VirtualSize int64 `json:"virtualSize,omitempty"` }
Image docker image information
swagger:model Image
func (*Image) MarshalBinary ¶
MarshalBinary interface implementation
func (*Image) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Job ¶
type Job struct { // the container labels Commands []string `json:"commands"` // ended unix timestamp // Format: date-time Ended strfmt.DateTime `json:"ended,omitempty"` // A link to an external status page ExternalLink string `json:"external_link,omitempty"` // Job ID // Required: true ID *string `json:"id"` // the image ID Image string `json:"image,omitempty"` // the container labels Mounts []string `json:"mounts"` // platform // Enum: [kubernetes rescale] Platform string `json:"platform,omitempty"` // started unix timestamp // Format: date-time Started strfmt.DateTime `json:"started,omitempty"` // the status of the job Status string `json:"status,omitempty"` }
Job Rescale Job information
swagger:model Job
func (*Job) MarshalBinary ¶
MarshalBinary interface implementation
func (*Job) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JobDetail ¶
JobDetail the details of a job
swagger:model JobDetail
func (*JobDetail) MarshalBinary ¶
MarshalBinary interface implementation
func (JobDetail) MarshalJSON ¶
MarshalJSON marshals this object to a JSON structure
func (*JobDetail) UnmarshalBinary ¶
UnmarshalBinary interface implementation
func (*JobDetail) UnmarshalJSON ¶
UnmarshalJSON unmarshals this object from a JSON structure
type JobFile ¶
type JobFile struct { // download URL DownloadURL string `json:"downloadURL,omitempty"` // name // Required: true Name *string `json:"name"` // size // Required: true Size *int64 `json:"size"` }
JobFile the output file
swagger:model JobFile
func (*JobFile) MarshalBinary ¶
MarshalBinary interface implementation
func (*JobFile) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JobFiles ¶
type JobFiles struct { // api token APIToken string `json:"apiToken,omitempty"` // files // Required: true Files []*JobFile `json:"files"` }
JobFiles the output files
swagger:model JobFiles
func (*JobFiles) MarshalBinary ¶
MarshalBinary interface implementation
func (*JobFiles) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JobLog ¶
type JobLog struct { // log // Required: true Log *string `json:"log"` // time // Format: date-time Time strfmt.DateTime `json:"time,omitempty"` }
JobLog the log structure
swagger:model JobLog
func (*JobLog) MarshalBinary ¶
MarshalBinary interface implementation
func (*JobLog) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JobLogs ¶
type JobLogs struct { // logs // Required: true Logs []*JobLog `json:"logs"` }
JobLogs the log structure
swagger:model JobLogs
func (*JobLogs) MarshalBinary ¶
MarshalBinary interface implementation
func (*JobLogs) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NgcImage ¶
type NgcImage struct { // the image size // Required: true Size *int64 `json:"size"` // the image tag // Required: true Tag *string `json:"tag"` // updated unix timestamp // Required: true // Format: date-time Updated *strfmt.DateTime `json:"updated"` }
NgcImage NGC docker image information
swagger:model NgcImage
func (*NgcImage) MarshalBinary ¶
MarshalBinary interface implementation
func (*NgcImage) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Notebook ¶
type Notebook struct { // the number of NVIDIA GPUs Gpus string `json:"gpus,omitempty"` // the container ID // Required: true ID *string `json:"id"` // the image ID // Required: true Image *string `json:"image"` // the container name // Required: true Name *string `json:"name"` // the container published port Port int64 `json:"port,omitempty"` // started unix timestamp // Format: date-time Started strfmt.DateTime `json:"started,omitempty"` // state of the container State string `json:"state,omitempty"` }
Notebook Jupyter notebook information
swagger:model Notebook
func (*Notebook) MarshalBinary ¶
MarshalBinary interface implementation
func (*Notebook) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NotebookDetail ¶
type NotebookDetail struct { // ended unix timestamp // Format: date-time Ended strfmt.DateTime `json:"ended,omitempty"` // the container ID // Required: true ID *string `json:"id"` // the container labels Mounts []string `json:"mounts"` // the container name Name string `json:"name,omitempty"` // the container published port Port int64 `json:"port,omitempty"` // started unix timestamp // Format: date-time Started strfmt.DateTime `json:"started,omitempty"` // state of the container State string `json:"state,omitempty"` // Jupyter notebook's login token // Required: true Token *string `json:"token"` }
NotebookDetail Rescale Job information
swagger:model NotebookDetail
func (*NotebookDetail) MarshalBinary ¶
func (m *NotebookDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NotebookDetail) UnmarshalBinary ¶
func (m *NotebookDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Repository ¶
type Repository struct { // the image description Description string `json:"description,omitempty"` // the image name // Required: true Name *string `json:"name"` // the repositry's namespace // Required: true Namespace *string `json:"namespace"` }
Repository docker image information
swagger:model Repository
func (*Repository) MarshalBinary ¶
func (m *Repository) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Repository) UnmarshalBinary ¶
func (m *Repository) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RescaleApplication ¶
type RescaleApplication struct { // code // Required: true Code *string `json:"code"` // versions Versions []*RescaleApplicationVersion `json:"versions"` }
RescaleApplication Rescale Application
swagger:model RescaleApplication
func (*RescaleApplication) MarshalBinary ¶
func (m *RescaleApplication) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RescaleApplication) UnmarshalBinary ¶
func (m *RescaleApplication) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RescaleApplicationVersion ¶
type RescaleApplicationVersion struct { // code // Required: true Code *string `json:"code"` // supported CoreTypes Coretypes []string `json:"coretypes"` // id // Required: true ID *string `json:"id"` // version // Required: true Version *string `json:"version"` }
RescaleApplicationVersion version of Rescale Applications
swagger:model RescaleApplicationVersion
func (*RescaleApplicationVersion) MarshalBinary ¶
func (m *RescaleApplicationVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RescaleApplicationVersion) UnmarshalBinary ¶
func (m *RescaleApplicationVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RescaleCoreType ¶
type RescaleCoreType struct { // base clock BaseClock string `json:"baseClock,omitempty"` // code // Required: true Code *string `json:"code"` // interconnect Interconnect string `json:"interconnect,omitempty"` // name // Required: true Name *string `json:"name"` // processor Processor string `json:"processor,omitempty"` // resources Resources []*RescaleCoreTypeResources `json:"resources"` }
RescaleCoreType Rescale CoreType
swagger:model RescaleCoreType
func (*RescaleCoreType) MarshalBinary ¶
func (m *RescaleCoreType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RescaleCoreType) UnmarshalBinary ¶
func (m *RescaleCoreType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RescaleCoreTypeResources ¶
type RescaleCoreTypeResources struct { // the number of CPU cores // Required: true Cores *int64 `json:"cores"` // the number of GPUs // Required: true Gpus *int64 `json:"gpus"` }
RescaleCoreTypeResources CPU/GPU cores
swagger:model RescaleCoreTypeResources
func (*RescaleCoreTypeResources) MarshalBinary ¶
func (m *RescaleCoreTypeResources) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RescaleCoreTypeResources) UnmarshalBinary ¶
func (m *RescaleCoreTypeResources) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Session ¶
type Session struct { // API Token // Required: true Token *string `json:"token"` }
Session docker image information
swagger:model Session
func (*Session) MarshalBinary ¶
MarshalBinary interface implementation
func (*Session) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Version ¶
type Version struct { // date which this app was built at BuildDate string `json:"build_date,omitempty"` // version name // Required: true Version *string `json:"version"` }
Version application version
swagger:model Version
func (*Version) MarshalBinary ¶
MarshalBinary interface implementation
func (*Version) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Versions ¶
type Versions struct { // Current running service version // Required: true Current *Version `json:"current"` // The latest application version which can be installed // Required: true Latest *Version `json:"latest"` }
Versions application versions
swagger:model Versions
func (*Versions) MarshalBinary ¶
MarshalBinary interface implementation
func (*Versions) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Workspace ¶
type Workspace struct { // absolute path AbsolutePath string `json:"absolute_path,omitempty"` // Jobs which are mounting the workspace Jobs []string `json:"jobs"` // Notebooks which are mounting the workspace Notebooks []string `json:"notebooks"` // path // Required: true Path *string `json:"path"` }
Workspace User's workspace
swagger:model Workspace
func (*Workspace) MarshalBinary ¶
MarshalBinary interface implementation
func (*Workspace) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files ¶
- app_error.go
- configuration.go
- endpoints.go
- error.go
- i_python_notebook.go
- image.go
- job.go
- job_detail.go
- job_file.go
- job_files.go
- job_log.go
- job_logs.go
- ngc_image.go
- notebook.go
- notebook_detail.go
- repository.go
- rescale_application.go
- rescale_application_version.go
- rescale_core_type.go
- rescale_core_type_resources.go
- session.go
- version.go
- versions.go
- workspace.go