job

package
v0.20230918.1102428 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 18, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2022-05-01/job Documentation

The job SDK allows for interaction with the Azure Resource Manager Service machinelearningservices (API Version 2022-05-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2022-05-01/job"

Client Initialization

client := job.NewJobClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: JobClient.Cancel

ctx := context.TODO()
id := job.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "jobValue")

if err := client.CancelThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: JobClient.CreateOrUpdate

ctx := context.TODO()
id := job.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "jobValue")

payload := job.JobBaseResource{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: JobClient.Delete

ctx := context.TODO()
id := job.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "jobValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: JobClient.Get

ctx := context.TODO()
id := job.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "jobValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: JobClient.List

ctx := context.TODO()
id := job.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue")

// alternatively `client.List(ctx, id, job.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, job.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDistributionType

func PossibleValuesForDistributionType() []string

func PossibleValuesForEarlyTerminationPolicyType

func PossibleValuesForEarlyTerminationPolicyType() []string

func PossibleValuesForGoal

func PossibleValuesForGoal() []string

func PossibleValuesForIdentityConfigurationType

func PossibleValuesForIdentityConfigurationType() []string

func PossibleValuesForInputDeliveryMode

func PossibleValuesForInputDeliveryMode() []string

func PossibleValuesForJobInputType

func PossibleValuesForJobInputType() []string

func PossibleValuesForJobLimitsType

func PossibleValuesForJobLimitsType() []string

func PossibleValuesForJobOutputType

func PossibleValuesForJobOutputType() []string

func PossibleValuesForJobStatus

func PossibleValuesForJobStatus() []string

func PossibleValuesForJobType

func PossibleValuesForJobType() []string

func PossibleValuesForListViewType

func PossibleValuesForListViewType() []string

func PossibleValuesForOutputDeliveryMode

func PossibleValuesForOutputDeliveryMode() []string

func PossibleValuesForRandomSamplingAlgorithmRule

func PossibleValuesForRandomSamplingAlgorithmRule() []string

func PossibleValuesForSamplingAlgorithmType

func PossibleValuesForSamplingAlgorithmType() []string

func ValidateJobID

func ValidateJobID(input interface{}, key string) (warnings []string, errors []error)

ValidateJobID checks that 'input' can be parsed as a Job ID

func ValidateWorkspaceID

func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type AmlToken

type AmlToken struct {
}

func (AmlToken) MarshalJSON

func (s AmlToken) MarshalJSON() ([]byte, error)

type BanditPolicy

type BanditPolicy struct {
	SlackAmount *float64 `json:"slackAmount,omitempty"`
	SlackFactor *float64 `json:"slackFactor,omitempty"`

	// Fields inherited from EarlyTerminationPolicy
	DelayEvaluation    *int64 `json:"delayEvaluation,omitempty"`
	EvaluationInterval *int64 `json:"evaluationInterval,omitempty"`
}

func (BanditPolicy) MarshalJSON

func (s BanditPolicy) MarshalJSON() ([]byte, error)

type BayesianSamplingAlgorithm

type BayesianSamplingAlgorithm struct {
}

func (BayesianSamplingAlgorithm) MarshalJSON

func (s BayesianSamplingAlgorithm) MarshalJSON() ([]byte, error)

type CancelOperationResponse

type CancelOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type CommandJob

type CommandJob struct {
	CodeId               *string                   `json:"codeId,omitempty"`
	Command              string                    `json:"command"`
	Distribution         DistributionConfiguration `json:"distribution"`
	EnvironmentId        string                    `json:"environmentId"`
	EnvironmentVariables *map[string]string        `json:"environmentVariables,omitempty"`
	Inputs               *map[string]JobInput      `json:"inputs,omitempty"`
	Limits               JobLimits                 `json:"limits"`
	Outputs              *map[string]JobOutput     `json:"outputs,omitempty"`
	Parameters           *interface{}              `json:"parameters,omitempty"`
	Resources            *ResourceConfiguration    `json:"resources,omitempty"`

	// Fields inherited from JobBase
	ComputeId      *string                `json:"computeId,omitempty"`
	Description    *string                `json:"description,omitempty"`
	DisplayName    *string                `json:"displayName,omitempty"`
	ExperimentName *string                `json:"experimentName,omitempty"`
	Identity       IdentityConfiguration  `json:"identity"`
	IsArchived     *bool                  `json:"isArchived,omitempty"`
	Properties     *map[string]string     `json:"properties,omitempty"`
	Services       *map[string]JobService `json:"services,omitempty"`
	Status         *JobStatus             `json:"status,omitempty"`
	Tags           *map[string]string     `json:"tags,omitempty"`
}

func (CommandJob) MarshalJSON

func (s CommandJob) MarshalJSON() ([]byte, error)

func (*CommandJob) UnmarshalJSON

func (s *CommandJob) UnmarshalJSON(bytes []byte) error

type CommandJobLimits

type CommandJobLimits struct {

	// Fields inherited from JobLimits
	Timeout *string `json:"timeout,omitempty"`
}

func (CommandJobLimits) MarshalJSON

func (s CommandJobLimits) MarshalJSON() ([]byte, error)

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *JobBaseResource
}

