Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AutoPR machinelearningservices] Add descriptions to mfe.json 2021-03-01-preview #4342

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 72 additions & 38 deletions schemas/2021-03-01-preview/Microsoft.MachineLearningServices.json
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,8 @@
"description": "Service identity associated with a resource."
},
"kind": {
"type": "string"
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"location": {
"type": "string",
Expand Down Expand Up @@ -242,7 +243,8 @@
"description": "Service identity associated with a resource."
},
"kind": {
"type": "string"
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"location": {
"type": "string",
Expand Down Expand Up @@ -913,7 +915,8 @@
"description": "Service identity associated with a resource."
},
"kind": {
"type": "string"
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"location": {
"type": "string",
Expand Down Expand Up @@ -996,7 +999,8 @@
"description": "Service identity associated with a resource."
},
"kind": {
"type": "string"
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"location": {
"type": "string",
Expand Down Expand Up @@ -1551,7 +1555,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Target CPU usage for the autoscaler."
}
},
"required": [
Expand Down Expand Up @@ -2019,7 +2024,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Absolute distance allowed from the best performing run."
},
"slackFactor": {
"oneOf": [
Expand All @@ -2029,13 +2035,14 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Ratio of the allowed distance from the best performing run."
}
},
"required": [
"policyType"
],
"description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation"
"description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation."
},
"BatchDeployment": {
"type": "object",
Expand Down Expand Up @@ -3614,7 +3621,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Number of intervals by which to delay the first evaluation."
},
"evaluationInterval": {
"oneOf": [
Expand All @@ -3624,10 +3632,11 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Interval (number of runs) between policy evaluations."
}
},
"description": "Early termination policies enable canceling poor-performing runs before they complete"
"description": "Early termination policies enable canceling poor-performing runs before they complete."
},
"EncryptionProperty": {
"type": "object",
Expand Down Expand Up @@ -3819,7 +3828,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Model flavor-specific data."
}
}
},
Expand Down Expand Up @@ -4535,7 +4545,8 @@
]
},
"instanceType": {
"type": "string"
"type": "string",
"description": "Compute instance type."
},
"readinessProbe": {
"oneOf": [
Expand All @@ -4545,7 +4556,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Deployment container liveness/readiness probe configuration."
}
},
"required": [
Expand All @@ -4563,7 +4575,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Fixed number of instances for this deployment."
},
"scaleType": {
"type": "string",
Expand All @@ -4589,7 +4602,7 @@
"required": [
"policyType"
],
"description": "Defines an early termination policy based on running averages of the primary metric of all runs"
"description": "Defines an early termination policy based on running averages of the primary metric of all runs."
},
"MLAssistConfiguration": {
"type": "object",
Expand Down Expand Up @@ -4771,7 +4784,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Number of processes per MPI node."
}
},
"required": [
Expand Down Expand Up @@ -4837,13 +4851,15 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Name of the metric to optimize."
}
},
"required": [
"goal",
"primaryMetric"
]
],
"description": "Optimization objective."
},
"OnlineDeployment": {
"type": "object",
Expand Down Expand Up @@ -4909,7 +4925,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Deployment container liveness/readiness probe configuration."
},
"model": {
"oneOf": [
Expand Down Expand Up @@ -4945,7 +4962,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Online deployment scoring requests configuration."
},
"scaleSettings": {
"oneOf": [
Expand All @@ -4955,7 +4973,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Online deployment scaling configuration."
}
}
},
Expand Down Expand Up @@ -5044,7 +5063,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "The number of requests allowed to queue at once for this deployment."
},
"maxQueueWait": {
"type": "string",
Expand All @@ -5056,7 +5076,8 @@
"format": "duration",
"description": "The request timeout in ISO 8601 format. Supports millisecond precision."
}
}
},
"description": "Online deployment scoring requests configuration."
},
"OnlineScaleSettings": {
"type": "object",
Expand All @@ -5077,7 +5098,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Maximum number of instances for this deployment."
},
"minInstances": {
"oneOf": [
Expand All @@ -5087,9 +5109,11 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Minimum number of instances for this deployment."
}
}
},
"description": "Online deployment scaling configuration."
},
"OutputDataBinding": {
"type": "object",
Expand Down Expand Up @@ -5289,7 +5313,8 @@
"format": "duration",
"description": "The probe timeout in ISO 8601 format."
}
}
},
"description": "Deployment container liveness/readiness probe configuration."
},
"PyTorch": {
"type": "object",
Expand Down Expand Up @@ -5945,7 +5970,7 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Early termination policies enable canceling poor-performing runs before they complete"
"description": "Early termination policies enable canceling poor-performing runs before they complete."
},
"experimentName": {
"type": "string",
Expand Down Expand Up @@ -5976,7 +6001,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "An upper bound on the number of trials performed in parallel."
},
"maxTotalTrials": {
"oneOf": [
Expand All @@ -5986,7 +6012,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "An upper bound on the number of trials to perform."
},
"objective": {
"oneOf": [
Expand All @@ -5996,7 +6023,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Optimization objective."
},
"priority": {
"oneOf": [
Expand Down Expand Up @@ -6126,7 +6154,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "Number of parameter server tasks."
},
"workerCount": {
"oneOf": [
Expand Down Expand Up @@ -6253,7 +6282,8 @@
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
],
"description": "The percentage of runs to cancel at each evaluation interval."
}
},
"required": [
Expand Down Expand Up @@ -6564,7 +6594,8 @@
"description": "Service identity associated with a resource."
},
"kind": {
"type": "string"
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"location": {
"type": "string",
Expand Down Expand Up @@ -6637,7 +6668,8 @@
"description": "Service identity associated with a resource."
},
"kind": {
"type": "string"
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"location": {
"type": "string",
Expand Down Expand Up @@ -7268,7 +7300,8 @@
"description": "Service identity associated with a resource."
},
"kind": {
"type": "string"
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"location": {
"type": "string",
Expand Down Expand Up @@ -7341,7 +7374,8 @@
"description": "Service identity associated with a resource."
},
"kind": {
"type": "string"
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"location": {
"type": "string",
Expand Down
Loading