-
Notifications
You must be signed in to change notification settings - Fork 234
/
azure.ai.ml.entities.BaseEnvironment.yml
42 lines (36 loc) · 1.63 KB
/
azure.ai.ml.entities.BaseEnvironment.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
### YamlMime:PythonClass
uid: azure.ai.ml.entities.BaseEnvironment
name: BaseEnvironment
fullName: azure.ai.ml.entities.BaseEnvironment
module: azure.ai.ml.entities
inheritances:
- builtins.object
summary: '> [!NOTE]
> This is an experimental class, and may change at any time. Please see [https://aka.ms/azuremlexperimental](https://aka.ms/azuremlexperimental)
for more information.
>
Base environment type.
All required parameters must be populated in order to send to Azure.'
constructor:
syntax: 'BaseEnvironment(type: str, resource_id: str | None = None)'
parameters:
- name: type
description: The type of the base environment.
isRequired: true
types:
- <xref:str>
- name: resource_id
description: The resource id of the base environment. e.g. azureml:name:version
isRequired: true
types:
- <xref:str>
examples:
- "Create a Base Environment object.<!--[!code-python[Main](les\\ml_samples_misc.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-ml-1.17.0\\\
\\samples\\\\ml_samples_misc.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n from azure.ai.ml.entities._assets._artifacts._package.base_environment_source\
\ import BaseEnvironment\n\n base_environment = BaseEnvironment(type=\"base-env-type\"\
, resource_id=\"base-env-resource-id\")\n\n ````\n"