type CustomModelJobInput

type CustomModelJobInput struct {
	Mode *InputDeliveryMode `json:"mode,omitempty"`
	Uri  string             `json:"uri"`

	// Fields inherited from JobInput
	Description *string `json:"description,omitempty"`
}

func (CustomModelJobInput) MarshalJSON

func (s CustomModelJobInput) MarshalJSON() ([]byte, error)

type CustomModelJobOutput

type CustomModelJobOutput struct {
	Mode *OutputDeliveryMode `json:"mode,omitempty"`
	Uri  *string             `json:"uri,omitempty"`

	// Fields inherited from JobOutput
	Description *string `json:"description,omitempty"`
}

func (CustomModelJobOutput) MarshalJSON

func (s CustomModelJobOutput) MarshalJSON() ([]byte, error)

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DistributionConfiguration

type DistributionConfiguration interface {
}

type DistributionType

type DistributionType string
const (
	DistributionTypeMpi        DistributionType = "Mpi"
	DistributionTypePyTorch    DistributionType = "PyTorch"
	DistributionTypeTensorFlow DistributionType = "TensorFlow"
)

func (*DistributionType) UnmarshalJSON added in v0.20230713.1092427

func (s *DistributionType) UnmarshalJSON(bytes []byte) error

type EarlyTerminationPolicy

type EarlyTerminationPolicy interface {
}

type EarlyTerminationPolicyType

type EarlyTerminationPolicyType string
const (
	EarlyTerminationPolicyTypeBandit              EarlyTerminationPolicyType = "Bandit"
	EarlyTerminationPolicyTypeMedianStopping      EarlyTerminationPolicyType = "MedianStopping"
	EarlyTerminationPolicyTypeTruncationSelection EarlyTerminationPolicyType = "TruncationSelection"
)

func (*EarlyTerminationPolicyType) UnmarshalJSON added in v0.20230713.1092427

func (s *EarlyTerminationPolicyType) UnmarshalJSON(bytes []byte) error

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *JobBaseResource
}

type Goal

type Goal string
const (
	GoalMaximize Goal = "Maximize"
	GoalMinimize Goal = "Minimize"
)

func (*Goal) UnmarshalJSON added in v0.20230713.1092427

func (s *Goal) UnmarshalJSON(bytes []byte) error

type GridSamplingAlgorithm

type GridSamplingAlgorithm struct {
}

func (GridSamplingAlgorithm) MarshalJSON

func (s GridSamplingAlgorithm) MarshalJSON() ([]byte, error)

type IdentityConfiguration

type IdentityConfiguration interface {
}

type IdentityConfigurationType

type IdentityConfigurationType string
const (
	IdentityConfigurationTypeAMLToken     IdentityConfigurationType = "AMLToken"
	IdentityConfigurationTypeManaged      IdentityConfigurationType = "Managed"
	IdentityConfigurationTypeUserIdentity IdentityConfigurationType = "UserIdentity"
)

func (*IdentityConfigurationType) UnmarshalJSON added in v0.20230713.1092427

func (s *IdentityConfigurationType) UnmarshalJSON(bytes []byte) error

type InputDeliveryMode

