pipelines の API リファレンス
pipelines (kubeflow/pipelines) の公開 API 383 件 —— クラス 81、関数 204、メソッド 98。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: kubeflow/pipelines
| 種別 | 件数 |
|---|---|
| クラス | 81 |
| 関数 | 204 |
| メソッド | 98 |
API 一覧
class
.github.actions.junit-summary.junit_to_summary.TestCaseRepresents a single test case.
class
.github.actions.junit-summary.junit_to_summary.TestReportRepresents the complete test report.
class
.github.actions.junit-summary.junit_to_summary.TestSuiteRepresents a test suite.
func
.github.actions.junit-summary.junit_to_summary.expand_file_patterns(patterns:List[str]) -> List[Path]Expand glob patterns and collect all XML files.
func
.github.actions.junit-summary.junit_to_summary.format_duration(seconds:float) -> strFormat duration in seconds to a human-readable string.
func
.github.actions.junit-summary.junit_to_summary.parse_junit_xml(xml_file:Path) -> TestSuiteParse a JUnit XML file and extract test results.
func
.github.actions.junit-summary.junit_to_summary.parse_test_case(testcase_elem:ET.Element) -> TestCaseParse a single testcase element.
func
.github.actions.junit-summary.junit_to_summary.parse_test_suite(suite_elem:ET.Element) -> TestSuiteParse a single testsuite element.
func
.github.actions.junit-summary.junit_to_summary.set_github_output(key:str, value:str)Set a GitHub Action output.
func
.github.actions.junit-summary.junit_to_summary.write_to_step_summary(markdown:str)Write markdown to GitHub step summary.
method
backend.api.v1beta1.python_http_client.kfp_server_api.configuration.Configuration.logger_file()The logger file.
method
backend.api.v1beta1.python_http_client.kfp_server_api.configuration.Configuration.logger_format()The logger format.
method
backend.api.v2beta1.python_http_client.kfp_server_api.configuration.Configuration.logger_file()The logger file.
method
backend.api.v2beta1.python_http_client.kfp_server_api.configuration.Configuration.logger_format()The logger format.
method
backend.src.apiserver.visualization.exporter.Exporter.generate_html_from_notebook(nb:NotebookNode) -> TextConverts a provided NotebookNode to HTML.
func
components.google-cloud.google_cloud_pipeline_components._implementation.llm.preference_data_formatter.format_preference_data(input_uri:str) -> strFormat the input for preference data.
func
components.google-cloud.google_cloud_pipeline_components._implementation.llm.preprocess_chat_dataset.get_gcs_path(input_path:str, allow_local_files:bool) -> strGets the /gcs/ path for a given URI.
func
components.google-cloud.google_cloud_pipeline_components._implementation.llm.preprocess_chat_dataset.get_gs_path(input_path:str, allow_local_files:bool) -> strGets the gs:// path for a given URI.
func
components.google-cloud.google_cloud_pipeline_components.container._implementation.llm.templated_custom_job.launcher.main(argv:List[str]) -> NoneMain entry.
func
components.google-cloud.google_cloud_pipeline_components.container._implementation.model.get_model.get_model.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.preview.custom_job.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.preview.dataflow.flex_template.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.aiplatform.remote_runner.cast(value:str, annotation_type:Type[T]) -> TCasts a value to the annotation type.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.aiplatform.utils.is_serializable_to_json(annotation:Any) -> boolChecks if the type is serializable.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.automl_training_job.image.launcher.main(argv:List[str])Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.batch_prediction_job.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.create_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.drop_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.evaluate_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.export_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.feature_importance.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.forecast_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.global_explain.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_advanced_weights.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_arima_evaluate.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_centroids.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_confusion_matrix.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_feature_info.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_recommend.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_roc_curve.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_training_info.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_trial_info.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.ml_weights.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.predict_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.bigquery.query_job.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.custom_job.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.dataproc.create_pyspark_batch.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.dataproc.create_spark_batch.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.dataproc.create_spark_r_batch.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.endpoint.create_endpoint.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.endpoint.delete_endpoint.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.endpoint.deploy_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.endpoint.undeploy_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.hyperparameter_tuning_job.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.infra_validation_job.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.model.delete_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.model.export_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.model.get_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.model.get_model.remote_runner.get_model(executor_input, model_name:str, project:str, location:str) -> NoneGet model.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.model.upload_model.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.container.v1.wait_gcp_resources.launcher.main(argv)Main entry.
func
components.google-cloud.google_cloud_pipeline_components.preview.custom_job.utils.create_custom_training_job_op_from_component(*args, **kwargs) -> CallableDeprecated.
method
components.google-cloud.google_cloud_pipeline_components.types.artifact_types.VertexModel.create(name:str, uri:str, model_resource_name:str) -> 'VertexModel'Create a VertexModel artifact instance.
func
components.google-cloud.google_cloud_pipeline_components.v1.custom_job.utils.create_custom_training_job_op_from_component(*args, **kwargs) -> CallableDeprecated.
func
kubernetes_platform.python.generate_proto.generate_proto(source:str) -> NoneGenerate a _pb2.py from a .proto file.
func
kubernetes_platform.python.kfp.kubernetes.image.set_image_pull_policy(task:PipelineTask, policy:str) -> PipelineTaskSet image pull policy for the container.
func
kubernetes_platform.python.kfp.kubernetes.volume.DeletePVC(pvc_name:str)Delete a PersistentVolumeClaim.
func
release.kfpr.cli.clear(state_file:Path=typer.Option(Path(STATE_FILE), help='Path to checkpoint state file.')) -> NoneDelete the checkpoint state file.
func
release.kfpr.cli.done_command(step_id:str, state_file:Path=typer.Option(Path(STATE_FILE), help='Path to checkpoint state file.')) -> NoneMark one release step complete in the checkpoint.
func
release.kfpr.cli.validate_state_command(state_file:Path=typer.Option(Path(STATE_FILE), help='Path to checkpoint state file.')) -> NoneValidate a checkpoint file before resuming.
class
release.kfpr.core.CommandRunnerRuns commands with optional dry-run mode.
class
release.kfpr.core.ReleaseContextContext for release step execution.
class
release.kfpr.core.ReleaseStateCheckpoint for release process state.
method
release.kfpr.core.ReleaseState.is_done(step_id:str) -> boolCheck if a step has been marked as done.
method
release.kfpr.core.ReleaseState.load(path:Path) -> 'ReleaseState'Load state from JSON file.
method
release.kfpr.core.ReleaseState.mark_done(step_id:str) -> NoneMark a step as done.
method
release.kfpr.core.ReleaseState.reset_step(step_id:str) -> NoneRemove a step from the completed checkpoint list.
method
release.kfpr.core.ReleaseState.save() -> NoneSave state to JSON file atomically.
func
release.kfpr.core.collect_context(args:argparse.Namespace, state:ReleaseState) -> ReleaseContextCollect release context from state and prompts.
func
release.kfpr.core.confirm(question:str) -> NonePrompt user for confirmation.
func
release.kfpr.core.doctor_errors(answers:dict[str, object], root:Path) -> list[str]Return release preflight diagnostics without mutating state.
func
release.kfpr.core.emphasize_prompt(text:str) -> strBold a prompt that needs user input.
func
release.kfpr.core.image_workflow_command(metadata:ReleaseMetadata) -> list[str]Build command to trigger image-builds-release.yml workflow.
func
release.kfpr.core.normalize_fork_remote(fork_remote:str) -> strNormalize a fork owner or remote URL to a GitHub remote URL.
func
release.kfpr.core.parse_github_owner(fork_remote:str) -> strParse GitHub owner from fork remote URL.
func
release.kfpr.core.prompt_choice(question:str, choices:list[str], default:str | None=None) -> strPrompt user to choose from a list of options.
func
release.kfpr.core.prompt_numbered_choice(question:str, choices:list[str]) -> strPrompt user to choose from a numbered list.
func
release.kfpr.core.prompt_required(question:str) -> strPrompt user for required input.
func
release.kfpr.core.prompt_validated(question:str, validator) -> strPrompt until validator accepts the answer.
func
release.kfpr.core.sdk_workflow_command(metadata:ReleaseMetadata, packages:str='all') -> list[str]Build command to trigger publish-packages.yml workflow.
func
release.kfpr.core.underline_links(text:str) -> strUnderline URLs in terminal output.
func
release.kfpr.core.validate_state(state:ReleaseState) -> list[str]Validate a checkpoint state file for resume safety.
func
release.kfpr.core.wait_for_pr_merge(runner:CommandRunner, pr_url:str) -> NonePoll PR status until merged.
func
release.kfpr.core.watch_pr_ci(runner:CommandRunner, pr_url:str) -> NonePoll PR checks until one fails or all reported checks complete.
class
release.kfpr.rtd.ReadTheDocsClientTiny Read the Docs API v3 client.
class
release.kfpr.rtd.ReadTheDocsErrorRaised when Read the Docs automation cannot complete.
class
release.kfpr.steps.StepRepresents a release step with ID, description, and handler.
func
release.kfpr.steps.build_steps(release_type:str, include_backend:bool, include_sdk:bool) -> list[Step]Build the list of release steps based on configuration.
func
release.kfpr.steps.manual_checklist(step_id:str, metadata) -> strReturn manual checkpoint text for status output.
func
release.kfpr.steps.pull_if_upstream(context:ReleaseContext) -> NoneFast-forward pull only when the current branch tracks an upstream.
func
release.kfpr.steps.run_steps(context:ReleaseContext) -> NoneExecute release steps in order, skipping completed ones.
func
release.kfpr.steps.step_cherry_pick_prs(context:ReleaseContext) -> NoneCherry-pick requested PRs.
func
release.kfpr.steps.step_confirm_rtd(context:ReleaseContext) -> NoneConfirm ReadTheDocs version updates.
func
release.kfpr.steps.step_confirm_website_and_slack(context:ReleaseContext) -> NoneConfirm website PR and Slack announcement.
func
release.kfpr.steps.step_create_backend_release(context:ReleaseContext) -> NoneCreate backend GitHub release.
func
release.kfpr.steps.step_create_kfp_kubernetes_docs_branch(context:ReleaseContext) -> NoneCreate kfp-kubernetes docs branch for ReadTheDocs.
func
release.kfpr.steps.step_create_sdk_release(context:ReleaseContext) -> NoneCreate the SDK GitHub release after packages are published.
func
release.kfpr.steps.step_create_sdk_tag(context:ReleaseContext) -> NoneCreate the SDK tag without creating a GitHub release.
func
release.kfpr.steps.step_merge_cherry_pick_pr(context:ReleaseContext) -> NonePush patch branch and create PR for cherry-picks.
func
release.kfpr.steps.step_merge_version_pr(context:ReleaseContext) -> NonePush release branch and tag, create version PR.
func
release.kfpr.steps.step_preflight(context:ReleaseContext) -> NoneVerify required tools and GitHub authentication.
func
release.kfpr.steps.step_prepare_patch_branch(context:ReleaseContext) -> NoneCreate patch branch from release branch.
func
release.kfpr.steps.step_prepare_release_branch(context:ReleaseContext) -> NoneCreate release branch from the selected source branch.
func
release.kfpr.steps.step_publish_images(context:ReleaseContext) -> NoneTrigger and watch image publication workflow.
func
release.kfpr.steps.step_publish_sdks(context:ReleaseContext) -> NoneTrigger and watch SDK publication workflow.
func
release.kfpr.steps.step_sync_master(context:ReleaseContext) -> NoneSync release version to master branch.
func
release.kfpr.steps.step_update_version_tags(context:ReleaseContext) -> NoneUpdate version tags in repository files.
func
sdk.python.kfp.cli.compile_.is_component_func(func:Callable) -> boolChecks if a function is a component function.
func
sdk.python.kfp.cli.compile_.is_pipeline_func(func:Callable) -> boolChecks if a function is a pipeline function.
func
sdk.python.kfp.cli.component.component(ctx:click.Context)Builds shareable, containerized components.
class
sdk.python.kfp.cli.diagnose_me.dev_env.CommandsEnum for gcloud and gsutil commands.
class
sdk.python.kfp.cli.diagnose_me.gcp.CommandsEnum for gcloud and gsutil commands.
func
sdk.python.kfp.cli.diagnose_me.gcp.execute_gsutil_command(gsutil_command_list:List[Text], project_id:Optional[Text]=None) -> utility.ExecutorResponseFunction for invoking gsutil command.
class
sdk.python.kfp.cli.diagnose_me.kubernetes_cluster.CommandsEnum for kubernetes commands.
func
sdk.python.kfp.cli.diagnose_me.kubernetes_cluster.execute_kubectl_command(kubectl_command_list:List[Text], human_readable:bool=False) -> utility.ExecutorResponseInvokes the kubectl command.
class
sdk.python.kfp.cli.diagnose_me.utility.ExecutorResponseClass for keeping track of output of _executor methods.
method
sdk.python.kfp.cli.diagnose_me.utility.ExecutorResponse.execute_command(command_list:List[Text])Executes the command in command_list.
method
sdk.python.kfp.cli.diagnose_me.utility.ExecutorResponse.has_error() -> boolReturns true if execution error code was not 0.
method
sdk.python.kfp.cli.diagnose_me.utility.ExecutorResponse.json_output() -> TextRun results in stdout in json format.
func
sdk.python.kfp.cli.diagnose_me_cli.diagnose_me(ctx:click.Context, json:bool, project_id:str, namespace:str)Runs KFP environment diagnostic.
func
sdk.python.kfp.cli.experiment.archive(ctx:click.Context, experiment_id:str, experiment_name:str)Archive an experiment.
func
sdk.python.kfp.cli.experiment.create(ctx:click.Context, description:str, name:str)Create an experiment.
func
sdk.python.kfp.cli.experiment.delete(ctx:click.Context, experiment_id:str)Delete an experiment.
func
sdk.python.kfp.cli.experiment.experiment()Manage experiment resources.
func
sdk.python.kfp.cli.experiment.get(ctx:click.Context, experiment_id:str)Get information about an experiment.
func
sdk.python.kfp.cli.experiment.list(ctx:click.Context, page_token:str, max_size:int, sort_by:str, filter:str)List experiments.
func
sdk.python.kfp.cli.experiment.unarchive(ctx:click.Context, experiment_id:str, experiment_name:str)Unarchive an experiment.
class
sdk.python.kfp.cli.output.DatetimeEncoderJSON encoder for serializing datetime objects.
class
sdk.python.kfp.cli.output.ModelTypeEnumerated class with the allowed output format constants.
class
sdk.python.kfp.cli.output.OutputFormatEnumerated class with the allowed output format constants.
func
sdk.python.kfp.cli.output.print_output(resources:list, model_type:ModelType, output_format:str) -> NonePrints output in tabular or JSON format, using click.echo.
func
sdk.python.kfp.cli.pipeline.create(ctx:click.Context, pipeline_name:str, package_file:str, description:str=None)Upload a pipeline.
func
sdk.python.kfp.cli.pipeline.delete(ctx:click.Context, pipeline_id:str)Delete a pipeline.
func
sdk.python.kfp.cli.pipeline.delete_version(ctx:click.Context, pipeline_id:str, version_id:str)Delete a version of a pipeline.
func
sdk.python.kfp.cli.pipeline.get(ctx:click.Context, pipeline_id:str)Get information about a pipeline.
func
sdk.python.kfp.cli.pipeline.list(ctx:click.Context, page_token:str, max_size:int, sort_by:str, filter:str)List pipelines.
func
sdk.python.kfp.cli.pipeline.list_versions(ctx:click.Context, pipeline_id:str, page_token:str, max_size:int, sort_by:str, filter:str)List versions of a pipeline.
func
sdk.python.kfp.cli.pipeline.pipeline()Manage pipeline resources.
func
sdk.python.kfp.cli.recurring_run.delete(ctx:click.Context, recurring_run_id:str)Delete a recurring run.
func
sdk.python.kfp.cli.recurring_run.disable(ctx:click.Context, recurring_run_id:str)Disable a recurring run.
func
sdk.python.kfp.cli.recurring_run.enable(ctx:click.Context, recurring_run_id:str)Enable a recurring run.
func
sdk.python.kfp.cli.recurring_run.get(ctx:click.Context, recurring_run_id:str)Get information about a recurring run.
func
sdk.python.kfp.cli.recurring_run.list(ctx:click.Context, experiment_id:str, page_token:str, max_size:int, sort_by:str, filter:str)List recurring runs.
func
sdk.python.kfp.cli.recurring_run.recurring_run()Manage recurring run resources.
func
sdk.python.kfp.cli.run.archive(ctx:click.Context, run_id:str)Archive a pipeline run.
func
sdk.python.kfp.cli.run.delete(ctx:click.Context, run_id:str)Delete a pipeline run.
func
sdk.python.kfp.cli.run.get(ctx:click.Context, watch:bool, detail:bool, run_id:str)Get information about a pipeline run.
func
sdk.python.kfp.cli.run.list(ctx:click.Context, experiment_id:str, page_token:str, max_size:int, sort_by:str, filter:str)List pipeline runs.
func
sdk.python.kfp.cli.run.run()Manage run resources.
func
sdk.python.kfp.cli.run.unarchive(ctx:click.Context, run_id:str)Unarchive a pipeline run.
func
sdk.python.kfp.cli.utils.parsing.parse_parameter_value(value:str) -> AnyParse a CLI string value into the appropriate Python type.
class
sdk.python.kfp.client.auth.RedirectWSGIAppWSGI app to handle the authorization redirect.
func
sdk.python.kfp.client.auth.fetch_auth_token_from_response(url:str) -> strFetches authorization code for OAuth2.0 Loopback flow.
func
sdk.python.kfp.client.auth.get_auth_code(client_id:str) -> Tuple[str, str]Retrieves authorization token using Loopback flow.
func
sdk.python.kfp.client.auth.get_auth_token_from_sa(client_id:str) -> Optional[str]Gets auth token from default service account.
func
sdk.python.kfp.client.auth.id_token_from_refresh_token(client_id:str, client_secret:str, refresh_token:str, audience:str) -> strReturns ID token from refresh token.
func
sdk.python.kfp.client.auth.is_ipython() -> boolReturns whether we are running in notebook.
class
sdk.python.kfp.client.client.ClientThe KFP SDK client for the Kubeflow Pipelines backend API.
method
sdk.python.kfp.client.client.Client.archive_experiment(experiment_id:str) -> dictArchives an experiment.
method
sdk.python.kfp.client.client.Client.archive_run(run_id:str) -> dictArchives a run.
method
sdk.python.kfp.client.client.Client.create_experiment(name:str, description:str=None, namespace:str=None) -> kfp_server_api.V2beta1ExperimentCreates a new experiment.
method
sdk.python.kfp.client.client.Client.delete_experiment(experiment_id:str) -> dictDelete experiment.
method
sdk.python.kfp.client.client.Client.delete_job(job_id:str) -> dictDeletes a job (recurring run).
method
sdk.python.kfp.client.client.Client.delete_pipeline(pipeline_id:str) -> dictDeletes a pipeline.
method
sdk.python.kfp.client.client.Client.delete_pipeline_version(pipeline_id:str, pipeline_version_id:str) -> dictDeletes a pipeline version.p.
method
sdk.python.kfp.client.client.Client.delete_recurring_run(recurring_run_id:str) -> dictDeletes a recurring run.
method
sdk.python.kfp.client.client.Client.delete_run(run_id:str) -> dictDeletes a run.
method
sdk.python.kfp.client.client.Client.disable_job(job_id:str) -> dictDisables a job (recurring run).
method
sdk.python.kfp.client.client.Client.disable_recurring_run(recurring_run_id:str) -> dictDisables a recurring run.
method
sdk.python.kfp.client.client.Client.enable_job(job_id:str) -> dictEnables a job (recurring run).
method
sdk.python.kfp.client.client.Client.enable_recurring_run(recurring_run_id:str) -> dictEnables a recurring run.
method
sdk.python.kfp.client.client.Client.get_experiment(experiment_id:Optional[str]=None, experiment_name:Optional[str]=None, namespace:Optional[str]=None) -> kfp_server_api.V2beta1ExperimentGets details of an experiment.
method
sdk.python.kfp.client.client.Client.get_kfp_healthz(sleep_duration:int=5) -> kfp_server_api.V2beta1GetHealthzResponseGets healthz info for KFP deployment.
method
sdk.python.kfp.client.client.Client.get_pipeline(pipeline_id:str) -> kfp_server_api.V2beta1PipelineGets pipeline details.
method
sdk.python.kfp.client.client.Client.get_pipeline_id(name:str) -> Optional[str]Gets the ID of a pipeline by its name.
method
sdk.python.kfp.client.client.Client.get_pipeline_version(pipeline_id:str, pipeline_version_id:str) -> kfp_server_api.V2beta1PipelineVersionGets a pipeline version.
method
sdk.python.kfp.client.client.Client.get_recurring_run(recurring_run_id:str, job_id:Optional[str]=None) -> kfp_server_api.V2beta1RecurringRunGets recurring run details.
method
sdk.python.kfp.client.client.Client.get_run(run_id:str) -> kfp_server_api.V2beta1RunGets run details.
method
sdk.python.kfp.client.client.Client.get_user_namespace() -> strGets user namespace in context config.
method
sdk.python.kfp.client.client.Client.list_experiments(page_token:str='', page_size:int=10, sort_by:str='', namespace:Optional[str]=None, filter:Optional[str]=None) -> kfp_server_api.V2beta1ListExperimentsResponseLists experiments.
method
sdk.python.kfp.client.client.Client.list_pipeline_versions(pipeline_id:str, page_token:str='', page_size:int=10, sort_by:str='', filter:Optional[str]=None) -> kfp_server_api.V2beta1ListPipelineVersionsResponseLists pipeline versions.
method
sdk.python.kfp.client.client.Client.list_pipelines(page_token:str='', page_size:int=10, sort_by:str='', filter:Optional[str]=None, namespace:Optional[str]=None) -> kfp_server_api.V2beta1ListPipelinesResponseLists pipelines.
method
sdk.python.kfp.client.client.Client.list_runs(page_token:str='', page_size:int=10, sort_by:str='', experiment_id:Optional[str]=None, namespace:Optional[str]=None, filter:Optional[str]=None) -> kfp_server_api.V2beta1ListRunsResponseList runs.
method
sdk.python.kfp.client.client.Client.set_user_namespace(namespace:str) -> NoneSets the namespace in the Kuberenetes cluster to use.
method
sdk.python.kfp.client.client.Client.terminate_run(run_id:str) -> dictTerminates a run.
method
sdk.python.kfp.client.client.Client.unarchive_experiment(experiment_id:str) -> dictUnarchives an experiment.
method
sdk.python.kfp.client.client.Client.unarchive_run(run_id:str) -> dictRestores an archived run.
method
sdk.python.kfp.client.client.Client.upload_pipeline(pipeline_package_path:str, pipeline_name:Optional[str]=None, description:Optional[str]=None, namespace:Optional[str]=None) -> kfp_server_api.V2beta1PipelineUploads a pipeline.
method
sdk.python.kfp.client.client.Client.wait_for_run_completion(run_id:str, timeout:int, sleep_duration:int=5) -> kfp_server_api.V2beta1RunWaits for a run to complete.
func
sdk.python.kfp.client.token_credentials_base.read_token_from_file(path:Optional[str]=None) -> strReads a token found in some file.
func
sdk.python.kfp.compiler.compiler_utils.recursive_replace_placeholders(data:Any, old_value:str, new_value:str) -> Union[Dict, List, str]Replaces the given data.
func
sdk.python.kfp.compiler.pipeline_spec_builder.build_component_spec_for_exit_task(task:pipeline_task.PipelineTask) -> pipeline_spec_pb2.ComponentSpecBuilds ComponentSpec for an exit task.
func
sdk.python.kfp.components.load_yaml_utilities.load_component_from_file(file_path:str) -> yaml_component.YamlComponentLoads a component from a file.
func
sdk.python.kfp.components.load_yaml_utilities.load_component_from_text(text:str) -> yaml_component.YamlComponentLoads a component from text.
func
sdk.python.kfp.components.load_yaml_utilities.load_component_from_url(url:str, auth:Optional[Tuple[str, str]]=None) -> yaml_component.YamlComponentLoads a component from a URL.
class
sdk.python.kfp.dsl.base_component.BaseComponentBase class for a component.
class
sdk.python.kfp.dsl.component_factory.ComponentInfoA dataclass capturing registered components.
func
sdk.python.kfp.dsl.component_factory.get_name_to_specs(signature:inspect.Signature, containerized:bool=False) -> Tuple[Dict[str, Any], Dict[str, Any]]Returns two dictionaries.
class
sdk.python.kfp.dsl.container_component_class.ContainerComponentComponent defined via pre-built container.
class
sdk.python.kfp.dsl.executor.ExecutorExecutor executes Python function components.
class
sdk.python.kfp.dsl.for_loop.LoopArgumentVariableRepresents a subvariable for a loop argument.
class
sdk.python.kfp.dsl.graph_component.GraphComponentA component defined via @dsl.pipeline decorator.
class
sdk.python.kfp.dsl.importer_component.ImporterComponentComponent defined via dsl.importer.
class
sdk.python.kfp.dsl.kfp_config.KFPConfigClass for managing KFP component configuration.
method
sdk.python.kfp.dsl.kfp_config.KFPConfig.add_component(function_name:str, path:pathlib.Path)Adds a KFP component.
method
sdk.python.kfp.dsl.kfp_config.KFPConfig.get_components() -> Dict[str, pathlib.Path]Returns a list of known KFP components.
method
sdk.python.kfp.dsl.kfp_config.KFPConfig.save()Writes out a KFP config file.
class
sdk.python.kfp.dsl.pipeline_channel.PipelineArtifactChannelRepresents a pipeline artifact channel.
class
sdk.python.kfp.dsl.pipeline_channel.PipelineParameterChannelRepresents a pipeline parameter channel.
class
sdk.python.kfp.dsl.pipeline_config.PipelineConfigPipelineConfig contains pipeline-level config options.
class
sdk.python.kfp.dsl.pipeline_context.PipelineA pipeline contains a list of tasks.
method
sdk.python.kfp.dsl.pipeline_context.Pipeline.add_task(task:pipeline_task.PipelineTask, add_to_group:bool) -> strAdds a new task.
method
sdk.python.kfp.dsl.pipeline_context.Pipeline.get_default_pipeline()Gets the default pipeline.
method
sdk.python.kfp.dsl.pipeline_context.Pipeline.get_next_group_id() -> strGets the next id for a new group.
method
sdk.python.kfp.dsl.pipeline_context.Pipeline.push_tasks_group(group:'tasks_group.TasksGroup')Pushes a TasksGroup into the stack.
method
sdk.python.kfp.dsl.pipeline_context.Pipeline.remove_task_from_groups(task:pipeline_task.PipelineTask)Removes a task from the pipeline.
class
sdk.python.kfp.dsl.pipeline_task.PipelineTaskRepresents a pipeline task (instantiated component).
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.add_node_selector_constraint(accelerator:str) -> 'PipelineTask'Deprecated.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.dependent_tasks() -> List[str]A list of the dependent task names.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.inputs() -> Dict[str, Union[type_utils.PARAMETER_TYPES, pipeline_channel.PipelineChannel]]The inputs passed to the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.name() -> strThe name of the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.output() -> pipeline_channel.PipelineChannelThe single output of the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.outputs() -> Mapping[str, pipeline_channel.PipelineChannel]The dictionary of outputs of the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_accelerator_limit(limit:Union[int, str, pipeline_channel.PipelineChannel]) -> 'PipelineTask'Sets accelerator limit (maximum) for the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_caching_options(enable_caching:bool, cache_key:Optional[str]=None) -> 'PipelineTask'Sets caching options for the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_cpu_limit(cpu:Union[str, pipeline_channel.PipelineChannel]) -> 'PipelineTask'Sets CPU limit (maximum) for the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_cpu_request(cpu:Union[str, pipeline_channel.PipelineChannel]) -> 'PipelineTask'Sets CPU request (minimum) for the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_display_name(name:str) -> 'PipelineTask'Sets display name for the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_env_variable(name:str, value:str) -> 'PipelineTask'Sets environment variable for the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_gpu_limit(gpu:str) -> 'PipelineTask'Sets GPU limit (maximum) for the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_memory_limit(memory:Union[str, pipeline_channel.PipelineChannel]) -> 'PipelineTask'Sets memory limit (maximum) for the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_memory_request(memory:Union[str, pipeline_channel.PipelineChannel]) -> 'PipelineTask'Sets memory request (minimum) for the task.
method
sdk.python.kfp.dsl.pipeline_task.PipelineTask.set_retry(num_retries:int, backoff_duration:Optional[str]=None, backoff_factor:Optional[float]=None, backoff_max_duration:Optional[str]=None) -> 'PipelineTask'Sets task retry parameters.
class
sdk.python.kfp.dsl.placeholders.ConcatPlaceholderPlaceholder for concatenating multiple strings.
class
sdk.python.kfp.dsl.python_component.PythonComponentA component defined via Python function.
class
sdk.python.kfp.dsl.structures.ComponentSpecThe definition of a component.
method
sdk.python.kfp.dsl.structures.ComponentSpec.from_v1_component_spec(v1_component_spec:v1_structures.ComponentSpec) -> 'ComponentSpec'Converts V1 ComponentSpec to V2 ComponentSpec.
method
sdk.python.kfp.dsl.structures.ComponentSpec.from_yaml_documents(component_yaml:str) -> 'ComponentSpec'Loads V1 or V2 component YAML into a ComponentSpec.
method
sdk.python.kfp.dsl.structures.ComponentSpec.save_to_component_yaml(output_file:str) -> NoneSaves ComponentSpec into IR YAML file.
class
sdk.python.kfp.dsl.structures.ContainerSpecContainer definition.
class
sdk.python.kfp.dsl.structures.ContainerSpecImplementationContainer implementation definition.
class
sdk.python.kfp.dsl.structures.ImplementationImplementation definition.
class
sdk.python.kfp.dsl.structures.ImporterSpecImporterSpec definition.
class
sdk.python.kfp.dsl.structures.InputSpecComponent input definitions.
class
sdk.python.kfp.dsl.structures.OutputSpecComponent output definitions.
class
sdk.python.kfp.dsl.structures.ResourceSpecThe resource requirements of a container execution.
class
sdk.python.kfp.dsl.structures.RetryPolicyThe retry policy of a container execution.
class
sdk.python.kfp.dsl.structures.TaskSpecThe spec of a pipeline task.
func
sdk.python.kfp.dsl.structures.convert_duration_to_seconds(duration:str) -> intConverts a duration string to seconds.
func
sdk.python.kfp.dsl.structures.load_documents_from_yaml(component_yaml:str) -> Tuple[dict, dict]Loads up to two YAML documents from a YAML string.
func
sdk.python.kfp.dsl.structures.normalize_time_string(duration:str) -> strNormalizes a time string.
class
sdk.python.kfp.dsl.task_config.TaskConfigConfigurations for a task.
class
sdk.python.kfp.dsl.task_final_status.PipelineTaskFinalStatusA final status of a pipeline task.
class
sdk.python.kfp.dsl.tasks_group.ConditionDeprecated.
class
sdk.python.kfp.dsl.tasks_group.TasksGroupTypeTypes of TasksGroup.
class
sdk.python.kfp.dsl.types.artifact_types.ArtifactRepresents a generic machine learning artifact.
class
sdk.python.kfp.dsl.types.artifact_types.ClassificationMetricsAn artifact for storing classification metrics.
method
sdk.python.kfp.dsl.types.artifact_types.ClassificationMetrics.log_confusion_matrix(categories:List[str], matrix:List[List[int]]) -> NoneLogs a confusion matrix to metadata.
method
sdk.python.kfp.dsl.types.artifact_types.ClassificationMetrics.log_confusion_matrix_row(row_category:str, row:List[float]) -> NoneLogs a confusion matrix row to metadata.
method
sdk.python.kfp.dsl.types.artifact_types.ClassificationMetrics.log_roc_curve(fpr:List[float], tpr:List[float], threshold:List[float]) -> NoneLogs an ROC curve to metadata.
method
sdk.python.kfp.dsl.types.artifact_types.ClassificationMetrics.set_confusion_matrix_categories(categories:List[str]) -> NoneStores confusion matrix categories to metadata.
class
sdk.python.kfp.dsl.types.artifact_types.DatasetAn artifact representing a machine learning dataset.
class
sdk.python.kfp.dsl.types.artifact_types.HTMLAn artifact representing an HTML file.
class
sdk.python.kfp.dsl.types.artifact_types.MarkdownAn artifact representing a markdown file.
class
sdk.python.kfp.dsl.types.artifact_types.MetricsAn artifact for storing key-value scalar metrics.
method
sdk.python.kfp.dsl.types.artifact_types.Metrics.log_metric(metric:str, value:float) -> NoneSets a custom scalar metric in the artifact's metadata.
class
sdk.python.kfp.dsl.types.artifact_types.ModelAn artifact representing a machine learning model.
func
sdk.python.kfp.dsl.types.custom_artifact_types.get_full_qualname_for_artifact(obj:type) -> strGets the fully qualified name for an object.
class
sdk.python.kfp.dsl.types.type_annotations.EmbeddedAnnotationMarker type for embedded runtime-only inputs.
class
sdk.python.kfp.dsl.types.type_annotations.InputAnnotationMarker type for input artifacts.
class
sdk.python.kfp.dsl.types.type_annotations.OutputAnnotationMarker type for output artifacts.
func
sdk.python.kfp.dsl.types.type_annotations.get_inner_type(annotation:Any) -> Optional[Any]Returns the inner type of a generic annotation.
func
sdk.python.kfp.dsl.types.type_annotations.get_short_type_name(type_name:str) -> strExtracts the short form type name.
func
sdk.python.kfp.dsl.types.type_annotations.is_artifact_wrapped_in_Input(typ:Any) -> boolReturns True if typ is of type Input[T].
func
sdk.python.kfp.dsl.types.type_annotations.is_artifact_wrapped_in_Output(typ:Any) -> boolReturns True if typ is of type Output[T].
func
sdk.python.kfp.dsl.types.type_annotations.maybe_strip_optional_from_annotation(annotation:T) -> TStrips 'Optional' from 'Optional[<type>]' if applicable.
func
sdk.python.kfp.dsl.types.type_utils.get_canonical_name_for_outer_generic(type_name:Any) -> strMaps a complex/nested type name back to a canonical type.
func
sdk.python.kfp.dsl.types.type_utils.get_canonical_type_name_for_type(typ:Type) -> Optional[str]Find the canonical type name for a given type.
func
sdk.python.kfp.dsl.types.type_utils.get_parameter_type_name(param_type:Optional[Union[Type, str, dict]]) -> strGets the parameter type name.
func
sdk.python.kfp.dsl.types.type_utils.is_task_config_type(type_name:Optional[Union[str, dict]]) -> boolCheck if a ComponentSpec I/O type is TaskConfig.
func
sdk.python.kfp.dsl.utils.make_name_unique_by_adding_index(name:str, collection:List[str], delimiter:str) -> strMakes a unique name by adding index.
func
sdk.python.kfp.dsl.utils.maybe_rename_for_k8s(name:str) -> strCleans and converts a name to be k8s compatible.
func
sdk.python.kfp.dsl.utils.sanitize_component_name(name:str) -> strSanitizes component name.
func
sdk.python.kfp.dsl.utils.sanitize_executor_label(label:str) -> strSanitizes executor label.
func
sdk.python.kfp.dsl.utils.sanitize_input_name(name:str) -> strSanitizes input name.
func
sdk.python.kfp.dsl.utils.sanitize_task_name(name:str) -> strSanitizes task name.
func
sdk.python.kfp.dsl.utils.validate_pipeline_name(name:str) -> NoneValidate pipeline name.
class
sdk.python.kfp.dsl.v1_structures.AndPredicateRepresents the "and" logical operation.
class
sdk.python.kfp.dsl.v1_structures.ComponentReferenceComponent reference.
class
sdk.python.kfp.dsl.v1_structures.ComponentSpecComponent specification.
class
sdk.python.kfp.dsl.v1_structures.ContainerImplementationRepresents the container component implementation.
class
sdk.python.kfp.dsl.v1_structures.ContainerSpecDescribes the container component implementation.
class
sdk.python.kfp.dsl.v1_structures.EqualsPredicateRepresents the "equals" comparison predicate.
class
sdk.python.kfp.dsl.v1_structures.GraphImplementationRepresents the graph component implementation.
class
sdk.python.kfp.dsl.v1_structures.GraphSpecDescribes the graph component implementation.
class
sdk.python.kfp.dsl.v1_structures.GreaterThanPredicateRepresents the "greater than" comparison predicate.
class
sdk.python.kfp.dsl.v1_structures.InputSpecDescribes the component input specification.
class
sdk.python.kfp.dsl.v1_structures.LessThenPredicateRepresents the "less than" comparison predicate.
class
sdk.python.kfp.dsl.v1_structures.NotEqualsPredicateRepresents the "not equals" comparison predicate.
class
sdk.python.kfp.dsl.v1_structures.NotPredicateRepresents the "not" logical operation.
class
sdk.python.kfp.dsl.v1_structures.OrPredicateRepresents the "or" logical operation.
class
sdk.python.kfp.dsl.v1_structures.OutputSpecDescribes the component output specification.
class
sdk.python.kfp.dsl.v1_structures.TaskSpecTask specification.
class
sdk.python.kfp.dsl.yaml_component.YamlComponentA component loaded from a YAML file.
method
sdk.python.kfp.dsl.yaml_component.YamlComponent.execute(*args, **kwargs)Not implemented.
func
sdk.python.kfp.kubeflow_client.backends.kubernetes.utils.discover_host(namespace:str) -> strAuto-discover the KFP API server endpoint.
class
sdk.python.kfp.local.cache.LocalCacheThread-safe, file-backed cache for local task outputs.
method
sdk.python.kfp.local.cache.LocalCache.get(key:str) -> Optional[Dict[str, Any]]Retrieves cached outputs for `key`, or None on cache miss.
method
sdk.python.kfp.local.cache.LocalCache.put(key:str, outputs:Dict[str, Any]) -> NonePersists `outputs` under `key`, atomically.
func
sdk.python.kfp.local.cache.reset_local_cache_singleton() -> NoneTest hook: clears the module-level cache singleton.
class
sdk.python.kfp.local.config.LocalRunnerTypeThe ABC for user-facing Runner configurations.
class
sdk.python.kfp.local.docker_task_handler.DockerTaskHandlerThe task handler corresponding to DockerRunner.
func
sdk.python.kfp.local.executor_input_utils.dict_to_protobuf_struct(d:Dict[str, Any]) -> struct_pb2.StructConverts a Python dictionary to a prototobuf Struct.
func
sdk.python.kfp.local.executor_output_utils.load_executor_output(executor_output_path:str) -> pipeline_spec_pb2.ExecutorOutputLoads the ExecutorOutput message from a path.
func
sdk.python.kfp.local.executor_output_utils.pb2_struct_to_python(struct:struct_pb2.Struct) -> Dict[str, Any]Converts protobuf Struct to a dict.
func
sdk.python.kfp.local.executor_output_utils.pb2_value_to_python(value:struct_pb2.Value) -> AnyConverts protobuf Value to the corresponding Python type.
class
sdk.python.kfp.local.io.IOStoreIn-memory store of a DAG's parameter/artifact state.
method
sdk.python.kfp.local.io.IOStore.get_task_output(task_name:str, key:str) -> AnyGet the value of an upstream task output.
method
sdk.python.kfp.local.io.IOStore.get_task_status(task_name:str) -> strGet the final status of a task.
method
sdk.python.kfp.local.io.IOStore.put_task_output(task_name:str, key:str, value:Any) -> NonePersist the value of an upstream task output.
method
sdk.python.kfp.local.io.IOStore.put_task_status(task_name:str, task_status:str) -> NonePersist the final status of a task.
func
sdk.python.kfp.local.placeholder_utils.make_random_id() -> strMakes a random 8 digit integer as a string.
class
sdk.python.kfp.local.task_handler_interface.ITaskHandlerInterface for a TaskHandler.
method
sdk.python.kfp.local.task_handler_interface.ITaskHandler.run() -> status.StatusRuns the task and returns the status.
func
sdk.python.kfp.local.testing_utilities.write_proto_to_json_file(proto_message:message.Message, file_path:str) -> NoneWrites proto_message to file_path as JSON.
class
sdk.python.kfp.registry.registry_client.ApiAuthClass for registry authentication using an API token.
class
sdk.python.kfp.registry.registry_client.RegistryClientClass for communicating with registry hosts.
method
sdk.python.kfp.registry.registry_client.RegistryClient.create_tag(package_name:str, version:str, tag:str) -> Dict[str, Any]Creates a tag on a package version.
method
sdk.python.kfp.registry.registry_client.RegistryClient.delete_package(package_name:str) -> boolDeletes a package.
method
sdk.python.kfp.registry.registry_client.RegistryClient.delete_tag(package_name:str, tag:str) -> Dict[str, Any]Deletes package tag.
method
sdk.python.kfp.registry.registry_client.RegistryClient.delete_version(package_name:str, version:str) -> boolDeletes package version.
method
sdk.python.kfp.registry.registry_client.RegistryClient.download_pipeline(package_name:str, version:Optional[str]=None, tag:Optional[str]=None, file_name:Optional[str]=None) -> strDownloads a pipeline.
method
sdk.python.kfp.registry.registry_client.RegistryClient.get_package(package_name:str) -> Dict[str, Any]Gets package metadata.
method
sdk.python.kfp.registry.registry_client.RegistryClient.get_tag(package_name:str, tag:str) -> Dict[str, Any]Gets tag metadata.
method
sdk.python.kfp.registry.registry_client.RegistryClient.get_version(package_name:str, version:str) -> Dict[str, Any]Gets package version metadata.
method
sdk.python.kfp.registry.registry_client.RegistryClient.list_packages() -> List[dict]Lists packages.
method
sdk.python.kfp.registry.registry_client.RegistryClient.list_tags(package_name:str) -> List[dict]Lists package tags.
method
sdk.python.kfp.registry.registry_client.RegistryClient.list_versions(package_name:str) -> List[dict]Lists package versions.
method
sdk.python.kfp.registry.registry_client.RegistryClient.update_tag(package_name:str, version:str, tag:str) -> Dict[str, Any]Updates a tag to another package version.
method
sdk.python.kfp.registry.registry_client.RegistryClient.upload_pipeline(file_name:str, tags:Optional[Union[str, List[str]]]=None, extra_headers:Optional[dict]=None) -> Tuple[str, str]Uploads the pipeline.
func
test_data.sdk_compiled_pipelines.valid.component_with_metadata_fields.dataset_joiner(dataset_a:Input[Dataset], dataset_b:Input[Dataset], out_dataset:Output[Dataset]) -> strConcatenate dataset_a and dataset_b.
func
test_data.sdk_compiled_pipelines.valid.critical.flip_coin.flip_coin() -> strFlip a coin and output heads or tails randomly.
func
test_data.sdk_compiled_pipelines.valid.critical.flip_coin.print_msg(msg:str)Print a message.
func
test_data.sdk_compiled_pipelines.valid.critical.flip_coin.random_num(low:int, high:int) -> intGenerate a random number between low and high.
func
test_data.sdk_compiled_pipelines.valid.critical.pipeline_with_importer_workspace.train(dataset:dsl.Input[dsl.Dataset]) -> NamedTuple('Outputs', [('scalar', str), ('message', str)])Dummy Training step.
func
test_data.sdk_compiled_pipelines.valid.critical.pipeline_with_workspace.write_to_workspace(workspace_path:str) -> strWrite a file to the workspace.
func
test_data.sdk_compiled_pipelines.valid.essential.pipeline_with_condition.print_op(msg:str)Print a message.
func
test_data.sdk_compiled_pipelines.valid.essential.pipeline_with_nested_conditions.print_op(msg:str)Print a message.
func
test_data.sdk_compiled_pipelines.valid.failing.fail_v2.fail()Fails
func
test_data.sdk_compiled_pipelines.valid.failing.pipeline_with_exit_handler.fail_op(message:str)Fails.
func
test_data.sdk_compiled_pipelines.valid.failing.pipeline_with_exit_handler.print_op(message:str)Prints a message.
func
test_data.sdk_compiled_pipelines.valid.failing.pipeline_with_multiple_exit_handlers.fail_op(message:str)Fails.
func
test_data.sdk_compiled_pipelines.valid.failing.pipeline_with_multiple_exit_handlers.print_op(message:str)Prints a message.
func
test_data.sdk_compiled_pipelines.valid.parallel_and_nested.nested_parallel_for_secret.emit_secret_name() -> strEmits the secret name dynamically.
func
test_data.sdk_compiled_pipelines.valid.pipeline_as_exit_task.exit_op(status:PipelineTaskFinalStatus)Checks pipeline run status.
func
test_data.sdk_compiled_pipelines.valid.pipeline_as_exit_task.fail_op(message:str)Fails.
func
test_data.sdk_compiled_pipelines.valid.pipeline_as_exit_task.print_op(message:str)Prints a message.
func
test_data.sdk_compiled_pipelines.valid.pipeline_with_importer.train(dataset:Input[Dataset]) -> NamedTuple('Outputs', [('scalar', str), ('model', Model)])Dummy Training step.
func
test_data.sdk_compiled_pipelines.valid.pipeline_with_metadata_fields.dataset_joiner(dataset_a:Input[Dataset], dataset_b:Input[Dataset], out_dataset:Output[Dataset]) -> strConcatenate dataset_a and dataset_b.
func
test_data.sdk_compiled_pipelines.valid.pipeline_with_metadata_fields.str_to_dataset(string:str, dataset:Output[Dataset])Convert string to dataset.
func
test_data.sdk_compiled_pipelines.valid.pipeline_with_task_final_status.exit_op(user_input:str, status:PipelineTaskFinalStatus)Checks pipeline run status.
func
test_data.sdk_compiled_pipelines.valid.pipeline_with_task_final_status.fail_op(message:str)Fails.
func
test_data.sdk_compiled_pipelines.valid.pipeline_with_task_final_status.print_op(message:str)Prints a message.
func
test_data.sdk_compiled_pipelines.valid.pipeline_with_task_using_ignore_upstream_failure.fail_op(message:str) -> strFails.
func
test_data.sdk_compiled_pipelines.valid.pipeline_with_task_using_ignore_upstream_failure.print_op(message:str='default')Prints a message.
func
test_data.sdk_compiled_pipelines.valid.pvc_mount_subpath.read_from_logs() -> NoneReads data from the logs subdirectory.
func
test_data.sdk_compiled_pipelines.valid.pvc_mount_subpath.read_from_models() -> NoneReads data from the models subdirectory.
func
test_data.sdk_compiled_pipelines.valid.pvc_mount_subpath.write_to_logs() -> NoneWrites data to the logs subdirectory.
func
test_data.sdk_compiled_pipelines.valid.pvc_mount_subpath.write_to_models() -> NoneWrites data to the models subdirectory.
func
test_data.sdk_compiled_pipelines.valid.take_nap.take_nap(naptime_secs:int) -> strSleeps for secs
func
test_data.sdk_compiled_pipelines.valid.take_nap.wake_up(message:str)Wakes up from nap printing a message
func
test_data.sdk_compiled_pipelines.valid.take_nap_pipeline_root.take_nap(naptime_secs:int) -> strSleeps for secs
func
test_data.sdk_compiled_pipelines.valid.take_nap_pipeline_root.wake_up(message:str)Wakes up from nap printing a message
この情報について
掲載しているシグネチャは kubeflow/pipelines の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。