Skip to content

Commit bd7bef8

Browse files
authored
Merge pull request #78564 from BobbySchmidt2/edit-metadata
edit pass: edit-metadata
2 parents 40d7157 + 10178ec commit bd7bef8

File tree

1 file changed

+40
-45
lines changed

1 file changed

+40
-45
lines changed
Lines changed: 40 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: "Edit Metadata: Module Reference"
2+
title: "Edit Metadata: Module reference"
33
titleSuffix: Azure Machine Learning service
4-
description: Learn how to use the Edit Metadata module in Azure Machine Learning service to change metadata that is associated with columns in a dataset.
4+
description: Learn how to use the Edit Metadata module in the Azure Machine Learning service to change metadata that's associated with columns in a dataset.
55
services: machine-learning
66
ms.service: machine-learning
77
ms.subservice: core
@@ -14,89 +14,84 @@ ROBOTS: NOINDEX
1414
---
1515
# Edit Metadata module
1616

17-
This article describes a module of the visual interface (preview) for Azure Machine Learning service.
17+
This article describes a module of the visual interface (preview) for the Azure Machine Learning service.
18+
19+
Use the Edit Data module to change metadata that's associated with columns in a dataset. The value and data type of the dataset will change after use of the Edit Metadata module.
1820

19-
Use this module to change metadata that is associated with columns in a dataset. The value and data type of the dataset will be changed after using the **Edit Metadata** module.
20-
2121
Typical metadata changes might include:
2222

23-
+ Treating Boolean or numeric columns as categorical values
23+
+ Treating Boolean or numeric columns as categorical values.
2424

25-
+ Indicating which column contains the *class* label, or the values you want to categorize or predict
25+
+ Indicating which column contains the **class** label or contains the values you want to categorize or predict.
2626

27-
+ Marking columns as features
27+
+ Marking columns as features.
2828

29-
+ Changing date/time values to a numeric value, or vice versa
29+
+ Changing date/time values to numeric values or vice versa.
3030

31-
+ Renaming columns
31+
+ Renaming columns.
3232

