다음을 통해 공유

CommandStep 클래스

  • 참조

명령을 실행하는 Azure ML 파이프라인 단계를 생성합니다.

명령을 실행하는 Azure ML 파이프라인 단계를 생성합니다.

상속
azureml.pipeline.core._python_script_step_base._PythonScriptStepBase
CommandStep

생성자

CommandStep(command=None, name=None, compute_target=None, runconfig=None, runconfig_pipeline_params=None, inputs=None, outputs=None, params=None, source_directory=None, allow_reuse=True, version=None)

매개 변수

Name Description
command
list 또는 str

source_directory를 기준으로 실행 파일/스크립트를 실행할 명령 또는 경로입니다. runconfig와 함께 제공되지 않는 한 필요합니다. 단일 문자열의 문자열 인수 또는 목록의 input/output/PipelineParameter를 사용하여 지정할 수 있습니다.

Default value: None
name
str

단계의 이름입니다. 지정하지 않으면 command의 첫 번째 단어가 사용됩니다.

Default value: None
compute_target
DsvmCompute 또는 AmlCompute 또는 RemoteCompute 또는 HDInsightCompute 또는 str 또는 tuple

사용할 컴퓨팅 대상입니다. 지정하지 않으면 runconfig의 대상이 사용됩니다. 이 매개 변수는 작업 영역의 컴퓨팅 대상 개체 또는 컴퓨팅 대상의 문자열 이름으로 지정할 수도 있습니다. 필요에 따라 파이프라인을 만들 때 컴퓨팅 대상을 사용할 수 없는 경우 컴퓨팅 대상 개체를 가져오지 않도록 ('컴퓨팅 대상 이름', '컴퓨팅 대상 유형') 튜플을 지정할 수도 있습니다(AmlCompute 형식은 'AmlCompute'이고 RemoteCompute 형식은 'VirtualMachine').

Default value: None
runconfig
ScriptRunConfig 또는 RunConfiguration

실험에서 학습 실행을 제출하는 데 필요한 정보를 캡슐화하는 선택적 구성 개체입니다.

Default value: None
runconfig_pipeline_params
<xref:<xref:{str: PipelineParameter}>>

런타임에 각각 runconfig 속성의 이름과 해당 속성의 PipelineParameter가 있는 키-값 쌍을 사용하여 runconfig 속성을 재정의합니다.

지원되는 값: 'NodeCount', 'MpiProcessCountPerNode', 'TensorflowWorkerCount', 'TensorflowParameterServerCount'

Default value: None
inputs
list[InputPortBinding 또는 DataReference 또는 PortDataReference 또는 PipelineData 또는 <xref:azureml.pipeline.core.pipeline_output_dataset.PipelineOutputDataset> 또는 DatasetConsumptionConfig]

입력 포트 바인딩 목록입니다.

Default value: None
outputs
list[PipelineData 또는 OutputDatasetConfig 또는 PipelineOutputAbstractDataset 또는 OutputPortBinding]

출력 포트 바인딩 목록입니다.

Default value: None
params
dict

"AML_PARAMETER_"를 사용하여 환경 변수로 등록된 이름-값 쌍의 사전입니다.

Default value: None
source_directory
str

스크립트, conda env 및 이 단계에서 사용되는 기타 리소스가 포함되는 폴더입니다.

Default value: None
allow_reuse
bool

동일한 설정으로 다시 실행할 때 단계에서 이전 결과를 재사용해야 하는지 여부를 나타냅니다. 기본적으로 재사용하도록 설정됩니다. 단계 내용(스크립트/종속성)과 입력 및 매개 변수가 변경되지 않은 상태로 유지되면 이 단계의 이전 실행 결과가 재사용됩니다. 단계를 재사용할 때, 컴퓨팅할 작업을 제출하는 대신 이전 실행의 결과를 후속 단계에 즉시 사용할 수 있습니다. Azure Machine Learning 데이터 집합을 입력으로 사용하는 경우 재사용은 기본 데이터가 변경되었는지 여부가 아니라 데이터 집합의 정의가 변경되었는지 여부에 따라 결정됩니다.

Default value: True
version
str

단계의 기능 변경을 나타내는 선택적 버전 태그입니다.

Default value: None
command
필수
list 또는 str

source_directory를 기준으로 실행 파일/스크립트를 실행할 명령 또는 경로입니다. runconfig와 함께 제공되지 않는 한 필요합니다. 단일 문자열의 문자열 인수 또는 목록의 input/output/PipelineParameter를 사용하여 지정할 수 있습니다.
name
필수
str

단계의 이름입니다. 지정하지 않으면 command의 첫 번째 단어가 사용됩니다.
compute_target
필수
DsvmCompute 또는 AmlCompute 또는 RemoteCompute 또는 HDInsightCompute 또는 str 또는 tuple

사용할 컴퓨팅 대상입니다. 지정하지 않으면 runconfig의 대상이 사용됩니다. 이 매개 변수는 작업 영역의 컴퓨팅 대상 개체 또는 컴퓨팅 대상의 문자열 이름으로 지정할 수도 있습니다. 필요에 따라 파이프라인을 만들 때 컴퓨팅 대상을 사용할 수 없는 경우 컴퓨팅 대상 개체를 가져오지 않도록 ('컴퓨팅 대상 이름', '컴퓨팅 대상 유형') 튜플을 지정할 수도 있습니다(AmlCompute 형식은 'AmlCompute'이고 RemoteCompute 형식은 'VirtualMachine').
runconfig
필수
ScriptRunConfig 또는 RunConfiguration

실험에서 학습 실행을 제출하는 데 필요한 정보를 캡슐화하는 선택적 구성 개체입니다.
runconfig_pipeline_params
필수
<xref:<xref:{str: PipelineParameter}>>

