TrialComponent Class

Package:
com.azure.resourcemanager.machinelearning.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0
  • java.lang.Object
    • com.azure.resourcemanager.machinelearning.models.TrialComponent

Implements

JsonSerializable<TrialComponent>

public final class TrialComponent
implements JsonSerializable<TrialComponent>

Trial component definition.

Constructor Summary

Constructor Description
TrialComponent()

Creates an instance of TrialComponent class.

Method Summary

Modifier and Type Method and Description
String codeId()

Get the codeId property: ARM resource ID of the code asset.
String command()

Get the command property: [Required] The command to execute on startup of the job.
DistributionConfiguration distribution()

Get the distribution property: Distribution configuration of the job.
String environmentId()

Get the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.
Map<String,String> environmentVariables()

Get the environmentVariables property: Environment variables included in the job.
static TrialComponent fromJson(JsonReader jsonReader)

Reads an instance of TrialComponent from the JsonReader.
JobResourceConfiguration resources()

Get the resources property: Compute Resource configuration for the job.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
TrialComponent withCodeId(String codeId)

Set the codeId property: ARM resource ID of the code asset.
TrialComponent withCommand(String command)

Set the command property: [Required] The command to execute on startup of the job.
TrialComponent withDistribution(DistributionConfiguration distribution)

Set the distribution property: Distribution configuration of the job.
TrialComponent withEnvironmentId(String environmentId)

Set the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.
TrialComponent withEnvironmentVariables(Map<String,String> environmentVariables)

Set the environmentVariables property: Environment variables included in the job.
TrialComponent withResources(JobResourceConfiguration resources)

Set the resources property: Compute Resource configuration for the job.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TrialComponent

public TrialComponent()

Creates an instance of TrialComponent class.

Method Details

codeId

public String codeId()

Get the codeId property: ARM resource ID of the code asset.

Returns:

the codeId value.

command

public String command()

Get the command property: [Required] The command to execute on startup of the job. eg. "python train.py".

Returns:

the command value.

distribution

public DistributionConfiguration distribution()

Get the distribution property: Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

Returns:

the distribution value.

environmentId

public String environmentId()

Get the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.

Returns:

the environmentId value.

environmentVariables

public Map<String,String> environmentVariables()

Get the environmentVariables property: Environment variables included in the job.

Returns:

the environmentVariables value.

fromJson

public static TrialComponent fromJson(JsonReader jsonReader)

Reads an instance of TrialComponent from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of TrialComponent if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

resources

public JobResourceConfiguration resources()

Get the resources property: Compute Resource configuration for the job.

Returns:

the resources value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withCodeId

public TrialComponent withCodeId(String codeId)

Set the codeId property: ARM resource ID of the code asset.

Parameters:

codeId - the codeId value to set.

Returns:

the TrialComponent object itself.

withCommand

public TrialComponent withCommand(String command)

Set the command property: [Required] The command to execute on startup of the job. eg. "python train.py".

Parameters:

command - the command value to set.

Returns:

the TrialComponent object itself.

withDistribution

public TrialComponent withDistribution(DistributionConfiguration distribution)

Set the distribution property: Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

Parameters:

distribution - the distribution value to set.

Returns:

the TrialComponent object itself.

withEnvironmentId

public TrialComponent withEnvironmentId(String environmentId)

Set the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.

Parameters:

environmentId - the environmentId value to set.

Returns:

the TrialComponent object itself.

withEnvironmentVariables

public TrialComponent withEnvironmentVariables(Map<String,String> environmentVariables)

Set the environmentVariables property: Environment variables included in the job.

Parameters:

environmentVariables - the environmentVariables value to set.

Returns:

the TrialComponent object itself.

withResources

public TrialComponent withResources(JobResourceConfiguration resources)

Set the resources property: Compute Resource configuration for the job.

Parameters:

resources - the resources value to set.

Returns:

the TrialComponent object itself.

Applies to