type InputDeliveryMode string
const (
	InputDeliveryModeDirect         InputDeliveryMode = "Direct"
	InputDeliveryModeDownload       InputDeliveryMode = "Download"
	InputDeliveryModeEvalDownload   InputDeliveryMode = "EvalDownload"
	InputDeliveryModeEvalMount      InputDeliveryMode = "EvalMount"
	InputDeliveryModeReadOnlyMount  InputDeliveryMode = "ReadOnlyMount"
	InputDeliveryModeReadWriteMount InputDeliveryMode = "ReadWriteMount"
)

func (*InputDeliveryMode) UnmarshalJSON added in v0.20230713.1092427

func (s *InputDeliveryMode) UnmarshalJSON(bytes []byte) error

type JobBase

type JobBase interface {
}

type JobBaseResource

type JobBaseResource struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties JobBase                `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (*JobBaseResource) UnmarshalJSON

func (s *JobBaseResource) UnmarshalJSON(bytes []byte) error

type JobBaseResourceOperationPredicate

type JobBaseResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (JobBaseResourceOperationPredicate) Matches

type JobClient

type JobClient struct {
	Client *resourcemanager.Client
}

func NewJobClientWithBaseURI

func NewJobClientWithBaseURI(sdkApi sdkEnv.Api) (*JobClient, error)

func (JobClient) Cancel

func (c JobClient) Cancel(ctx context.Context, id JobId) (result CancelOperationResponse, err error)

Cancel ...

func (JobClient) CancelThenPoll

func (c JobClient) CancelThenPoll(ctx context.Context, id JobId) error

CancelThenPoll performs Cancel then polls until it's completed

func (JobClient) CreateOrUpdate

func (c JobClient) CreateOrUpdate(ctx context.Context, id JobId, input JobBaseResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (JobClient) Delete

func (c JobClient) Delete(ctx context.Context, id JobId) (result DeleteOperationResponse, err error)

Delete ...

func (JobClient) DeleteThenPoll

func (c JobClient) DeleteThenPoll(ctx context.Context, id JobId) error

DeleteThenPoll performs Delete then polls until it's completed

func (JobClient) Get

func (c JobClient) Get(ctx context.Context, id JobId) (result GetOperationResponse, err error)

Get ...

func (JobClient) List

func (c JobClient) List(ctx context.Context, id WorkspaceId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (JobClient) ListComplete

ListComplete retrieves all the results into a single object

func (JobClient) ListCompleteMatchingPredicate

func (c JobClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options ListOperationOptions, predicate JobBaseResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type JobId

type JobId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	JobName           string
}

JobId is a struct representing the Resource ID for a Job

func NewJobID

func NewJobID(subscriptionId string, resourceGroupName string, workspaceName string, jobName string) JobId

NewJobID returns a new JobId struct

func ParseJobID

func ParseJobID(input string) (*JobId, error)

ParseJobID parses 'input' into a JobId

func ParseJobIDInsensitively

func ParseJobIDInsensitively(input string) (*JobId, error)

ParseJobIDInsensitively parses 'input' case-insensitively into a JobId note: this method should only be used for API response data and not user input

func (JobId) ID

func (id JobId) ID() string

ID returns the formatted Job ID

func (JobId) Segments

func (id JobId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Job ID

func (JobId) String

func (id JobId) String() string

String returns a human-readable description of this Job ID

type JobInput

type JobInput interface {
}

type JobInputType

type JobInputType string
const (
	JobInputTypeCustomModel JobInputType = "custom_model"
	JobInputTypeLiteral     JobInputType = "literal"
	JobInputTypeMlflowModel JobInputType = "mlflow_model"
	JobInputTypeMltable     JobInputType = "mltable"
	JobInputTypeTritonModel JobInputType = "triton_model"
	JobInputTypeUriFile     JobInputType = "uri_file"
	JobInputTypeUriFolder   JobInputType = "uri_folder"
)

func (*JobInputType) UnmarshalJSON added in v0.20230713.1092427

func (s *JobInputType) UnmarshalJSON(bytes []byte) error

type JobLimits

type JobLimits interface {
}

type JobLimitsType

type JobLimitsType string
const (
	JobLimitsTypeCommand JobLimitsType = "Command"
	JobLimitsTypeSweep   JobLimitsType = "Sweep"
)

func (*JobLimitsType) UnmarshalJSON added in v0.20230713.1092427

func (s *JobLimitsType) UnmarshalJSON(bytes []byte) error

type JobOutput

type JobOutput interface {
}

type JobOutputType

type JobOutputType string
const (
	JobOutputTypeCustomModel JobOutputType = "custom_model"
	JobOutputTypeMlflowModel JobOutputType = "mlflow_model"
	JobOutputTypeMltable     JobOutputType = "mltable"
	JobOutputTypeTritonModel JobOutputType = "triton_model"
	JobOutputTypeUriFile     JobOutputType = "uri_file"
	JobOutputTypeUriFolder   JobOutputType = "uri_folder"
)

func (*JobOutputType) UnmarshalJSON added in v0.20230713.1092427

func (s *JobOutputType) UnmarshalJSON(bytes []byte) error

type JobService

type JobService struct {
	Endpoint       *string            `json:"endpoint,omitempty"`
	ErrorMessage   *string            `json:"errorMessage,omitempty"`
	JobServiceType *string            `json:"jobServiceType,omitempty"`
	Port           *int64             `json:"port,omitempty"`
	Properties     *map[string]string `json:"properties,omitempty"`
	Status         *string            `json:"status,omitempty"`
}

type JobStatus

type JobStatus string
const (
	JobStatusCancelRequested JobStatus = "CancelRequested"
	JobStatusCanceled        JobStatus = "Canceled"
	JobStatusCompleted       JobStatus = "Completed"
	JobStatusFailed          JobStatus = "Failed"
	JobStatusFinalizing      JobStatus = "Finalizing"
	JobStatusNotResponding   JobStatus = "NotResponding"
	JobStatusNotStarted      JobStatus = "NotStarted"
	JobStatusPaused          JobStatus = "Paused"
	JobStatusPreparing       JobStatus = "Preparing"
	JobStatusProvisioning    JobStatus = "Provisioning"
	JobStatusQueued          JobStatus = "Queued"
	JobStatusRunning         JobStatus = "Running"
	JobStatusStarting        JobStatus = "Starting"
	JobStatusUnknown         JobStatus = "Unknown"
)

func (*JobStatus) UnmarshalJSON added in v0.20230713.1092427

func (s *JobStatus) UnmarshalJSON(bytes []byte) error

type JobType

type JobType string
const (
	JobTypeCommand  JobType = "Command"
	JobTypePipeline JobType = "Pipeline"
	JobTypeSweep    JobType = "Sweep"
)

func (*JobType) UnmarshalJSON added in v0.20230713.1092427

func (s *JobType) UnmarshalJSON(bytes []byte) error

type ListCompleteResult

type ListCompleteResult struct {
	Items []JobBaseResource
}

type ListOperationOptions

type ListOperationOptions struct {
	JobType      *string
	ListViewType *ListViewType
	Skip         *string
	Tag          *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230713.1092427

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData added in v0.20230713.1092427

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery added in v0.20230713.1092427

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]JobBaseResource
}

type ListViewType

type ListViewType string
const (
	ListViewTypeActiveOnly   ListViewType = "ActiveOnly"
	ListViewTypeAll          ListViewType = "All"
	ListViewTypeArchivedOnly ListViewType = "ArchivedOnly"
)

func (*ListViewType) UnmarshalJSON added in v0.20230713.1092427

func (s *ListViewType) UnmarshalJSON(bytes []byte) error

type LiteralJobInput

type LiteralJobInput struct {
	Value string `json:"value"`

	// Fields inherited from JobInput
	Description *string `json:"description,omitempty"`
}

func (LiteralJobInput) MarshalJSON

func (s LiteralJobInput) MarshalJSON() ([]byte, error)

type MLFlowModelJobInput

type MLFlowModelJobInput struct {
	Mode *InputDeliveryMode `json:"mode,omitempty"`
	Uri  string             `json:"uri"`

	// Fields inherited from JobInput
	Description *string `json:"description,omitempty"`
}

func (MLFlowModelJobInput) MarshalJSON

func (s MLFlowModelJobInput) MarshalJSON() ([]byte, error)

type MLFlowModelJobOutput

type MLFlowModelJobOutput struct {
	Mode *OutputDeliveryMode `json:"mode,omitempty"`
	Uri  *string             `json:"uri,omitempty"`

	// Fields inherited from JobOutput
	Description *string `json:"description,omitempty"`
}

func (MLFlowModelJobOutput) MarshalJSON

func (s MLFlowModelJobOutput) MarshalJSON() ([]byte, error)

type MLTableJobInput

type MLTableJobInput struct {
	Mode *InputDeliveryMode `json:"mode,omitempty"`
	Uri  string             `json:"uri"`

	// Fields inherited from JobInput
	Description *string `json:"description,omitempty"`
}

func (MLTableJobInput) MarshalJSON

func (s MLTableJobInput) MarshalJSON() ([]byte, error)

type MLTableJobOutput

type MLTableJobOutput struct {
	Mode *OutputDeliveryMode `json:"mode,omitempty"`
	Uri  *string             `json:"uri,omitempty"`

	// Fields inherited from JobOutput
	Description *string `json:"description,omitempty"`
}

func (MLTableJobOutput) MarshalJSON

func (s MLTableJobOutput) MarshalJSON() ([]byte, error)

type ManagedIdentity

type ManagedIdentity struct {
	ClientId   *string `json:"clientId,omitempty"`
	ObjectId   *string `json:"objectId,omitempty"`
	ResourceId *string `json:"resourceId,omitempty"`
}

func (ManagedIdentity) MarshalJSON

func (s ManagedIdentity) MarshalJSON() ([]byte, error)

type MedianStoppingPolicy

type MedianStoppingPolicy struct {

	// Fields inherited from EarlyTerminationPolicy
	DelayEvaluation    *int64 `json:"delayEvaluation,omitempty"`
	EvaluationInterval *int64 `json:"evaluationInterval,omitempty"`
}

func (MedianStoppingPolicy) MarshalJSON

func (s MedianStoppingPolicy) MarshalJSON() ([]byte, error)

type Mpi

type Mpi struct {
	ProcessCountPerInstance *int64 `json:"processCountPerInstance,omitempty"`
}

func (Mpi) MarshalJSON

func (s Mpi) MarshalJSON() ([]byte, error)

type Objective

type Objective struct {
	Goal          Goal   `json:"goal"`
	PrimaryMetric string `json:"primaryMetric"`
}

type OutputDeliveryMode

type OutputDeliveryMode string
const (
	OutputDeliveryModeReadWriteMount OutputDeliveryMode = "ReadWriteMount"
	OutputDeliveryModeUpload         OutputDeliveryMode = "Upload"
)

func (*OutputDeliveryMode) UnmarshalJSON added in v0.20230713.1092427

func (s *OutputDeliveryMode) UnmarshalJSON(bytes []byte) error

type PipelineJob

type PipelineJob struct {
	Inputs   *map[string]JobInput    `json:"inputs,omitempty"`
	Jobs     *map[string]interface{} `json:"jobs,omitempty"`
	Outputs  *map[string]JobOutput   `json:"outputs,omitempty"`
	Settings *interface{}            `json:"settings,omitempty"`

	// Fields inherited from JobBase
	ComputeId      *string                `json:"computeId,omitempty"`
	Description    *string                `json:"description,omitempty"`
	DisplayName    *string                `json:"displayName,omitempty"`
	ExperimentName *string                `json:"experimentName,omitempty"`
	Identity       IdentityConfiguration  `json:"identity"`
	IsArchived     *bool                  `json:"isArchived,omitempty"`
	Properties     *map[string]string     `json:"properties,omitempty"`
	Services       *map[string]JobService `json:"services,omitempty"`
	Status         *JobStatus             `json:"status,omitempty"`
	Tags           *map[string]string     `json:"tags,omitempty"`
}

func (PipelineJob) MarshalJSON

func (s PipelineJob) MarshalJSON() ([]byte, error)

func (*PipelineJob) UnmarshalJSON

func (s *PipelineJob) UnmarshalJSON(bytes []byte) error

type PyTorch

type PyTorch struct {
	ProcessCountPerInstance *int64 `json:"processCountPerInstance,omitempty"`
}

func (PyTorch) MarshalJSON

func (s PyTorch) MarshalJSON() ([]byte, error)

type RandomSamplingAlgorithm

type RandomSamplingAlgorithm struct {
	Rule *RandomSamplingAlgorithmRule `json:"rule,omitempty"`
	Seed *int64                       `json:"seed,omitempty"`
}

func (RandomSamplingAlgorithm) MarshalJSON

func (s RandomSamplingAlgorithm) MarshalJSON() ([]byte, error)

type RandomSamplingAlgorithmRule

type RandomSamplingAlgorithmRule string
const (
	RandomSamplingAlgorithmRuleRandom RandomSamplingAlgorithmRule = "Random"
	RandomSamplingAlgorithmRuleSobol  RandomSamplingAlgorithmRule = "Sobol"
)

func (*RandomSamplingAlgorithmRule) UnmarshalJSON added in v0.20230713.1092427

func (s *RandomSamplingAlgorithmRule) UnmarshalJSON(bytes []byte) error

type RawDistributionConfigurationImpl added in v0.20230807.1063129

type RawDistributionConfigurationImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawEarlyTerminationPolicyImpl added in v0.20230807.1063129

type RawEarlyTerminationPolicyImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawIdentityConfigurationImpl added in v0.20230807.1063129

type RawIdentityConfigurationImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawJobBaseImpl added in v0.20230807.1063129

type RawJobBaseImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawJobInputImpl added in v0.20230807.1063129

type RawJobInputImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawJobLimitsImpl added in v0.20230807.1063129

type RawJobLimitsImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawJobOutputImpl added in v0.20230807.1063129

type RawJobOutputImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawSamplingAlgorithmImpl added in v0.20230807.1063129

type RawSamplingAlgorithmImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type ResourceConfiguration

type ResourceConfiguration struct {
	InstanceCount *int64                  `json:"instanceCount,omitempty"`
	InstanceType  *string                 `json:"instanceType,omitempty"`
	Properties    *map[string]interface{} `json:"properties,omitempty"`
}

type SamplingAlgorithm

type SamplingAlgorithm interface {
}

type SamplingAlgorithmType

type SamplingAlgorithmType string
const (
	SamplingAlgorithmTypeBayesian SamplingAlgorithmType = "Bayesian"
	SamplingAlgorithmTypeGrid     SamplingAlgorithmType = "Grid"
	SamplingAlgorithmTypeRandom   SamplingAlgorithmType = "Random"
)

func (*SamplingAlgorithmType) UnmarshalJSON added in v0.20230713.1092427

func (s *SamplingAlgorithmType) UnmarshalJSON(bytes []byte) error

type SweepJob

type SweepJob struct {
	EarlyTermination  EarlyTerminationPolicy `json:"earlyTermination"`
	Inputs            *map[string]JobInput   `json:"inputs,omitempty"`
	Limits            *SweepJobLimits        `json:"limits,omitempty"`
	Objective         Objective              `json:"objective"`
	Outputs           *map[string]JobOutput  `json:"outputs,omitempty"`
	SamplingAlgorithm SamplingAlgorithm      `json:"samplingAlgorithm"`
	SearchSpace       interface{}            `json:"searchSpace"`
	Trial             TrialComponent         `json:"trial"`

	// Fields inherited from JobBase
	ComputeId      *string                `json:"computeId,omitempty"`
	Description    *string                `json:"description,omitempty"`
	DisplayName    *string                `json:"displayName,omitempty"`
	ExperimentName *string                `json:"experimentName,omitempty"`
	Identity       IdentityConfiguration  `json:"identity"`
	IsArchived     *bool                  `json:"isArchived,omitempty"`
	Properties     *map[string]string     `json:"properties,omitempty"`
	Services       *map[string]JobService `json:"services,omitempty"`
	Status         *JobStatus             `json:"status,omitempty"`
	Tags           *map[string]string     `json:"tags,omitempty"`
}

func (SweepJob) MarshalJSON

func (s SweepJob) MarshalJSON() ([]byte, error)

func (*SweepJob) UnmarshalJSON

func (s *SweepJob) UnmarshalJSON(bytes []byte) error

type SweepJobLimits

type SweepJobLimits struct {
	MaxConcurrentTrials *int64  `json:"maxConcurrentTrials,omitempty"`
	MaxTotalTrials      *int64  `json:"maxTotalTrials,omitempty"`
	TrialTimeout        *string `json:"trialTimeout,omitempty"`

	// Fields inherited from JobLimits
	Timeout *string `json:"timeout,omitempty"`
}

func (SweepJobLimits) MarshalJSON

func (s SweepJobLimits) MarshalJSON() ([]byte, error)

type TensorFlow

type TensorFlow struct {
	ParameterServerCount *int64 `json:"parameterServerCount,omitempty"`
	WorkerCount          *int64 `json:"workerCount,omitempty"`
}

func (TensorFlow) MarshalJSON

func (s TensorFlow) MarshalJSON() ([]byte, error)

type TrialComponent

type TrialComponent struct {
	CodeId               *string                   `json:"codeId,omitempty"`
	Command              string                    `json:"command"`
	Distribution         DistributionConfiguration `json:"distribution"`
	EnvironmentId        string                    `json:"environmentId"`
	EnvironmentVariables *map[string]string        `json:"environmentVariables,omitempty"`
	Resources            *ResourceConfiguration    `json:"resources,omitempty"`
}

func (*TrialComponent) UnmarshalJSON

func (s *TrialComponent) UnmarshalJSON(bytes []byte) error

type TritonModelJobInput

type TritonModelJobInput struct {
	Mode *InputDeliveryMode `json:"mode,omitempty"`
	Uri  string             `json:"uri"`

	// Fields inherited from JobInput
	Description *string `json:"description,omitempty"`
}

func (TritonModelJobInput) MarshalJSON

func (s TritonModelJobInput) MarshalJSON() ([]byte, error)

type TritonModelJobOutput

type TritonModelJobOutput struct {
	Mode *OutputDeliveryMode `json:"mode,omitempty"`
	Uri  *string             `json:"uri,omitempty"`

	// Fields inherited from JobOutput
	Description *string `json:"description,omitempty"`
}

func (TritonModelJobOutput) MarshalJSON

func (s TritonModelJobOutput) MarshalJSON() ([]byte, error)

type TruncationSelectionPolicy

type TruncationSelectionPolicy struct {
	TruncationPercentage *int64 `json:"truncationPercentage,omitempty"`

	// Fields inherited from EarlyTerminationPolicy
	DelayEvaluation    *int64 `json:"delayEvaluation,omitempty"`
	EvaluationInterval *int64 `json:"evaluationInterval,omitempty"`
}

func (TruncationSelectionPolicy) MarshalJSON

func (s TruncationSelectionPolicy) MarshalJSON() ([]byte, error)

type UriFileJobInput

type UriFileJobInput struct {
	Mode *InputDeliveryMode `json:"mode,omitempty"`
	Uri  string             `json:"uri"`

	// Fields inherited from JobInput
	Description *string `json:"description,omitempty"`
}

func (UriFileJobInput) MarshalJSON

func (s UriFileJobInput) MarshalJSON() ([]byte, error)

type UriFileJobOutput

type UriFileJobOutput struct {
	Mode *OutputDeliveryMode `json:"mode,omitempty"`
	Uri  *string             `json:"uri,omitempty"`

	// Fields inherited from JobOutput
	Description *string `json:"description,omitempty"`
}

func (UriFileJobOutput) MarshalJSON

func (s UriFileJobOutput) MarshalJSON() ([]byte, error)

type UriFolderJobInput

type UriFolderJobInput struct {
	Mode *InputDeliveryMode `json:"mode,omitempty"`
	Uri  string             `json:"uri"`

	// Fields inherited from JobInput
	Description *string `json:"description,omitempty"`
}

func (UriFolderJobInput) MarshalJSON

func (s UriFolderJobInput) MarshalJSON() ([]byte, error)

type UriFolderJobOutput

type UriFolderJobOutput struct {
	Mode *OutputDeliveryMode `json:"mode,omitempty"`
	Uri  *string             `json:"uri,omitempty"`

	// Fields inherited from JobOutput
	Description *string `json:"description,omitempty"`
}

func (UriFolderJobOutput) MarshalJSON

func (s UriFolderJobOutput) MarshalJSON() ([]byte, error)

type UserIdentity

type UserIdentity struct {
}

func (UserIdentity) MarshalJSON

func (s UserIdentity) MarshalJSON() ([]byte, error)

type WorkspaceId

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

ParseWorkspaceIDInsensitively parses 'input' case-insensitively into a WorkspaceId note: this method should only be used for API response data and not user input

func (WorkspaceId) ID

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments

func (id WorkspaceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Workspace ID

func (WorkspaceId) String

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL