-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.ai.ml.entities.DataColumn.yml
47 lines (47 loc) · 2.19 KB
/
azure.ai.ml.entities.DataColumn.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
43
44
45
46
47
### YamlMime:PythonClass
uid: azure.ai.ml.entities.DataColumn
name: DataColumn
fullName: azure.ai.ml.entities.DataColumn
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._mixins.RestTranslatableMixin
summary: A dataframe column
constructor:
syntax: 'DataColumn(*, name: str, type: str | DataColumnType | None = None, **kwargs:
Any)'
parameters:
- name: name
description: The column name
isRequired: true
types:
- <xref:str>
- name: type
description: The column data type. Defaults to None.
isRequired: true
types:
- <xref:typing.Optional>[<xref:union>[<xref:str>, <xref:azure.ai.ml.entities.DataColumnType>]]
- name: kwargs
description: A dictionary of additional configuration parameters.
isRequired: true
types:
- <xref:dict>
keywordOnlyParameters:
- name: name
isRequired: true
- name: type
isRequired: true
examples:
- "Using DataColumn when creating an index column for a feature store entity<!--[!code-Python[Main](les\\\
ml_samples_featurestore.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.16.1\\\\samples\\\\ml_samples_featurestore.py\", \"xml:space\"\
: \"preserve\", \"force\": false, \"language\": \"Python\", \"highlight_args\":\
\ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````Python\n\n from azure.ai.ml.entities\
\ import DataColumn, DataColumnType, FeatureStoreEntity\n\n account_column = DataColumn(name=\"\
accountID\", type=DataColumnType.STRING)\n\n account_entity_config = FeatureStoreEntity(\n\
\ name=\"account\",\n version=\"1\",\n index_columns=[account_column],\n\
\ stage=\"Development\",\n description=\"This entity represents user\
\ account index key accountID.\",\n tags={\"data_type\": \"nonPII\"},\n \
\ )\n\n # wait for featurestore entity creation\n fs_entity_poller = featurestore_client.feature_store_entities.begin_create_or_update(account_entity_config)\n\
\ print(fs_entity_poller.result())\n\n ````\n"