Azure / Azure/MachineLearningNotebooks

Store metadata like tags and description in PipelineStep (PythonScriptStep, DatabricksStep)

Open
#1,710 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
4.4k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

[Enter feedback here]

In the ML web UI, there are possibilities to see tags and description for runs. I can set tags and description for normal runs that are [azureml.core.Run](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.run(class)?view=azure-ml-py) object. Normally ScriptRunConfig class is used. However, in case of [Pipeline](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.pipeline(class)?view=azure-ml-py) which includes PipelineSteps (like PythonScriptStep, DatabricksStep), I could not find any way to set tags or description. There was [get_tag](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.pipelinerun?view=azure-ml-py#azureml-pipeline-core-pipelinerun-get-tags) function though. I wonder if a user can set tags or description at all in the Pipeline cases.

One thing I noticed was that some tags are automatically set (Experiment->Run-Steps). Those tags are related to _azureml.nodeid,
azureml.pipeline, etc_. But those tags are not visiable once click into the step.
![image](https://user-images.githubusercontent.com/11485399/157761167-c5cd4f94-64f5-4c98-a8de-e4f72268942e.png)

Once click into a step, the tags and description are not visible any more.
Screenshot 2022-03-10 at 23 59 48

Another thing I noticed was that the step name in the second screenshot is different from the one shown in the first screenshot. Should not they be the same ?

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: 699416e1-0ac4-10ca-5a93-8fbd256568c3
* Version Independent ID: 3f14db56-3e6a-3ff8-fda5-5145b6891c23
* Content: [azureml.pipeline.core.PipelineStep class - Azure Machine Learning Python](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.pipelinestep?view=azure-ml-py)
* Content Source: [AzureML-Docset/stable/docs-ref-autogen/azureml-pipeline-core/azureml.pipeline.core.PipelineStep.yml](https://github.com/MicrosoftDocs/MachineLearning-Python-pr/blob/live/AzureML-Docset/stable/docs-ref-autogen/azureml-pipeline-core/azureml.pipeline.core.PipelineStep.yml)
* Service: **machine-learning**
* Sub-service: **core**
* GitHub Login: @DebFro
* Microsoft Alias: **debfro**

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.