PipelineRun Sınıf

bir çalıştırmayı Pipelinetemsil eder.

Bu sınıf, işlem hattı çalıştırması gönderildikten sonra çalıştırma ayrıntılarını yönetmek, denetlemek ve almak için kullanılabilir. İşlem hattı çalıştırması StepRun tarafından oluşturulan nesneleri almak için kullanınget_steps. Diğer kullanımlar arasında işlem hattı çalıştırmasıyla ilişkili nesneyi alma Graph , işlem hattı çalıştırmasının durumunu getirme ve çalıştırmanın tamamlanmasını bekleme sayılabilir.

İşlem hattı çalıştırması başlatın.

Devralma
PipelineRun

Oluşturucu

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

Parametreler

experiment
Experiment
Gerekli

İşlem hattı çalıştırmasıyla ilişkili deneme nesnesi.

run_id
str
Gerekli

İşlem hattı çalıştırmasının çalıştırma kimliği.

_service_endpoint
str
varsayılan değer: None

Bağlanacak uç nokta.

experiment
Experiment
Gerekli

İşlem hattı çalıştırmasıyla ilişkili deneme nesnesi.

run_id
str
Gerekli

İşlem hattı çalıştırmasının çalıştırma kimliği.

_service_endpoint
str
Gerekli

Bağlanacak uç nokta.

Açıklamalar

aracılığıyla submitbir gönderilirken pipelinerun Pipeline nesnesi döndürülür. Experimentyöntemi. İşlem Hattı oluşturma ve gönderme hakkında daha fazla bilgi için bkz. https://aka.ms/pl-first-pipeline.

Bir PipelineRun örneği de çalıştırmanın Experiment gönderildiği ve PipelineRun Kimliği ile aşağıdaki gibi oluşturulabilir:


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

PipelineRun ile çalışırken şu komutu kullanın:

  • wait_for_completion çalıştırma durumunu izlemek ve isteğe bağlı olarak çalıştırma günlüklerinin akışını yapmak için.

  • get_status çalıştırma durumunu getirmek için.

  • cancel devam eden bir PipelineRun'ı iptal etmek için.

  • get_steps oluşturulan StepRuns'ı listelemek için. PipelineRun, İşlem Hattı'ndaki her adım için bir StepRun oluşturur.

Yöntemler

cancel

Devam eden çalıştırmayı iptal edin.

child_run

İşlem hattı çalıştırması için bir alt çalıştırma oluşturun. Bu yöntem PipelineRun için uygulanmaz.

complete

İşlem hattı çalıştırmasını tamamlandı olarak işaretleyin. Bu yöntem PipelineRun için uygulanmaz.

Bu yöntem işlem hatları için desteklenmez; tamamlanma/başarısız durumu Azure ML arka ucu tarafından yönetilir.

fail

İşlem hattı çalıştırmasını başarısız olarak işaretleyin. Bu yöntem PipelineRun için uygulanmaz.

Bu yöntem işlem hatları için desteklenmez; tamamlanma/başarısız durumu Azure ML arka ucu tarafından yönetilir.

find_step_run

İşlem hattında ada göre bir adım çalıştırması bulun.

get

Çalıştırma kimliğine göre işlem hattı çalıştırması getirme.

get_graph

İşlem hattı çalıştırmasının grafiğini alın.

get_pipeline_output

Verilen işlem hattı çıkışı için PortDataReference değerini alın.

get_pipeline_runs

Yayımlanmış bir işlem hattından oluşturulan işlem hattı çalıştırmalarını getirin.

get_status

hizmetten işlem hattı çalıştırmasının en son durumunu getirin.

Döndürülen yaygın değerler şunlardır: "Çalışıyor", "Bitti" ve "Başarısız".

get_steps

Tamamlanan veya çalışmaya başlayan tüm işlem hattı adımları için adım çalıştırmalarını alın.

get_tags

Çalıştırma için etiket kümesini alın.

publish_pipeline