런타임에 각각 runconfig 속성의 이름과 해당 속성의 PipelineParameter가 있는 키-값 쌍을 사용하여 runconfig 속성을 재정의합니다.

지원되는 값: 'NodeCount', 'MpiProcessCountPerNode', 'TensorflowWorkerCount', 'TensorflowParameterServerCount'
inputs
필수
list[InputPortBinding 또는 DataReference 또는 PortDataReference 또는 PipelineData 또는 <xref:azureml.pipeline.core.pipeline_output_dataset.PipelineOutputDataset> 또는 DatasetConsumptionConfig]

입력 포트 바인딩 목록입니다.
outputs
필수
list[PipelineData 또는 OutputDatasetConfig 또는 PipelineOutputAbstractDataset 또는 OutputPortBinding]

출력 포트 바인딩 목록입니다.
params
필수
dict

"AML_PARAMETER_"를 사용하여 환경 변수로 등록된 이름-값 쌍의 사전입니다.
source_directory
필수
str

스크립트, conda env 및 이 단계에서 사용되는 기타 리소스가 포함되는 폴더입니다.
allow_reuse
필수
bool

동일한 설정으로 다시 실행할 때 단계에서 이전 결과를 재사용해야 하는지 여부를 나타냅니다. 기본적으로 재사용하도록 설정됩니다. 단계 내용(스크립트/종속성)과 입력 및 매개 변수가 변경되지 않은 상태로 유지되면 이 단계의 이전 실행 결과가 재사용됩니다. 단계를 재사용할 때, 컴퓨팅할 작업을 제출하는 대신 이전 실행의 결과를 후속 단계에 즉시 사용할 수 있습니다. Azure Machine Learning 데이터 집합을 입력으로 사용하는 경우 재사용은 기본 데이터가 변경되었는지 여부가 아니라 데이터 집합의 정의가 변경되었는지 여부에 따라 결정됩니다.
version
필수
str

단계의 기능 변경을 나타내는 선택적 버전 태그입니다.

설명

CommandStep은 주어진 컴퓨팅 대상에서 명령을 실행하는 기본 제공 단계입니다. 명령을 매개 변수로 사용하거나 runconfig와 같은 다른 매개 변수의 명령을 사용합니다. 컴퓨팅 대상 같은 다른 선택적 매개 변수와 입력 및 출력도 사용합니다. ScriptRunConfig 또는 RunConfiguration을 사용하여 사용자 지정 Docker 이미지와 같은 CommandStep에 대한 요구 사항을 지정해야 합니다.

CommandStep을 작업하는 모범 사례는 실행 파일 또는 스크립트에 대한 별도의 폴더를 사용하여 단계와 연결된 종속 파일을 실행하고, source_directory 매개 변수로 해당 폴더를 지정하는 것입니다. 이 모범 사례를 따르면 두 가지 이점이 있습니다. 첫째, 단계에 필요한 것만 스냅숏이 생성되므로 단계에 대해 생성되는 스냅숏의 크기를 줄이는 데 도움이 됩니다. 둘째, source_directory에서 스냅숏의 재업로드를 트리거하는 변경이 없는 경우 이전 실행 단계의 출력을 재사용할 수 있습니다.

시스템이 알고 있는 명령의 경우 source_directory가 필수는 아니지만 단계와 연결된 종속 파일을 계속 제공할 수 있습니다.

다음 코드 예제에서는 기계 학습 학습 시나리오에서 CommandStep을 사용하는 방법을 보여줍니다. Linux에서 파일을 나열하려면 다음을 수행합니다.


   from azureml.pipeline.steps import CommandStep

   trainStep = CommandStep(name='list step',
                           command='ls -lrt',
                           compute_target=compute_target)

Python 스크립트를 실행하려면 다음을 수행합니다.


   from azureml.pipeline.steps import CommandStep

   trainStep = CommandStep(name='train step',
                           command='python train.py arg1 arg2',
                           source_directory=project_folder,
                           compute_target=compute_target)

ScriptRunConfig를 통해 Python 스크립트를 실행하려면 다음을 수행합니다.


   from azureml.core import ScriptRunConfig
   from azureml.pipeline.steps import CommandStep

   train_src = ScriptRunConfig(source_directory=script_folder,
                               command='python train.py arg1 arg2',
                               environment=my_env)
   trainStep = CommandStep(name='train step',
                           runconfig=train_src)

파이프라인을 만드는 일반적인 방법에 대한 자세한 내용은 https://aka.ms/pl-first-pipeline을 참조하세요.

메서드

create_node

CommandStep에 대한 노드를 생성하여 지정된 그래프에 추가합니다.

이 메서드는 직접 사용할 수 없습니다. 이 단계에서 파이프라인이 인스턴스화되면 Azure ML은 이 메서드를 통해 필요한 매개 변수를 자동으로 전달하므로 워크플로를 나타내는 파이프라인 그래프에 단계를 추가할 수 있습니다.

create_node

CommandStep에 대한 노드를 생성하여 지정된 그래프에 추가합니다.

이 메서드는 직접 사용할 수 없습니다. 이 단계에서 파이프라인이 인스턴스화되면 Azure ML은 이 메서드를 통해 필요한 매개 변수를 자동으로 전달하므로 워크플로를 나타내는 파이프라인 그래프에 단계를 추가할 수 있습니다.

create_node(graph, default_datastore, context)

매개 변수

Name Description
graph
필수
Graph

노드를 추가할 그래프 개체입니다.
default_datastore
필수
AbstractAzureStorageDatastore 또는 AzureDataLakeDatastore

기본 데이터 저장소입니다.
context
필수
<xref:_GraphContext>

그래프 컨텍스트입니다.

반환

형식 Description
Node

생성된 노드입니다.