33-
Use [Edit Metadata anytime you need to modify the definition of a column, typically to meet requirements for a downstream module. For example, some modules can work only with specific data types, or require flags on the columns, such as `IsFeature` or `IsCategorical`.
33+
Use Edit Metadata anytime you need to modify the definition of a column, typically to meet requirements for a downstream module. For example, some modules work only with specific data types or require flags on the columns, such as `IsFeature` or `IsCategorical`.
3434

35-
After performing the required operation, you can reset the metadata to its original state.
35+
After you perform the required operation, you can reset the metadata to its original state.
3636

3737
## Configure Edit Metadata
3838

39-
1. In Azure Machine Learning, add [Edit Metadata](./edit-metadata.md) module to your experiment and connect the dataset you want to update. You can find it under **Data Transformation**, in the **Manipulate** category.
39+
1. In Azure Machine Learning, add the Edit Metadata module to your experiment and connect the dataset you want to update. You can find the dataset under **Data Transformation** in the **Manipulate** category.
4040

41-
2. Click **Launch the column selector** and choose the column or set of columns to work with. You can choose columns individually, by name or index, or you can choose a group of columns, by type.
41+
1. Select **Launch the column selector** and choose the column or set of columns to work with. You can choose columns individually by name or index, or you can choose a group of columns by type.
4242

43-
3. Select the **Data type** option if you need to assign a different data type to the selected columns. Changing the data type might be needed for certain operations: for example, if your source dataset has numbers handled as text, you must change them to a numeric data type before using math operations.
43+
1. Select the **Data type** option if you need to assign a different data type to the selected columns. You might need to change the data type for certain operations. For example, if your source dataset has numbers handled as text, you must change them to a numeric data type before using math operations.
4444

45-
+ The data types supported are `String`, `Integer`, `Double`, `Boolean`, `DateTime`.
45+
+ The supported data types are **String**, **Integer**, **Double**, **Boolean**, and **DateTime**.
4646

47-
+ If multiple columns are selected, you must apply the metadata changes to **all** selected columns. For example, let's say you choose 2-3 numeric columns. You could change them all to a string data type, and rename them in one operation. However, you can't change one column to a string data type and another column from a float to an integer.
47+
+ If you select multiple columns, you must apply the metadata changes to *all* selected columns. For example, let's say you choose two or three numeric columns. You can change them all to a string data type and rename them in one operation. However, you can't change one column to a string data type and another column from a float to an integer.
4848

49-
+ If you do not specify a new data type, the column metadata is unchanged.
50-
51-
+ The column type and values will be changed after perform the [Edit Metadata](./edit-metadata.md) operation. You can recover the original data type at any time by using [Edit Metadata](./edit-metadata.md) to reset the column data type.
49+
+ If you don't specify a new data type, the column metadata is unchanged.
50+
51+
+ The column type and values will change after you perform the Edit Metadata operation. You can recover the original data type at any time by using Edit Metadata to reset the column data type.
5252

5353
> [!NOTE]
54-
> If you change any type of number to the **DateTime** type, leave the **DateTime Format** field blank. Currently, it is not possible to specify the target data format.
54+
> If you change any type of number to the **DateTime** type, leave the **DateTime Format** field blank. Currently it isn't possible to specify the target data format.
5555
56-
57-
4. Select the **Categorical** option to specify that the values in the selected columns should be treated as categories.
56+
1. Select the **Categorical** option to specify that the values in the selected columns should be treated as categories.
5857

59-
For example, you might have a column that contains the numbers 0,1 and 2, but know that the numbers actually mean "Smoker", "Non-smoker" and "Unknown". In that case, by flagging the column as categorical you can ensure that the values are not used in numeric calculations, only to group data.
58+
For example, you might have a column that contains the numbers 0, 1, and 2, but know that the numbers actually mean "Smoker," "Non-smoker," and "Unknown." In that case, by flagging the column as categorical you ensure that the values are used only to group data and not in numeric calculations.
6059

61-
5. Use the **Fields** option if you want to change the way that Azure Machine Learning uses the data in a model.
60+
1. Use the **Fields** option if you want to change the way that Azure Machine Learning uses the data in a model.
6261

63-
+ **Feature**: Use this option to flag a column as a feature, for use with modules that operate only on feature columns. By default, all columns are initially treated as features.
64-
65-
+ **Label**: Use this option to mark the label (also known as the predictable attribute, or target variable). Many modules require that at least one (and only one) label column be present in the dataset.
66-
67-
In many cases, Azure Machine Learning can infer that a column contains a class label, but by setting this metadata you can ensure that the column is identified correctly. Setting this option does not change data values, only the way that some machine learning algorithms handle the data.
62+
+ **Feature**: Use this option to flag a column as a feature in modules that operate only on feature columns. By default, all columns are initially treated as features.
6863

64+
+ **Label**: Use this option to mark the label, which is also known as the predictable attribute or target variable. Many modules require that exactly one label column is present in the dataset.
6965

66+
In many cases, Azure Machine Learning can infer that a column contains a class label. By setting this metadata, you can ensure that the column is identified correctly. Setting this option does not change data values. It changes only the way that some machine-learning algorithms handle the data.
7067

7168
> [!TIP]
72-
> Have data that doesn't fit into these categories? For example, your dataset might contain values such as unique identifiers that are not useful as variables. Sometimes IDs can cause problems when used in a model.
73-
>
74-
> Fortunately "under the covers" Azure Machine Learning keeps all your data, so you don't have to delete such columns from the dataset. When you need to perform operations on some special set of columns, just remove all other columns temporarily by using the [Select Columns in Dataset](./select-columns-in-dataset.md) module. Later you can merge the columns back into the dataset by using the [Add Columns](./add-columns.md) module.
69+
> Do you have data that doesn't fit into these categories? For example, your dataset might contain values such as unique identifiers that aren't useful as variables. Sometimes such IDs can cause problems when used in a model.
70+
>
71+
> Fortunately, Azure Machine Learning keeps all of your data, so that you don't have to delete such columns from the dataset. When you need to perform operations on some special set of columns, just remove all other columns temporarily by using the [Select Columns in Dataset](select-columns-in-dataset.md) module. Later you can merge the columns back into the dataset by using the [Add Columns](add-columns.md) module.
7572
76-
6. Use the following options to clear previous selections and restore metadata to the default values.
73+
1. Use the following options to clear previous selections and restore metadata to the default values.
7774

7875
+ **Clear feature**: Use this option to remove the feature flag.
7976

80-
Because all columns are initially treated as features, for modules that perform mathematical operations, you might need to use this option to prevent numeric columns from being treated as variables.
77+
All columns are initially treated as features. For modules that perform mathematical operations, you might need to use this option in order to prevent numeric columns from being treated as variables.
8178

8279
+ **Clear label**: Use this option to remove the **label** metadata from the specified column.
8380

8481
+ **Clear score**: Use this option to remove the **score** metadata from the specified column.
8582

86-
Currently the ability to explicitly mark a column as a score is not available in Azure Machine Learning. However, some operations result in a column being flagged as a score internally. Also, a custom R module might output score values.
87-
88-
89-
7. For **New column names**, type the new name of the selected column or columns.
90-
91-
+ Column names can use only characters that are supported by the UTF-8 encoding. Empty strings, nulls, or names consisting entirely of spaces are not allowed.
83+
You currently can't explicitly mark a column as a score in Azure Machine Learning. However, some operations result in a column being flagged as a score internally. Also, a custom R module might output score values.
84+
85+
1. For **New column names**, enter the new name of the selected column or columns.
9286

93-
+ To rename multiple columns, type the names as a comma-separated list in order of the column indices.
87+
+ Column names can use only characters that are supported by UTF-8 encoding. Empty strings, nulls, or names that consist entirely of spaces aren't allowed.
9488

95-
+ All selected columns must be renamed. You cannot omit or skip columns.
89+
+ To rename multiple columns, enter the names as a comma-separated list in order of the column indexes.
9690

91+
+ All selected columns must be renamed. You can't omit or skip columns.
9792

98-
8. Run the experiment.
93+
1. Run the experiment.
9994

10095
## Next steps
10196

102-
See the [set of modules available](module-reference.md) to Azure Machine Learning service.
97+
See the [set of modules available](module-reference.md) to the Azure Machine Learning service.

0 commit comments

Comments
 (0)