bir işlem hattı yayımlayın ve yeniden çalıştırılabilmesini sağlayın.

İşlem hattı uç noktasını bu işlev tarafından döndürülen PublishedPipeline nesnesinden alabilirsiniz. İşlem hattı uç noktasıyla, REST çağrılarını kullanarak dış uygulamalardan işlem hattını çağırabilirsiniz. REST uç noktalarını çağırırken kimlik doğrulaması yapma hakkında bilgi için bkz https://aka.ms/pl-restep-auth. .

İşlem hattı çalıştırmasıyla ilişkili özgün işlem hattı, yayımlanan işlem hattının temeli olarak kullanılır.

save

İşlem hattı YAML'sini bir dosyaya kaydedin.

wait_for_completion

Bu işlem hattı çalıştırmasının tamamlanmasını bekleyin.

Beklemeden sonra durumu döndürür.

cancel

Devam eden çalıştırmayı iptal edin.

cancel()

child_run

İşlem hattı çalıştırması için bir alt çalıştırma oluşturun. Bu yöntem PipelineRun için uygulanmaz.

child_run(name=None, run_id=None, outputs=None)

Parametreler

name
str
varsayılan değer: None

Çocuk için isteğe bağlı ad.

run_id
str
varsayılan değer: None

Alt öğe için isteğe bağlı çalıştırma kimliği, aksi takdirde varsayılanı kullanır.

outputs
str
varsayılan değer: None

Alt öğe için izlenen isteğe bağlı çıkış dizini.

Döndürülenler

Çocuk koşuyor.

Dönüş türü

Run

Özel durumlar

complete

İşlem hattı çalıştırmasını tamamlandı olarak işaretleyin. Bu yöntem PipelineRun için uygulanmaz.

Bu yöntem işlem hatları için desteklenmez; tamamlanma/başarısız durumu Azure ML arka ucu tarafından yönetilir.

complete()

Özel durumlar

fail

İşlem hattı çalıştırmasını başarısız olarak işaretleyin. Bu yöntem PipelineRun için uygulanmaz.

Bu yöntem işlem hatları için desteklenmez; tamamlanma/başarısız durumu Azure ML arka ucu tarafından yönetilir.

fail()

Özel durumlar

find_step_run

İşlem hattında ada göre bir adım çalıştırması bulun.

find_step_run(name)

Parametreler

name
str
Gerekli

Bulunacak adımın adı.

Döndürülenler

StepRun Sağlanan ada sahip nesnelerin listesi.

Dönüş türü

get

Çalıştırma kimliğine göre işlem hattı çalıştırması getirme.

static get(workspace, run_id, _service_endpoint=None)

Parametreler

workspace
Workspace
Gerekli

İşlem hattıyla ilişkili çalışma alanı.

run_id
str
Gerekli

İşlem hattı çalıştırmasının kimliği.

_service_endpoint
str
varsayılan değer: None

Bağlanacak uç nokta.

Döndürülenler

PipelineRun nesnesi.

Dönüş türü

get_graph

İşlem hattı çalıştırmasının grafiğini alın.

get_graph()

Döndürülenler

Graf.

Dönüş türü

get_pipeline_output

Verilen işlem hattı çıkışı için PortDataReference değerini alın.

get_pipeline_output(pipeline_output_name)

Parametreler

pipeline_output_name
str
Gerekli

Alınacak işlem hattı çıkışının adı.

Döndürülenler

İşlem hattı çıkış verilerini temsil eden PortDataReference.

Dönüş türü

get_pipeline_runs

Yayımlanmış bir işlem hattından oluşturulan işlem hattı çalıştırmalarını getirin.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parametreler

workspace
Workspace
Gerekli

İşlem hattıyla ilişkili çalışma alanı.

pipeline_id
str
Gerekli

Yayımlanan işlem hattının kimliği.

_service_endpoint
str
varsayılan değer: None

Bağlanacak uç nokta.

Döndürülenler

Nesnelerin listesi PipelineRun .

Dönüş türü

get_status

hizmetten işlem hattı çalıştırmasının en son durumunu getirin.

Döndürülen yaygın değerler şunlardır: "Çalışıyor", "Bitti" ve "Başarısız".

get_status()

Döndürülenler

Dize olarak en son durum.

Dönüş türü

str

Açıklamalar

  • NotStarted - Bu geçici bir durumdur istemci tarafı Çalıştırma nesneleri bulut göndermeden önce içindedir

  • Çalışıyor - İş işlem hedefinde çalışmaya başladı.

  • Başarısız - Çalıştırma başarısız oldu. Genellikle bir çalıştırmadaki Error özelliği nedenine ilişkin ayrıntıları sağlar.

  • Bitti - Çalıştırma başarıyla tamamlandı.

  • İptal edildi - İptal isteğinin ardından çalıştırma artık başarıyla iptal edildi.


   run = experiment.submit(config)
   while run.get_status() not in ['Finished', 'Failed']: # For example purposes only, not exhaustive
       print('Run {} not in terminal state'.format(run.id))
       time.sleep(10)

get_steps

Tamamlanan veya çalışmaya başlayan tüm işlem hattı adımları için adım çalıştırmalarını alın.

get_steps()

Döndürülenler

Nesnelerin listesi StepRun .

Dönüş türü

get_tags

Çalıştırma için etiket kümesini alın.

get_tags()

Döndürülenler

Çalıştırma için etiketlerin sözlüğü.

Dönüş türü

publish_pipeline

bir işlem hattı yayımlayın ve yeniden çalıştırılabilmesini sağlayın.

İşlem hattı uç noktasını bu işlev tarafından döndürülen PublishedPipeline nesnesinden alabilirsiniz. İşlem hattı uç noktasıyla, REST çağrılarını kullanarak dış uygulamalardan işlem hattını çağırabilirsiniz. REST uç noktalarını çağırırken kimlik doğrulaması yapma hakkında bilgi için bkz https://aka.ms/pl-restep-auth. .

İşlem hattı çalıştırmasıyla ilişkili özgün işlem hattı, yayımlanan işlem hattının temeli olarak kullanılır.

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

Parametreler

name
str
Gerekli

Yayımlanan işlem hattının adı.

description
str
Gerekli

Yayımlanan işlem hattının açıklaması.

version
str
Gerekli

Yayımlanan işlem hattının sürümü.

continue_on_step_failure
bool
varsayılan değer: None

Bir adım başarısız olursa PipelineRun'daki diğer adımların yürütülmesine devam edilip edilmeyeceği. Varsayılan değer False'tur.

kwargs
dict
Gerekli

Gelecekteki geliştirmeler için ayrılmış özel anahtar sözcük bağımsız değişkenleri

Döndürülenler

Yayımlanan işlem hattı oluşturuldu.

Dönüş türü

save

İşlem hattı YAML'sini bir dosyaya kaydedin.

save(path=None)

Parametreler

path
str
varsayılan değer: None

YAML'nin kaydedilecek yol. Yol bir dizinse, işlem hattı YAML dosyası path>/pipeline.yml adresine <kaydedilir. Yol yoksa, geçerli dizin kullanılır.

Dönüş türü

wait_for_completion

Bu işlem hattı çalıştırmasının tamamlanmasını bekleyin.

Beklemeden sonra durumu döndürür.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

Parametreler

show_output
bool
varsayılan değer: True

sys.stdout üzerinde işlem hattı çalıştırma durumunun gösterilip gösterilmeyeceğini gösterir.

timeout_seconds
int
varsayılan değer: 9223372036854775807

Zaman aşımına uğramadan önce bekliyecek saniye sayısı.

raise_on_error
bool
varsayılan değer: True

Çalıştırma başarısız durumdayken hata oluşturup oluşturmayacağını gösterir.

Döndürülenler

Son durum.

Dönüş türü

str