From 6200a91d35408b986a75b154d8ac67a4dcf93b28 Mon Sep 17 00:00:00 2001 From: "unionai-docsy-bot[bot]" <295918299+unionai-docsy-bot[bot]@users.noreply.github.com> Date: Mon, 5 Oct 2026 13:47:06 +0000 Subject: [PATCH] docs(api-reference): regenerate v1 API docs (automated) Signed-off-by: unionai-docsy-bot[bot] <295918299+unionai-docsy-bot[bot]@users.noreply.github.com> --- content/api-reference/flytekit-sdk/_index.md | 2 +- .../flytekit-sdk/flytekit.bin.entrypoint.md | 2 +- .../flytekit.clients.auth.auth_client.md | 2 +- .../flytekit.clients.auth.authenticator.md | 2 +- .../flytekit.clients.auth.default_html.md | 2 +- .../flytekit.clients.auth.exceptions.md | 2 +- .../flytekit.clients.auth.keyring.md | 2 +- .../flytekit.clients.auth.token_client.md | 2 +- .../flytekit.clients.auth_helper.md | 2 +- .../flytekit-sdk/flytekit.clients.friendly.md | 2 +- ...kit.clients.grpc_utils.auth_interceptor.md | 2 +- ...clients.grpc_utils.deadline_interceptor.md | 2 +- ...grpc_utils.default_metadata_interceptor.md | 2 +- ...s.grpc_utils.wrap_exception_interceptor.md | 2 +- .../flytekit-sdk/flytekit.clients.helpers.md | 2 +- .../flytekit-sdk/flytekit.clients.raw.md | 2 +- .../flytekit-sdk/flytekit.clis.helpers.md | 2 +- ...flytekit.clis.sdk_in_container.backfill.md | 2 +- .../flytekit.clis.sdk_in_container.build.md | 4 +-- ...lytekit.clis.sdk_in_container.constants.md | 2 +- ...ytekit.clis.sdk_in_container.executions.md | 2 +- .../flytekit.clis.sdk_in_container.helpers.md | 2 +- .../flytekit.clis.sdk_in_container.metrics.md | 2 +- .../flytekit.clis.sdk_in_container.package.md | 2 +- .../flytekit.clis.sdk_in_container.pyflyte.md | 2 +- .../flytekit.clis.sdk_in_container.run.md | 12 ++----- ...lytekit.clis.sdk_in_container.serialize.md | 2 +- .../flytekit.clis.sdk_in_container.serve.md | 2 +- .../flytekit.clis.sdk_in_container.utils.md | 2 +- .../flytekit-sdk/flytekit.clis.version.md | 2 +- .../flytekit.configuration.default_images.md | 2 +- .../flytekit.configuration.feature_flags.md | 2 +- .../flytekit.configuration.file.md | 2 +- .../flytekit.configuration.internal.md | 2 +- .../flytekit-sdk/flytekit.configuration.md | 6 ++-- .../flytekit.configuration.plugin.md | 2 +- .../flytekit-sdk/flytekit.constants.md | 2 +- .../flytekit-sdk/flytekit.core.annotation.md | 2 +- .../flytekit-sdk/flytekit.core.array_node.md | 2 +- .../flytekit.core.array_node_map_task.md | 2 +- .../flytekit-sdk/flytekit.core.artifact.md | 2 +- .../flytekit.core.artifact_utils.md | 2 +- .../flytekit.core.base_sql_task.md | 2 +- .../flytekit-sdk/flytekit.core.base_task.md | 2 +- .../flytekit-sdk/flytekit.core.cache.md | 2 +- .../flytekit.core.checkpointer.md | 2 +- .../flytekit.core.class_based_resolver.md | 2 +- .../flytekit-sdk/flytekit.core.condition.md | 2 +- .../flytekit-sdk/flytekit.core.constants.md | 2 +- .../flytekit.core.container_task.md | 2 +- .../flytekit.core.context_manager.md | 2 +- .../flytekit.core.data_persistence.md | 4 ++- .../flytekit-sdk/flytekit.core.docstring.md | 2 +- .../flytekit-sdk/flytekit.core.environment.md | 12 +------ .../flytekit-sdk/flytekit.core.gate.md | 2 +- .../flytekit-sdk/flytekit.core.hash.md | 2 +- .../flytekit-sdk/flytekit.core.interface.md | 2 +- .../flytekit-sdk/flytekit.core.launch_plan.md | 2 +- .../flytekit.core.legacy_map_task.md | 2 +- .../flytekit-sdk/flytekit.core.local_cache.md | 2 +- .../flytekit.core.local_fsspec.md | 2 +- .../flytekit-sdk/flytekit.core.mock_stats.md | 2 +- .../flytekit-sdk/flytekit.core.node.md | 2 +- .../flytekit.core.node_creation.md | 2 +- .../flytekit.core.notification.md | 2 +- .../flytekit-sdk/flytekit.core.options.md | 2 +- .../flytekit.core.pod_template.md | 2 +- .../flytekit-sdk/flytekit.core.promise.md | 6 +--- .../flytekit.core.python_auto_container.md | 2 +- ...t.core.python_customized_container_task.md | 4 +-- .../flytekit.core.python_function_task.md | 2 +- .../flytekit-sdk/flytekit.core.reference.md | 2 +- .../flytekit.core.reference_entity.md | 2 +- .../flytekit-sdk/flytekit.core.resources.md | 2 +- .../flytekit-sdk/flytekit.core.schedule.md | 2 +- .../flytekit-sdk/flytekit.core.shim_task.md | 4 +-- .../flytekit-sdk/flytekit.core.task.md | 6 +--- .../flytekit-sdk/flytekit.core.testing.md | 2 +- .../flytekit-sdk/flytekit.core.tracked_abc.md | 2 +- .../flytekit-sdk/flytekit.core.tracker.md | 2 +- .../flytekit-sdk/flytekit.core.type_engine.md | 2 +- .../flytekit.core.type_helpers.md | 2 +- .../flytekit.core.type_match_checking.md | 2 +- .../flytekit-sdk/flytekit.core.utils.md | 2 +- .../flytekit.core.worker_queue.md | 2 +- .../flytekit-sdk/flytekit.core.workflow.md | 4 +-- .../flytekit-sdk/flytekit.deck.deck.md | 2 +- .../flytekit-sdk/flytekit.deck.renderer.md | 2 +- .../flytekit-sdk/flytekit.exceptions.base.md | 2 +- .../flytekit-sdk/flytekit.exceptions.eager.md | 2 +- .../flytekit.exceptions.scopes.md | 2 +- .../flytekit.exceptions.system.md | 2 +- .../flytekit-sdk/flytekit.exceptions.user.md | 2 +- .../flytekit-sdk/flytekit.exceptions.utils.md | 2 +- .../flytekit.experimental.eager_function.md | 2 +- .../flytekit.extend.backend.base_connector.md | 2 +- ...ytekit.extend.backend.connector_service.md | 6 +--- .../flytekit.extend.backend.utils.md | 2 +- .../flytekit.extras.accelerators.md | 2 +- .../flytekit.extras.cloud_pickle_resolver.md | 2 +- ...extras.pydantic_transformer.transformer.md | 2 +- .../flytekit.extras.sklearn.native.md | 2 +- .../flytekit.extras.sqlite3.task.md | 4 +-- .../flytekit.extras.tasks.shell.md | 2 +- .../flytekit.extras.webhook.connector.md | 2 +- .../flytekit.extras.webhook.constants.md | 2 +- .../flytekit-sdk/flytekit.extras.webhook.md | 2 +- .../flytekit.extras.webhook.task.md | 2 +- .../flytekit.image_spec.default_builder.md | 2 +- .../flytekit.image_spec.image_spec.md | 2 +- .../flytekit.image_spec.noop_builder.md | 2 +- .../flytekit.interaction.click_types.md | 8 +---- .../flytekit.interaction.parse_stdin.md | 2 +- .../flytekit.interaction.rich_utils.md | 2 +- .../flytekit.interaction.string_literals.md | 2 +- .../flytekit.interactive.constants.md | 2 +- .../flytekit-sdk/flytekit.interactive.md | 2 +- .../flytekit.interactive.utils.md | 2 +- .../flytekit.interactive.vscode_lib.config.md | 2 +- ...ytekit.interactive.vscode_lib.decorator.md | 2 +- ...interactive.vscode_lib.vscode_constants.md | 2 +- .../flytekit.interfaces.cli_identifiers.md | 2 +- .../flytekit.interfaces.random.md | 2 +- .../flytekit.interfaces.stats.client.md | 2 +- .../flytekit.interfaces.stats.taggable.md | 2 +- .../flytekit.lazy_import.lazy_module.md | 2 +- .../flytekit-sdk/flytekit.loggers.md | 2 +- .../api-reference/flytekit-sdk/flytekit.md | 2 +- .../flytekit.models.admin.common.md | 2 +- .../flytekit.models.admin.task_execution.md | 2 +- .../flytekit.models.admin.workflow.md | 2 +- .../flytekit.models.annotation.md | 2 +- .../flytekit-sdk/flytekit.models.array_job.md | 2 +- .../flytekit-sdk/flytekit.models.common.md | 2 +- .../flytekit.models.concurrency.md | 2 +- .../flytekit.models.core.catalog.md | 2 +- .../flytekit.models.core.compiler.md | 2 +- .../flytekit.models.core.condition.md | 2 +- .../flytekit.models.core.errors.md | 2 +- .../flytekit.models.core.execution.md | 2 +- .../flytekit.models.core.identifier.md | 2 +- .../flytekit.models.core.types.md | 2 +- .../flytekit.models.core.workflow.md | 2 +- .../flytekit.models.documentation.md | 2 +- .../flytekit-sdk/flytekit.models.domain.md | 2 +- .../flytekit.models.dynamic_job.md | 2 +- .../flytekit-sdk/flytekit.models.event.md | 2 +- .../flytekit-sdk/flytekit.models.execution.md | 2 +- .../flytekit-sdk/flytekit.models.filters.md | 2 +- .../flytekit-sdk/flytekit.models.interface.md | 2 +- .../flytekit.models.launch_plan.md | 2 +- .../flytekit-sdk/flytekit.models.literals.md | 2 +- .../flytekit.models.matchable_resource.md | 2 +- .../flytekit.models.named_entity.md | 2 +- .../flytekit.models.node_execution.md | 2 +- .../flytekit-sdk/flytekit.models.presto.md | 2 +- .../flytekit-sdk/flytekit.models.project.md | 2 +- .../flytekit-sdk/flytekit.models.qubole.md | 2 +- .../flytekit-sdk/flytekit.models.schedule.md | 2 +- .../flytekit-sdk/flytekit.models.security.md | 2 +- .../flytekit-sdk/flytekit.models.task.md | 2 +- .../flytekit-sdk/flytekit.models.types.md | 2 +- .../flytekit.models.workflow_closure.md | 2 +- .../flytekit-sdk/flytekit.remote.backfill.md | 2 +- .../flytekit-sdk/flytekit.remote.data.md | 2 +- .../flytekit-sdk/flytekit.remote.entities.md | 2 +- .../flytekit.remote.executions.md | 2 +- .../flytekit-sdk/flytekit.remote.interface.md | 2 +- .../flytekit.remote.lazy_entity.md | 2 +- .../flytekit-sdk/flytekit.remote.metrics.md | 2 +- .../flytekit-sdk/flytekit.remote.remote.md | 2 +- .../flytekit.remote.remote_callable.md | 2 +- .../flytekit-sdk/flytekit.remote.remote_fs.md | 2 +- .../flytekit.sensor.base_sensor.md | 2 +- .../flytekit.sensor.file_sensor.md | 2 +- .../flytekit.sensor.sensor_engine.md | 2 +- .../flytekit.tools.fast_registration.md | 2 +- .../flytekit-sdk/flytekit.tools.ignore.md | 2 +- .../flytekit.tools.interactive.md | 2 +- .../flytekit.tools.module_loader.md | 2 +- .../flytekit-sdk/flytekit.tools.repo.md | 2 +- .../flytekit.tools.script_mode.md | 2 +- .../flytekit.tools.serialize_helpers.md | 2 +- .../flytekit-sdk/flytekit.tools.subprocess.md | 2 +- .../flytekit-sdk/flytekit.tools.translator.md | 2 +- .../flytekit-sdk/flytekit.types.directory.md | 2 +- .../flytekit.types.directory.types.md | 2 +- .../flytekit.types.error.error.md | 2 +- .../flytekit-sdk/flytekit.types.file.file.md | 2 +- .../flytekit-sdk/flytekit.types.file.image.md | 2 +- .../flytekit-sdk/flytekit.types.file.md | 2 +- .../flytekit.types.iterator.iterator.md | 2 +- .../flytekit.types.iterator.json_iterator.md | 2 +- .../flytekit.types.numpy.ndarray.md | 2 +- .../flytekit.types.pickle.pickle.md | 2 +- .../flytekit.types.schema.types.md | 2 +- .../flytekit.types.schema.types_pandas.md | 2 +- .../flytekit.types.structured.basic_dfs.md | 2 +- .../flytekit.types.structured.bigquery.md | 2 +- .../flytekit-sdk/flytekit.types.structured.md | 2 +- .../flytekit.types.structured.snowflake.md | 2 +- ...kit.types.structured.structured_dataset.md | 2 +- .../flytekit-sdk/flytekit.utils.asyn.md | 2 +- .../flytekit.utils.dict_formatter.md | 2 +- .../flytekit-sdk/flytekit.utils.pbhash.md | 2 +- .../flytekit.utils.rate_limiter.md | 2 +- .../api-reference/plugins/airflow/_index.md | 4 ++- .../flytekitplugins.airflow.connector.md | 3 +- .../airflow/flytekitplugins.airflow.task.md | 17 ++++----- .../plugins/async-fsspec/_index.md | 4 ++- ...ekitplugins.async_fsspec.s3fs.constants.md | 3 +- .../flytekitplugins.async_fsspec.s3fs.s3fs.md | 3 +- content/api-reference/plugins/hive/_index.md | 4 ++- .../plugins/hive/flytekitplugins.hive.task.md | 15 ++++---- .../plugins/huggingface/_index.md | 6 ++-- ...ekitplugins.huggingface.sd_transformers.md | 9 ++--- .../plugins/identity-aware-proxy/_index.md | 5 +-- ...lytekitplugins.identity_aware_proxy.cli.md | 5 +-- .../api-reference/plugins/inference/_index.md | 4 ++- .../flytekitplugins.inference.nim.serve.md | 3 +- .../flytekitplugins.inference.ollama.serve.md | 3 +- ...tekitplugins.inference.sidecar_template.md | 3 +- .../flytekitplugins.inference.vllm.serve.md | 3 +- .../api-reference/plugins/k8s-pod/_index.md | 3 +- .../k8s-pod/flytekitplugins.pod.task.md | 15 ++++---- .../api-reference/plugins/kf-mpi/_index.md | 14 ++++---- .../kf-mpi/flytekitplugins.kfmpi.task.md | 36 ++++++++++--------- .../plugins/kf-pytorch/_index.md | 14 ++++---- ...lytekitplugins.kfpytorch.error_handling.md | 4 ++- .../flytekitplugins.kfpytorch.pod_template.md | 3 +- .../flytekitplugins.kfpytorch.task.md | 36 ++++++++++--------- .../plugins/kf-tensorflow/_index.md | 10 +++--- .../flytekitplugins.kftensorflow.task.md | 20 ++++++----- .../api-reference/plugins/memray/_index.md | 3 +- .../plugins/memray/flytekitplugins.memray.md | 3 +- .../api-reference/plugins/mmcloud/_index.md | 6 ++-- .../flytekitplugins.mmcloud.connector.md | 3 +- .../mmcloud/flytekitplugins.mmcloud.task.md | 15 ++++---- .../mmcloud/flytekitplugins.mmcloud.utils.md | 5 +-- .../api-reference/plugins/neptune/_index.md | 6 ++-- .../neptune/flytekitplugins.neptune.md | 4 ++- .../api-reference/plugins/omegaconf/_index.md | 5 +-- .../omegaconf/flytekitplugins.omegaconf.md | 5 +-- .../plugins/onnx-scikitlearn/_index.md | 4 ++- .../flytekitplugins.onnxscikitlearn.schema.md | 5 +-- .../api-reference/plugins/openai/_index.md | 4 ++- .../flytekitplugins.openai.batch.connector.md | 3 +- .../flytekitplugins.openai.batch.task.md | 21 +++++------ .../flytekitplugins.openai.batch.workflow.md | 3 +- ...lytekitplugins.openai.chatgpt.connector.md | 3 +- .../flytekitplugins.openai.chatgpt.task.md | 9 ++--- .../api-reference/plugins/optuna/_index.md | 3 +- .../plugins/optuna/flytekitplugins.optuna.md | 3 +- .../api-reference/plugins/pandera/_index.md | 4 ++- .../pandera/flytekitplugins.pandera.config.md | 4 ++- ...flytekitplugins.pandera.pandas_renderer.md | 3 +- ...tekitplugins.pandera.pandas_transformer.md | 5 +-- .../api-reference/plugins/papermill/_index.md | 4 ++- .../flytekitplugins.papermill.task.md | 15 ++++---- .../api-reference/plugins/polars/_index.md | 4 ++- .../flytekitplugins.polars.sd_transformers.md | 11 +++--- content/api-reference/plugins/ray/_index.md | 6 ++-- .../plugins/ray/flytekitplugins.ray.models.md | 5 +-- .../plugins/ray/flytekitplugins.ray.task.md | 15 ++++---- content/api-reference/plugins/slurm/_index.md | 3 +- .../slurm/flytekitplugins.slurm.ssh_utils.md | 4 ++- .../api-reference/plugins/snowflake/_index.md | 4 ++- .../flytekitplugins.snowflake.connector.md | 3 +- .../flytekitplugins.snowflake.task.md | 9 ++--- content/api-reference/plugins/spark/_index.md | 4 ++- .../spark/flytekitplugins.spark.connector.md | 3 +- .../flytekitplugins.spark.databricks_auth.md | 4 ++- .../flytekitplugins.spark.generic_task.md | 15 ++++---- .../spark/flytekitplugins.spark.models.md | 3 +- ...tekitplugins.spark.pyspark_transformers.md | 5 +-- .../spark/flytekitplugins.spark.schema.md | 7 ++-- .../flytekitplugins.spark.sd_transformers.md | 11 +++--- .../spark/flytekitplugins.spark.task.md | 15 ++++---- .../spark/flytekitplugins.spark.utils.md | 3 +- .../plugins/sqlalchemy/_index.md | 4 ++- .../flytekitplugins.sqlalchemy.task.md | 9 +++-- content/api-reference/plugins/wandb/_index.md | 6 ++-- .../plugins/wandb/flytekitplugins.wandb.md | 4 ++- content/api-reference/union-sdk/union.md | 4 --- data/version-manifest.json | 36 +++++++++---------- versions.toml | 5 +-- 286 files changed, 556 insertions(+), 509 deletions(-) diff --git a/content/api-reference/flytekit-sdk/_index.md b/content/api-reference/flytekit-sdk/_index.md index 03980a6b01..91cf795f1d 100644 --- a/content/api-reference/flytekit-sdk/_index.md +++ b/content/api-reference/flytekit-sdk/_index.md @@ -2,7 +2,7 @@ title: Flytekit SDK description: "This package contains all of the most common abstractions you'll need to write Flyte workflows and extend Flytekit." icon: book -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.bin.entrypoint.md b/content/api-reference/flytekit-sdk/flytekit.bin.entrypoint.md index c05c972b15..4580f93f4a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.bin.entrypoint.md +++ b/content/api-reference/flytekit-sdk/flytekit.bin.entrypoint.md @@ -1,7 +1,7 @@ --- title: flytekit.bin.entrypoint icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.auth.auth_client.md b/content/api-reference/flytekit-sdk/flytekit.clients.auth.auth_client.md index 2b8bc6f223..4cf04cdcef 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.auth.auth_client.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.auth.auth_client.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.auth.auth_client icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.auth.authenticator.md b/content/api-reference/flytekit-sdk/flytekit.clients.auth.authenticator.md index e4341d48c6..5c996337ed 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.auth.authenticator.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.auth.authenticator.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.auth.authenticator icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.auth.default_html.md b/content/api-reference/flytekit-sdk/flytekit.clients.auth.default_html.md index 6f1c8997af..f6cac0b0f3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.auth.default_html.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.auth.default_html.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.auth.default_html icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.auth.exceptions.md b/content/api-reference/flytekit-sdk/flytekit.clients.auth.exceptions.md index 6eae13fa2b..3b4e64cc22 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.auth.exceptions.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.auth.exceptions.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.auth.exceptions icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.auth.keyring.md b/content/api-reference/flytekit-sdk/flytekit.clients.auth.keyring.md index fe06008da1..0457a2f15e 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.auth.keyring.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.auth.keyring.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.auth.keyring icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.auth.token_client.md b/content/api-reference/flytekit-sdk/flytekit.clients.auth.token_client.md index 474de55801..e9524fb9e7 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.auth.token_client.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.auth.token_client.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.auth.token_client icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.auth_helper.md b/content/api-reference/flytekit-sdk/flytekit.clients.auth_helper.md index 60c56ec525..95338a365b 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.auth_helper.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.auth_helper.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.auth_helper icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.friendly.md b/content/api-reference/flytekit-sdk/flytekit.clients.friendly.md index 7aa9250478..a3e650130d 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.friendly.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.friendly.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.friendly icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.auth_interceptor.md b/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.auth_interceptor.md index fde7da1fa0..7ceaa7599d 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.auth_interceptor.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.auth_interceptor.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.grpc_utils.auth_interceptor icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.deadline_interceptor.md b/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.deadline_interceptor.md index 057f895960..ae3269ba1e 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.deadline_interceptor.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.deadline_interceptor.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.grpc_utils.deadline_interceptor icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.default_metadata_interceptor.md b/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.default_metadata_interceptor.md index d16ec5718a..f96a96edd6 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.default_metadata_interceptor.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.default_metadata_interceptor.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.grpc_utils.default_metadata_interceptor icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.wrap_exception_interceptor.md b/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.wrap_exception_interceptor.md index 89e404882c..d664084986 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.wrap_exception_interceptor.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.grpc_utils.wrap_exception_interceptor.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.grpc_utils.wrap_exception_interceptor icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.helpers.md b/content/api-reference/flytekit-sdk/flytekit.clients.helpers.md index c76f62e210..1c9c671eff 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.helpers.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.helpers.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.helpers icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clients.raw.md b/content/api-reference/flytekit-sdk/flytekit.clients.raw.md index c8c3d37038..1b42afce7a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clients.raw.md +++ b/content/api-reference/flytekit-sdk/flytekit.clients.raw.md @@ -1,7 +1,7 @@ --- title: flytekit.clients.raw icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.helpers.md b/content/api-reference/flytekit-sdk/flytekit.clis.helpers.md index e3a8a2a289..ad52b096bf 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.helpers.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.helpers.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.helpers icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.backfill.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.backfill.md index e003041b5d..3ad4936846 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.backfill.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.backfill.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.backfill icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.build.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.build.md index 942b026b76..4ec4295bd5 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.build.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.build.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.build icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -143,7 +143,6 @@ class BuildParams( cluster_pool: str = '', execution_cluster_label: str = '', computed_params: flytekit.clis.sdk_in_container.run.RunLevelComputedParams = , - _remote: typing.Optional[flytekit.remote.remote.FlyteRemote] = None, fast: bool = False, ) ``` @@ -179,7 +178,6 @@ class BuildParams( | `cluster_pool` | `str` | | | `execution_cluster_label` | `str` | | | `computed_params` | `flytekit.clis.sdk_in_container.run.RunLevelComputedParams` | | -| `_remote` | `typing.Optional[flytekit.remote.remote.FlyteRemote]` | | | `fast` | `bool` | | ### Properties diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.constants.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.constants.md index b3153e7959..a58fccf6cb 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.constants.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.constants.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.constants icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.executions.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.executions.md index 0b39c9f0ad..6e82da0ab5 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.executions.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.executions.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.executions icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.helpers.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.helpers.md index 83b127ecc6..7ed02f98c4 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.helpers.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.helpers.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.helpers icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.metrics.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.metrics.md index 811048761d..3b28d3876e 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.metrics.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.metrics.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.metrics icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.package.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.package.md index 7f70ac57d3..d6d8f34e42 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.package.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.package.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.package icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.pyflyte.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.pyflyte.md index 2a9d725d86..c04c56358c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.pyflyte.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.pyflyte.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.pyflyte icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.run.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.run.md index c980b8f0e5..9cb3d52459 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.run.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.run.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.run icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -73,17 +73,11 @@ Returns a list of flyte workflow names and list of Flyte tasks in a file. #### is_optional() ```python -def is_optional( - _type, -) +def is_optional() ``` Checks if the given type is Optional Type -| Parameter | Type | Description | -|-|-|-| -| `_type` | | | - #### load_naive_entity() ```python @@ -457,7 +451,6 @@ class RunLevelParams( cluster_pool: str = '', execution_cluster_label: str = '', computed_params: flytekit.clis.sdk_in_container.run.RunLevelComputedParams = , - _remote: typing.Optional[flytekit.remote.remote.FlyteRemote] = None, ) ``` | Parameter | Type | Description | @@ -492,7 +485,6 @@ class RunLevelParams( | `cluster_pool` | `str` | | | `execution_cluster_label` | `str` | | | `computed_params` | `flytekit.clis.sdk_in_container.run.RunLevelComputedParams` | | -| `_remote` | `typing.Optional[flytekit.remote.remote.FlyteRemote]` | | ### Properties diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serialize.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serialize.md index f64a51886a..d991389b8e 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serialize.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serialize.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.serialize icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serve.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serve.md index 05a3ac2e21..8c038192c1 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serve.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.serve.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.serve icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.utils.md b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.utils.md index d5450998ca..282a90ba9d 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.utils.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.sdk_in_container.utils.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.sdk_in_container.utils icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.clis.version.md b/content/api-reference/flytekit-sdk/flytekit.clis.version.md index 39a11270d6..fe4dd018e8 100644 --- a/content/api-reference/flytekit-sdk/flytekit.clis.version.md +++ b/content/api-reference/flytekit-sdk/flytekit.clis.version.md @@ -1,7 +1,7 @@ --- title: flytekit.clis.version icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.configuration.default_images.md b/content/api-reference/flytekit-sdk/flytekit.configuration.default_images.md index a5d28147c1..f6d3e90877 100644 --- a/content/api-reference/flytekit-sdk/flytekit.configuration.default_images.md +++ b/content/api-reference/flytekit-sdk/flytekit.configuration.default_images.md @@ -1,7 +1,7 @@ --- title: flytekit.configuration.default_images icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.configuration.feature_flags.md b/content/api-reference/flytekit-sdk/flytekit.configuration.feature_flags.md index 0f3f4b4104..c998eebd63 100644 --- a/content/api-reference/flytekit-sdk/flytekit.configuration.feature_flags.md +++ b/content/api-reference/flytekit-sdk/flytekit.configuration.feature_flags.md @@ -1,7 +1,7 @@ --- title: flytekit.configuration.feature_flags icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.configuration.file.md b/content/api-reference/flytekit-sdk/flytekit.configuration.file.md index 83690f06b1..68be471804 100644 --- a/content/api-reference/flytekit-sdk/flytekit.configuration.file.md +++ b/content/api-reference/flytekit-sdk/flytekit.configuration.file.md @@ -1,7 +1,7 @@ --- title: flytekit.configuration.file icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.configuration.internal.md b/content/api-reference/flytekit-sdk/flytekit.configuration.internal.md index 96da9deb4a..930c1a95bb 100644 --- a/content/api-reference/flytekit-sdk/flytekit.configuration.internal.md +++ b/content/api-reference/flytekit-sdk/flytekit.configuration.internal.md @@ -1,7 +1,7 @@ --- title: flytekit.configuration.internal icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.configuration.md b/content/api-reference/flytekit-sdk/flytekit.configuration.md index c5769aa4e6..07e0f4966c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.configuration.md +++ b/content/api-reference/flytekit-sdk/flytekit.configuration.md @@ -2,7 +2,7 @@ title: flytekit.configuration description: "There are multiple ways to configure flytekit settings." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -215,7 +215,7 @@ class Config( secrets: SecretsConfig = SecretsConfig(env_prefix='_FSEC_', default_dir='/etc/secrets', file_prefix=''), stats: StatsConfig = StatsConfig(host='localhost', port=8125, disabled=False, disabled_tags=False), data_config: DataConfig = DataConfig(s3=S3Config(enable_debug=False, endpoint=None, retries=3, backoff=datetime.timedelta(seconds=5), access_key_id=None, secret_access_key=None, adressing_style=None), gcs=GCSConfig(gsutil_parallelism=False), azure=AzureBlobStorageConfig(account_name=None, account_key=None, tenant_id=None, client_id=None, client_secret=None), generic=GenericPersistenceConfig(attach_execution_metadata=True)), - local_sandbox_path: str = '/tmp/flytegaolxhbu', + local_sandbox_path: str = '/tmp/flyte8066zmhd', ) ``` | Parameter | Type | Description | @@ -642,7 +642,6 @@ Allows you to programmatically create an ImageConfig. Usually only the default_i ```python def validate_image( - _: typing.Any, param: str, values: tuple, ) -> ImageConfig @@ -656,7 +655,6 @@ CLI | Parameter | Type | Description | |-|-|-| -| `_` | `typing.Any` | click argument, ignored here. | | `param` | `str` | the click argument, here should be "image" | | `values` | `tuple` | user-supplied images | diff --git a/content/api-reference/flytekit-sdk/flytekit.configuration.plugin.md b/content/api-reference/flytekit-sdk/flytekit.configuration.plugin.md index 5caf8b27f0..bf7ef055e3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.configuration.plugin.md +++ b/content/api-reference/flytekit-sdk/flytekit.configuration.plugin.md @@ -2,7 +2,7 @@ title: flytekit.configuration.plugin description: "Defines a plugin API allowing other libraries to modify the behavior of flytekit." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.constants.md b/content/api-reference/flytekit-sdk/flytekit.constants.md index 8763cbb230..10d452d92c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.constants.md +++ b/content/api-reference/flytekit-sdk/flytekit.constants.md @@ -1,7 +1,7 @@ --- title: flytekit.constants icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.annotation.md b/content/api-reference/flytekit-sdk/flytekit.core.annotation.md index 462591659c..319534e5dd 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.annotation.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.annotation.md @@ -1,7 +1,7 @@ --- title: flytekit.core.annotation icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.array_node.md b/content/api-reference/flytekit-sdk/flytekit.core.array_node.md index 33ef689dbc..51e3fb4e48 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.array_node.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.array_node.md @@ -1,7 +1,7 @@ --- title: flytekit.core.array_node icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.array_node_map_task.md b/content/api-reference/flytekit-sdk/flytekit.core.array_node_map_task.md index 5283833c79..2d0a06b05a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.array_node_map_task.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.array_node_map_task.md @@ -1,7 +1,7 @@ --- title: flytekit.core.array_node_map_task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.artifact.md b/content/api-reference/flytekit-sdk/flytekit.core.artifact.md index 70d72fdb33..12eb229b49 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.artifact.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.artifact.md @@ -1,7 +1,7 @@ --- title: flytekit.core.artifact icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.artifact_utils.md b/content/api-reference/flytekit-sdk/flytekit.core.artifact_utils.md index cb2e7d3c22..3489d2303b 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.artifact_utils.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.artifact_utils.md @@ -1,7 +1,7 @@ --- title: flytekit.core.artifact_utils icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.base_sql_task.md b/content/api-reference/flytekit-sdk/flytekit.core.base_sql_task.md index bffdd52627..34bf0fea93 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.base_sql_task.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.base_sql_task.md @@ -1,7 +1,7 @@ --- title: flytekit.core.base_sql_task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.base_task.md b/content/api-reference/flytekit-sdk/flytekit.core.base_task.md index 5a9fd90527..29e8c657fc 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.base_task.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.base_task.md @@ -2,7 +2,7 @@ title: flytekit.core.base_task description: "This module provides the core task-related functionality in Flytekit." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.cache.md b/content/api-reference/flytekit-sdk/flytekit.core.cache.md index 40a743b2ff..5811874543 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.cache.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.cache.md @@ -1,7 +1,7 @@ --- title: flytekit.core.cache icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.checkpointer.md b/content/api-reference/flytekit-sdk/flytekit.core.checkpointer.md index 28e02e6547..f9276c17cd 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.checkpointer.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.checkpointer.md @@ -1,7 +1,7 @@ --- title: flytekit.core.checkpointer icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.class_based_resolver.md b/content/api-reference/flytekit-sdk/flytekit.core.class_based_resolver.md index 2d80198b29..26b0fa4cfc 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.class_based_resolver.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.class_based_resolver.md @@ -1,7 +1,7 @@ --- title: flytekit.core.class_based_resolver icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.condition.md b/content/api-reference/flytekit-sdk/flytekit.core.condition.md index bfe2badd5d..9fa2b07fa3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.condition.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.condition.md @@ -1,7 +1,7 @@ --- title: flytekit.core.condition icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.constants.md b/content/api-reference/flytekit-sdk/flytekit.core.constants.md index 458b12028b..8850ca81f8 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.constants.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.constants.md @@ -1,7 +1,7 @@ --- title: flytekit.core.constants icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.container_task.md b/content/api-reference/flytekit-sdk/flytekit.core.container_task.md index 611f7ee010..8d92a351a6 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.container_task.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.container_task.md @@ -1,7 +1,7 @@ --- title: flytekit.core.container_task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.context_manager.md b/content/api-reference/flytekit-sdk/flytekit.core.context_manager.md index 19130ebf0f..226a6850a7 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.context_manager.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.context_manager.md @@ -2,7 +2,7 @@ title: flytekit.core.context_manager description: "These classes provide functionality related context management." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.data_persistence.md b/content/api-reference/flytekit-sdk/flytekit.core.data_persistence.md index 0b57fb309b..88501015a4 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.data_persistence.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.data_persistence.md @@ -2,7 +2,7 @@ title: flytekit.core.data_persistence description: "The Data persistence module is used by core flytekit and most of the core TypeTransformers to manage data fetch & store, between the durable backend store and the runtime environment." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -36,6 +36,8 @@ simple implementation that ships with the core. |-|-|-| | `default_local_file_access_provider` | `FileAccessProvider` | | | `flyte_tmp_dir` | `str` | | +| `fsspec_known_implementations` | `dict` | | +| `fsspec_registry` | `mappingproxy` | | ## Methods diff --git a/content/api-reference/flytekit-sdk/flytekit.core.docstring.md b/content/api-reference/flytekit-sdk/flytekit.core.docstring.md index d1c438c6a7..bde6adea74 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.docstring.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.docstring.md @@ -1,7 +1,7 @@ --- title: flytekit.core.docstring icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.environment.md b/content/api-reference/flytekit-sdk/flytekit.core.environment.md index 9bd1d330c5..4b7969e182 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.environment.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.environment.md @@ -1,7 +1,7 @@ --- title: flytekit.core.environment icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -63,7 +63,6 @@ def inherit( ```python class Environment( - _task_function: Optional[Callable[P, FuncOut]] = None, task_config: Optional[T] = None, cache: Union[bool, Cache] = False, retries: int = 0, @@ -134,7 +133,6 @@ Please see some cookbook `task examples` for additional information. | Parameter | Type | Description | |-|-|-| -| `_task_function` | `Optional[Callable[P, FuncOut]]` | This argument is implicitly passed and represents the decorated function | | `task_config` | `Optional[T]` | This argument provides configuration for a specific task types. Please refer to the plugins documentation for the right object to use. | | `cache` | `Union[bool, Cache]` | Boolean or Cache that indicates how caching is configured. | | `retries` | `int` | Number of times to retry this task during a workflow execution. | @@ -178,7 +176,6 @@ Please see some cookbook `task examples` for additional information. ```python def dynamic( - _task_function: Optional[Callable[P, FuncOut]] = None, task_config: Optional[T] = None, cache: Union[bool, Cache] = False, retries: int = 0, @@ -243,7 +240,6 @@ See the `cookbook` for a longer discussion. | Parameter | Type | Description | |-|-|-| -| `_task_function` | `Optional[Callable[P, FuncOut]]` | | | `task_config` | `Optional[T]` | | | `cache` | `Union[bool, Cache]` | | | `retries` | `int` | | @@ -276,7 +272,6 @@ See the `cookbook` for a longer discussion. ```python def extend( - _task_function: Optional[Callable[P, FuncOut]] = None, task_config: Optional[T] = None, cache: Union[bool, Cache] = False, retries: int = 0, @@ -347,7 +342,6 @@ Please see some cookbook `task examples` for additional information. | Parameter | Type | Description | |-|-|-| -| `_task_function` | `Optional[Callable[P, FuncOut]]` | This argument is implicitly passed and represents the decorated function | | `task_config` | `Optional[T]` | This argument provides configuration for a specific task types. Please refer to the plugins documentation for the right object to use. | | `cache` | `Union[bool, Cache]` | Boolean or Cache that indicates how caching is configured. | | `retries` | `int` | Number of times to retry this task during a workflow execution. | @@ -385,7 +379,6 @@ def show() ```python def task( - _task_function: Optional[Callable[P, FuncOut]] = None, task_config: Optional[T] = None, cache: Union[bool, Cache] = False, retries: int = 0, @@ -456,7 +449,6 @@ Please see some cookbook `task examples` for additional information. | Parameter | Type | Description | |-|-|-| -| `_task_function` | `Optional[Callable[P, FuncOut]]` | This argument is implicitly passed and represents the decorated function | | `task_config` | `Optional[T]` | This argument provides configuration for a specific task types. Please refer to the plugins documentation for the right object to use. | | `cache` | `Union[bool, Cache]` | Boolean or Cache that indicates how caching is configured. | | `retries` | `int` | Number of times to retry this task during a workflow execution. | @@ -489,7 +481,6 @@ Please see some cookbook `task examples` for additional information. ```python def update( - _task_function: Optional[Callable[P, FuncOut]] = None, task_config: Optional[T] = None, cache: Union[bool, Cache] = False, retries: int = 0, @@ -560,7 +551,6 @@ Please see some cookbook `task examples` for additional information. | Parameter | Type | Description | |-|-|-| -| `_task_function` | `Optional[Callable[P, FuncOut]]` | This argument is implicitly passed and represents the decorated function | | `task_config` | `Optional[T]` | This argument provides configuration for a specific task types. Please refer to the plugins documentation for the right object to use. | | `cache` | `Union[bool, Cache]` | Boolean or Cache that indicates how caching is configured. | | `retries` | `int` | Number of times to retry this task during a workflow execution. | diff --git a/content/api-reference/flytekit-sdk/flytekit.core.gate.md b/content/api-reference/flytekit-sdk/flytekit.core.gate.md index 761ecde16f..86a20be553 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.gate.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.gate.md @@ -1,7 +1,7 @@ --- title: flytekit.core.gate icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.hash.md b/content/api-reference/flytekit-sdk/flytekit.core.hash.md index 4534aa6b60..4c7a2ef080 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.hash.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.hash.md @@ -1,7 +1,7 @@ --- title: flytekit.core.hash icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.interface.md b/content/api-reference/flytekit-sdk/flytekit.core.interface.md index 342b56f98e..bd19283907 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.interface.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.interface.md @@ -1,7 +1,7 @@ --- title: flytekit.core.interface icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.launch_plan.md b/content/api-reference/flytekit-sdk/flytekit.core.launch_plan.md index afc8e7f3ff..dad93ea786 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.launch_plan.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.launch_plan.md @@ -1,7 +1,7 @@ --- title: flytekit.core.launch_plan icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.legacy_map_task.md b/content/api-reference/flytekit-sdk/flytekit.core.legacy_map_task.md index ad3b13460b..e394f7a477 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.legacy_map_task.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.legacy_map_task.md @@ -2,7 +2,7 @@ title: flytekit.core.legacy_map_task description: "Flytekit map tasks specify how to run a single task across a list of inputs." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.local_cache.md b/content/api-reference/flytekit-sdk/flytekit.core.local_cache.md index cf1438d29d..c84c7c0267 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.local_cache.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.local_cache.md @@ -1,7 +1,7 @@ --- title: flytekit.core.local_cache icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.local_fsspec.md b/content/api-reference/flytekit-sdk/flytekit.core.local_fsspec.md index 67ff7c13c9..f0117cdfac 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.local_fsspec.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.local_fsspec.md @@ -1,7 +1,7 @@ --- title: flytekit.core.local_fsspec icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.mock_stats.md b/content/api-reference/flytekit-sdk/flytekit.core.mock_stats.md index 74796a4709..5fb7f3cd03 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.mock_stats.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.mock_stats.md @@ -1,7 +1,7 @@ --- title: flytekit.core.mock_stats icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.node.md b/content/api-reference/flytekit-sdk/flytekit.core.node.md index 2cb5d3776b..963fb95d3e 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.node.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.node.md @@ -1,7 +1,7 @@ --- title: flytekit.core.node icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.node_creation.md b/content/api-reference/flytekit-sdk/flytekit.core.node_creation.md index dff46493e9..67e5329958 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.node_creation.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.node_creation.md @@ -1,7 +1,7 @@ --- title: flytekit.core.node_creation icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.notification.md b/content/api-reference/flytekit-sdk/flytekit.core.notification.md index 3ec069f9c6..3a16077cb5 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.notification.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.notification.md @@ -2,7 +2,7 @@ title: flytekit.core.notification description: "Notifications are primarily used when defining Launch Plans (also can be used when launching executions) and will trigger the Flyte platform to send emails when a workflow run reaches certain stages (fails or succeeds, etc.)." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.options.md b/content/api-reference/flytekit-sdk/flytekit.core.options.md index 2c19697ee6..7c4bf6f23f 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.options.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.options.md @@ -1,7 +1,7 @@ --- title: flytekit.core.options icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.pod_template.md b/content/api-reference/flytekit-sdk/flytekit.core.pod_template.md index 0fc7103307..01d1ccac4d 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.pod_template.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.pod_template.md @@ -1,7 +1,7 @@ --- title: flytekit.core.pod_template icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.promise.md b/content/api-reference/flytekit-sdk/flytekit.core.promise.md index aecb4b6728..cc2a6847fc 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.promise.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.promise.md @@ -1,7 +1,7 @@ --- title: flytekit.core.promise icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -154,8 +154,6 @@ def create_and_link_node_from_remote( overridden_interface: Optional[_interface_models.TypedInterface] = None, add_node_to_compilation_state: bool = True, node_id: str = '', - _inputs_not_allowed: Optional[Set[str]] = None, - _ignorable_inputs: Optional[Set[str]] = None, **kwargs, ) -> Optional[Union[Tuple[Promise], Promise, VoidPromise]] ``` @@ -175,8 +173,6 @@ interface, so all comparisons need to happen using the Literals. | `overridden_interface` | `Optional[_interface_models.TypedInterface]` | utilize this interface instead of the one provided by the entity. This is useful for ArrayNode as there's a mismatch between the underlying interface and inputs | | `add_node_to_compilation_state` | `bool` | bool that enables for nodes to be created but not linked to the workflow. This is useful when creating nodes nested under other nodes such as ArrayNode | | `node_id` | `str` | str if provided, this will be used as the node id. | -| `_inputs_not_allowed` | `Optional[Set[str]]` | Set of all variable names that should not be provided when using this entity. Useful for Launchplans with `fixed` inputs | -| `_ignorable_inputs` | `Optional[Set[str]]` | Set of all variable names that are optional, but if provided will be overridden. Useful for launchplans with `default` inputs | | `**kwargs` | | Dict[str, Any] default inputs passed from the user to this entity. Can be promises. | **Returns:** Optional[Union[Tuple[Promise], Promise, VoidPromise]] diff --git a/content/api-reference/flytekit-sdk/flytekit.core.python_auto_container.md b/content/api-reference/flytekit-sdk/flytekit.core.python_auto_container.md index 97ddc36520..83995247de 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.python_auto_container.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.python_auto_container.md @@ -1,7 +1,7 @@ --- title: flytekit.core.python_auto_container icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.python_customized_container_task.md b/content/api-reference/flytekit-sdk/flytekit.core.python_customized_container_task.md index 6a2827cc9b..14d99040d5 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.python_customized_container_task.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.python_customized_container_task.md @@ -1,7 +1,7 @@ --- title: flytekit.core.python_customized_container_task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -367,7 +367,6 @@ def local_execution_mode() ```python def post_execute( - _: Optional[ExecutionParameters], rval: Any, ) -> Any ``` @@ -376,7 +375,6 @@ This function is a stub, just here to keep dispatch_execute compatibility betwee | Parameter | Type | Description | |-|-|-| -| `_` | `Optional[ExecutionParameters]` | | | `rval` | `Any` | | #### pre_execute() diff --git a/content/api-reference/flytekit-sdk/flytekit.core.python_function_task.md b/content/api-reference/flytekit-sdk/flytekit.core.python_function_task.md index 84987a4382..81172b3bb3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.python_function_task.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.python_function_task.md @@ -1,7 +1,7 @@ --- title: flytekit.core.python_function_task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.reference.md b/content/api-reference/flytekit-sdk/flytekit.core.reference.md index 3809e614b4..f10f13d253 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.reference.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.reference.md @@ -1,7 +1,7 @@ --- title: flytekit.core.reference icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.reference_entity.md b/content/api-reference/flytekit-sdk/flytekit.core.reference_entity.md index b61d267b5c..6274d898b7 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.reference_entity.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.reference_entity.md @@ -1,7 +1,7 @@ --- title: flytekit.core.reference_entity icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.resources.md b/content/api-reference/flytekit-sdk/flytekit.core.resources.md index 8fc6bc5e5e..9399734cbb 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.resources.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.resources.md @@ -1,7 +1,7 @@ --- title: flytekit.core.resources icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.schedule.md b/content/api-reference/flytekit-sdk/flytekit.core.schedule.md index 1fe45c7e0d..44a65489f3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.schedule.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.schedule.md @@ -2,7 +2,7 @@ title: flytekit.core.schedule description: "These classes provide functionality related to schedules." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.shim_task.md b/content/api-reference/flytekit-sdk/flytekit.core.shim_task.md index b9aea0d4a9..d5e4c2a836 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.shim_task.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.shim_task.md @@ -1,7 +1,7 @@ --- title: flytekit.core.shim_task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -118,7 +118,6 @@ Rather than running here, send everything to the executor. ```python def post_execute( - _: Optional[ExecutionParameters], rval: Any, ) -> Any ``` @@ -127,7 +126,6 @@ This function is a stub, just here to keep dispatch_execute compatibility betwee | Parameter | Type | Description | |-|-|-| -| `_` | `Optional[ExecutionParameters]` | | | `rval` | `Any` | | #### pre_execute() diff --git a/content/api-reference/flytekit-sdk/flytekit.core.task.md b/content/api-reference/flytekit-sdk/flytekit.core.task.md index a8585751d9..dc39e04559 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.task.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.task.md @@ -1,7 +1,7 @@ --- title: flytekit.core.task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -60,7 +60,6 @@ Decorates the task with additional functionality if necessary. ```python def eager( - _fn = None, *args, **kwargs, ) -> Union[EagerAsyncPythonFunctionTask, partial] @@ -138,7 +137,6 @@ uses python's [`async`](https://docs.python.org/3/library/asyncio.html) capabili | Parameter | Type | Description | |-|-|-| -| `_fn` | | | | `*args` | | | | `**kwargs` | | | @@ -188,7 +186,6 @@ def ref_t1(a: typing.List[str]) -> str: ```python def task( - _task_function: Optional[Callable[P, FuncOut]] = None, task_config: Optional[T] = None, cache: Union[bool, Cache] = False, retries: int = 0, @@ -259,7 +256,6 @@ Please see some cookbook `task examples` for additional information. | Parameter | Type | Description | |-|-|-| -| `_task_function` | `Optional[Callable[P, FuncOut]]` | This argument is implicitly passed and represents the decorated function | | `task_config` | `Optional[T]` | This argument provides configuration for a specific task types. Please refer to the plugins documentation for the right object to use. | | `cache` | `Union[bool, Cache]` | Boolean or Cache that indicates how caching is configured. | | `retries` | `int` | Number of times to retry this task during a workflow execution. | diff --git a/content/api-reference/flytekit-sdk/flytekit.core.testing.md b/content/api-reference/flytekit-sdk/flytekit.core.testing.md index d413bf4bf5..a86e2880f7 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.testing.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.testing.md @@ -1,7 +1,7 @@ --- title: flytekit.core.testing icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.tracked_abc.md b/content/api-reference/flytekit-sdk/flytekit.core.tracked_abc.md index 8019978b7e..df937a989f 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.tracked_abc.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.tracked_abc.md @@ -1,7 +1,7 @@ --- title: flytekit.core.tracked_abc icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.tracker.md b/content/api-reference/flytekit-sdk/flytekit.core.tracker.md index 60e6f49ad0..9764fc42c8 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.tracker.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.tracker.md @@ -1,7 +1,7 @@ --- title: flytekit.core.tracker icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.type_engine.md b/content/api-reference/flytekit-sdk/flytekit.core.type_engine.md index a2cdd6e018..3a0275c5e5 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.type_engine.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.type_engine.md @@ -1,7 +1,7 @@ --- title: flytekit.core.type_engine icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.type_helpers.md b/content/api-reference/flytekit-sdk/flytekit.core.type_helpers.md index d3ab04164e..2b7c55e8a5 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.type_helpers.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.type_helpers.md @@ -1,7 +1,7 @@ --- title: flytekit.core.type_helpers icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.type_match_checking.md b/content/api-reference/flytekit-sdk/flytekit.core.type_match_checking.md index 99f6a14c84..c53a39bf3e 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.type_match_checking.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.type_match_checking.md @@ -1,7 +1,7 @@ --- title: flytekit.core.type_match_checking icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.utils.md b/content/api-reference/flytekit-sdk/flytekit.core.utils.md index fbf54f6ee8..e30a230bee 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.utils.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.utils.md @@ -1,7 +1,7 @@ --- title: flytekit.core.utils icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.worker_queue.md b/content/api-reference/flytekit-sdk/flytekit.core.worker_queue.md index 447f947846..005daafa95 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.worker_queue.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.worker_queue.md @@ -1,7 +1,7 @@ --- title: flytekit.core.worker_queue icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.core.workflow.md b/content/api-reference/flytekit-sdk/flytekit.core.workflow.md index afd76fb585..9b7b7c94be 100644 --- a/content/api-reference/flytekit-sdk/flytekit.core.workflow.md +++ b/content/api-reference/flytekit-sdk/flytekit.core.workflow.md @@ -1,7 +1,7 @@ --- title: flytekit.core.workflow icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -127,7 +127,6 @@ def ref_wf1(a: int) -> typing.Tuple[str, str]: ```python def workflow( - _workflow_function: Optional[Callable[P, FuncOut]] = None, failure_policy: Optional[WorkflowFailurePolicy] = None, interruptible: bool = False, on_failure: Optional[Union[WorkflowBase, Task]] = None, @@ -682,7 +681,6 @@ Please see the `user guide` for more usage examples. | Parameter | Type | Description | |-|-|-| -| `_workflow_function` | `Optional[Callable[P, FuncOut]]` | This argument is implicitly passed and represents the decorated function. | | `failure_policy` | `Optional[WorkflowFailurePolicy]` | Use the options in flytekit.WorkflowFailurePolicy | | `interruptible` | `bool` | Whether or not tasks launched from this workflow are by default interruptible | | `on_failure` | `Optional[Union[WorkflowBase, Task]]` | Invoke this workflow or task on failure. The Workflow / task has to match the signature of the current workflow, with an additional parameter called `error` Error | diff --git a/content/api-reference/flytekit-sdk/flytekit.deck.deck.md b/content/api-reference/flytekit-sdk/flytekit.deck.deck.md index 239d9e3c9c..a6846b7198 100644 --- a/content/api-reference/flytekit-sdk/flytekit.deck.deck.md +++ b/content/api-reference/flytekit-sdk/flytekit.deck.deck.md @@ -1,7 +1,7 @@ --- title: flytekit.deck.deck icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.deck.renderer.md b/content/api-reference/flytekit-sdk/flytekit.deck.renderer.md index 3546c83e8e..4cd09cd481 100644 --- a/content/api-reference/flytekit-sdk/flytekit.deck.renderer.md +++ b/content/api-reference/flytekit-sdk/flytekit.deck.renderer.md @@ -1,7 +1,7 @@ --- title: flytekit.deck.renderer icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.exceptions.base.md b/content/api-reference/flytekit-sdk/flytekit.exceptions.base.md index 04c8b5c70e..bf3be2b658 100644 --- a/content/api-reference/flytekit-sdk/flytekit.exceptions.base.md +++ b/content/api-reference/flytekit-sdk/flytekit.exceptions.base.md @@ -1,7 +1,7 @@ --- title: flytekit.exceptions.base icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.exceptions.eager.md b/content/api-reference/flytekit-sdk/flytekit.exceptions.eager.md index 5727c57024..79398df2ef 100644 --- a/content/api-reference/flytekit-sdk/flytekit.exceptions.eager.md +++ b/content/api-reference/flytekit-sdk/flytekit.exceptions.eager.md @@ -1,7 +1,7 @@ --- title: flytekit.exceptions.eager icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.exceptions.scopes.md b/content/api-reference/flytekit-sdk/flytekit.exceptions.scopes.md index 73e1e1ed19..3b0440372c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.exceptions.scopes.md +++ b/content/api-reference/flytekit-sdk/flytekit.exceptions.scopes.md @@ -1,7 +1,7 @@ --- title: flytekit.exceptions.scopes icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.exceptions.system.md b/content/api-reference/flytekit-sdk/flytekit.exceptions.system.md index a9d7032c42..a906ad9bae 100644 --- a/content/api-reference/flytekit-sdk/flytekit.exceptions.system.md +++ b/content/api-reference/flytekit-sdk/flytekit.exceptions.system.md @@ -1,7 +1,7 @@ --- title: flytekit.exceptions.system icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.exceptions.user.md b/content/api-reference/flytekit-sdk/flytekit.exceptions.user.md index 9c17c4980a..4ef2734c3c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.exceptions.user.md +++ b/content/api-reference/flytekit-sdk/flytekit.exceptions.user.md @@ -1,7 +1,7 @@ --- title: flytekit.exceptions.user icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.exceptions.utils.md b/content/api-reference/flytekit-sdk/flytekit.exceptions.utils.md index d110bdc44f..24d8880014 100644 --- a/content/api-reference/flytekit-sdk/flytekit.exceptions.utils.md +++ b/content/api-reference/flytekit-sdk/flytekit.exceptions.utils.md @@ -1,7 +1,7 @@ --- title: flytekit.exceptions.utils icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.experimental.eager_function.md b/content/api-reference/flytekit-sdk/flytekit.experimental.eager_function.md index 24acae9ad0..050c9a2805 100644 --- a/content/api-reference/flytekit-sdk/flytekit.experimental.eager_function.md +++ b/content/api-reference/flytekit-sdk/flytekit.experimental.eager_function.md @@ -1,7 +1,7 @@ --- title: flytekit.experimental.eager_function icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extend.backend.base_connector.md b/content/api-reference/flytekit-sdk/flytekit.extend.backend.base_connector.md index 9a3bcb853a..41e2709e49 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extend.backend.base_connector.md +++ b/content/api-reference/flytekit-sdk/flytekit.extend.backend.base_connector.md @@ -1,7 +1,7 @@ --- title: flytekit.extend.backend.base_connector icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extend.backend.connector_service.md b/content/api-reference/flytekit-sdk/flytekit.extend.backend.connector_service.md index 0f2e0b69b8..61029b624d 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extend.backend.connector_service.md +++ b/content/api-reference/flytekit-sdk/flytekit.extend.backend.connector_service.md @@ -1,7 +1,7 @@ --- title: flytekit.extend.backend.connector_service icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -121,7 +121,6 @@ def GetTaskLogs( ) -> flyteidl.admin.agent_pb2.GetTaskLogsResponse ``` GetTaskLogs returns task execution logs, if available. - | Parameter | Type | Description | @@ -168,7 +167,6 @@ def GetAgent( ) -> flyteidl.admin.agent_pb2.GetAgentResponse ``` Fetch a `ref_flyteidl.admin.Agent` definition. - | Parameter | Type | Description | @@ -185,7 +183,6 @@ def ListAgents( ) -> flyteidl.admin.agent_pb2.ListAgentsResponse ``` Fetch a list of `ref_flyteidl.admin.Agent` definitions. - | Parameter | Type | Description | @@ -211,7 +208,6 @@ def ExecuteTaskSync( ) -> typing.AsyncIterator[flyteidl.admin.agent_pb2.ExecuteTaskSyncResponse] ``` ExecuteTaskSync streams the create request and inputs to the agent service and streams the outputs back. - | Parameter | Type | Description | diff --git a/content/api-reference/flytekit-sdk/flytekit.extend.backend.utils.md b/content/api-reference/flytekit-sdk/flytekit.extend.backend.utils.md index 5357d1ebfa..6cb1edb296 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extend.backend.utils.md +++ b/content/api-reference/flytekit-sdk/flytekit.extend.backend.utils.md @@ -1,7 +1,7 @@ --- title: flytekit.extend.backend.utils icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.accelerators.md b/content/api-reference/flytekit-sdk/flytekit.extras.accelerators.md index 5718a00805..359cdad225 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.accelerators.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.accelerators.md @@ -2,7 +2,7 @@ title: flytekit.extras.accelerators description: "tags: MachineLearning, Advanced, Hardware." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.cloud_pickle_resolver.md b/content/api-reference/flytekit-sdk/flytekit.extras.cloud_pickle_resolver.md index 110c1f04d2..26c01c5ca3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.cloud_pickle_resolver.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.cloud_pickle_resolver.md @@ -1,7 +1,7 @@ --- title: flytekit.extras.cloud_pickle_resolver icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.pydantic_transformer.transformer.md b/content/api-reference/flytekit-sdk/flytekit.extras.pydantic_transformer.transformer.md index ae1c8eb834..03d9235906 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.pydantic_transformer.transformer.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.pydantic_transformer.transformer.md @@ -1,7 +1,7 @@ --- title: flytekit.extras.pydantic_transformer.transformer icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.sklearn.native.md b/content/api-reference/flytekit-sdk/flytekit.extras.sklearn.native.md index 4abb400f4a..af61ceaea9 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.sklearn.native.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.sklearn.native.md @@ -1,7 +1,7 @@ --- title: flytekit.extras.sklearn.native icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.sqlite3.task.md b/content/api-reference/flytekit-sdk/flytekit.extras.sqlite3.task.md index 4b74b3d624..107dbdf138 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.sqlite3.task.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.sqlite3.task.md @@ -1,7 +1,7 @@ --- title: flytekit.extras.sqlite3.task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -448,7 +448,6 @@ def local_execution_mode() ```python def post_execute( - _: Optional[ExecutionParameters], rval: Any, ) -> Any ``` @@ -457,7 +456,6 @@ This function is a stub, just here to keep dispatch_execute compatibility betwee | Parameter | Type | Description | |-|-|-| -| `_` | `Optional[ExecutionParameters]` | | | `rval` | `Any` | | #### pre_execute() diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.tasks.shell.md b/content/api-reference/flytekit-sdk/flytekit.extras.tasks.shell.md index 360c9219e8..48f4691aed 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.tasks.shell.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.tasks.shell.md @@ -1,7 +1,7 @@ --- title: flytekit.extras.tasks.shell icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.webhook.connector.md b/content/api-reference/flytekit-sdk/flytekit.extras.webhook.connector.md index 7379f5e149..5b00d96f68 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.webhook.connector.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.webhook.connector.md @@ -1,7 +1,7 @@ --- title: flytekit.extras.webhook.connector icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.webhook.constants.md b/content/api-reference/flytekit-sdk/flytekit.extras.webhook.constants.md index 3e60956c94..76b89e3b75 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.webhook.constants.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.webhook.constants.md @@ -1,7 +1,7 @@ --- title: flytekit.extras.webhook.constants icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.webhook.md b/content/api-reference/flytekit-sdk/flytekit.extras.webhook.md index 0029d72c21..556144bbd3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.webhook.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.webhook.md @@ -1,7 +1,7 @@ --- title: flytekit.extras.webhook icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.extras.webhook.task.md b/content/api-reference/flytekit-sdk/flytekit.extras.webhook.task.md index 56ed8ebc22..dfb7926deb 100644 --- a/content/api-reference/flytekit-sdk/flytekit.extras.webhook.task.md +++ b/content/api-reference/flytekit-sdk/flytekit.extras.webhook.task.md @@ -1,7 +1,7 @@ --- title: flytekit.extras.webhook.task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.image_spec.default_builder.md b/content/api-reference/flytekit-sdk/flytekit.image_spec.default_builder.md index 619f7e8db1..549055243c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.image_spec.default_builder.md +++ b/content/api-reference/flytekit-sdk/flytekit.image_spec.default_builder.md @@ -1,7 +1,7 @@ --- title: flytekit.image_spec.default_builder icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.image_spec.image_spec.md b/content/api-reference/flytekit-sdk/flytekit.image_spec.image_spec.md index d2d9c5d9c5..0bedb671a8 100644 --- a/content/api-reference/flytekit-sdk/flytekit.image_spec.image_spec.md +++ b/content/api-reference/flytekit-sdk/flytekit.image_spec.image_spec.md @@ -1,7 +1,7 @@ --- title: flytekit.image_spec.image_spec icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.image_spec.noop_builder.md b/content/api-reference/flytekit-sdk/flytekit.image_spec.noop_builder.md index d87f5d0c01..4bb5c4b24c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.image_spec.noop_builder.md +++ b/content/api-reference/flytekit-sdk/flytekit.image_spec.noop_builder.md @@ -1,7 +1,7 @@ --- title: flytekit.image_spec.noop_builder icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interaction.click_types.md b/content/api-reference/flytekit-sdk/flytekit.interaction.click_types.md index fda7b96ef6..3b721b6764 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interaction.click_types.md +++ b/content/api-reference/flytekit-sdk/flytekit.interaction.click_types.md @@ -1,7 +1,7 @@ --- title: flytekit.interaction.click_types icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -65,7 +65,6 @@ Checks if the python type is a pydantic BaseModel ```python def key_value_callback( - _: typing.Any, param: str, values: typing.List[str], ) -> typing.Optional[typing.Dict[str, str]] @@ -75,7 +74,6 @@ Callback for click to parse key-value pairs. | Parameter | Type | Description | |-|-|-| -| `_` | `typing.Any` | | | `param` | `str` | | | `values` | `typing.List[str]` | | @@ -83,7 +81,6 @@ Callback for click to parse key-value pairs. ```python def labels_callback( - _: typing.Any, param: str, values: typing.List[str], ) -> typing.Optional[typing.Dict[str, str]] @@ -93,7 +90,6 @@ Callback for click to parse labels. | Parameter | Type | Description | |-|-|-| -| `_` | `typing.Any` | | | `param` | `str` | | | `values` | `typing.List[str]` | | @@ -131,7 +127,6 @@ Modifies the literal object recursively to replace the URIs with the native path ```python def resource_callback( - _: typing.Any, param: str, value: typing.Optional[str], ) -> typing.Optional[flytekit.core.resources.Resources] @@ -141,7 +136,6 @@ Click callback to parse resource strings like 'cpu=1,mem=2Gi' into a Resources o | Parameter | Type | Description | |-|-|-| -| `_` | `typing.Any` | | | `param` | `str` | | | `value` | `typing.Optional[str]` | | diff --git a/content/api-reference/flytekit-sdk/flytekit.interaction.parse_stdin.md b/content/api-reference/flytekit-sdk/flytekit.interaction.parse_stdin.md index d2f02bb83f..8c12812fe6 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interaction.parse_stdin.md +++ b/content/api-reference/flytekit-sdk/flytekit.interaction.parse_stdin.md @@ -1,7 +1,7 @@ --- title: flytekit.interaction.parse_stdin icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interaction.rich_utils.md b/content/api-reference/flytekit-sdk/flytekit.interaction.rich_utils.md index 6d7101a900..d445cac809 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interaction.rich_utils.md +++ b/content/api-reference/flytekit-sdk/flytekit.interaction.rich_utils.md @@ -1,7 +1,7 @@ --- title: flytekit.interaction.rich_utils icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interaction.string_literals.md b/content/api-reference/flytekit-sdk/flytekit.interaction.string_literals.md index ec9c71ab84..8f0dcf9f7d 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interaction.string_literals.md +++ b/content/api-reference/flytekit-sdk/flytekit.interaction.string_literals.md @@ -1,7 +1,7 @@ --- title: flytekit.interaction.string_literals icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interactive.constants.md b/content/api-reference/flytekit-sdk/flytekit.interactive.constants.md index 22eca5ef78..7d6a7d29ca 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interactive.constants.md +++ b/content/api-reference/flytekit-sdk/flytekit.interactive.constants.md @@ -1,7 +1,7 @@ --- title: flytekit.interactive.constants icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interactive.md b/content/api-reference/flytekit-sdk/flytekit.interactive.md index 611935e6b9..1f73f802ea 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interactive.md +++ b/content/api-reference/flytekit-sdk/flytekit.interactive.md @@ -2,7 +2,7 @@ title: flytekit.interactive description: "This module provides functionality related to Flytekit Interactive." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interactive.utils.md b/content/api-reference/flytekit-sdk/flytekit.interactive.utils.md index f7e2c88021..d13bf6e4c5 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interactive.utils.md +++ b/content/api-reference/flytekit-sdk/flytekit.interactive.utils.md @@ -1,7 +1,7 @@ --- title: flytekit.interactive.utils icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.config.md b/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.config.md index 4a4e4bf4eb..eb6f4917fe 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.config.md +++ b/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.config.md @@ -1,7 +1,7 @@ --- title: flytekit.interactive.vscode_lib.config icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.decorator.md b/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.decorator.md index 996895698f..fbd107e79a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.decorator.md +++ b/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.decorator.md @@ -1,7 +1,7 @@ --- title: flytekit.interactive.vscode_lib.decorator icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.vscode_constants.md b/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.vscode_constants.md index 1ce7681ed2..5b559d15c3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.vscode_constants.md +++ b/content/api-reference/flytekit-sdk/flytekit.interactive.vscode_lib.vscode_constants.md @@ -1,7 +1,7 @@ --- title: flytekit.interactive.vscode_lib.vscode_constants icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interfaces.cli_identifiers.md b/content/api-reference/flytekit-sdk/flytekit.interfaces.cli_identifiers.md index c99fa1eeb5..865856227a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interfaces.cli_identifiers.md +++ b/content/api-reference/flytekit-sdk/flytekit.interfaces.cli_identifiers.md @@ -1,7 +1,7 @@ --- title: flytekit.interfaces.cli_identifiers icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interfaces.random.md b/content/api-reference/flytekit-sdk/flytekit.interfaces.random.md index d8fc60f304..c2712b920f 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interfaces.random.md +++ b/content/api-reference/flytekit-sdk/flytekit.interfaces.random.md @@ -1,7 +1,7 @@ --- title: flytekit.interfaces.random icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interfaces.stats.client.md b/content/api-reference/flytekit-sdk/flytekit.interfaces.stats.client.md index 0f42eb0690..a645e0d595 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interfaces.stats.client.md +++ b/content/api-reference/flytekit-sdk/flytekit.interfaces.stats.client.md @@ -1,7 +1,7 @@ --- title: flytekit.interfaces.stats.client icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.interfaces.stats.taggable.md b/content/api-reference/flytekit-sdk/flytekit.interfaces.stats.taggable.md index 365b396bc9..84a4595799 100644 --- a/content/api-reference/flytekit-sdk/flytekit.interfaces.stats.taggable.md +++ b/content/api-reference/flytekit-sdk/flytekit.interfaces.stats.taggable.md @@ -1,7 +1,7 @@ --- title: flytekit.interfaces.stats.taggable icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.lazy_import.lazy_module.md b/content/api-reference/flytekit-sdk/flytekit.lazy_import.lazy_module.md index 0d3aa3cfc8..584645d165 100644 --- a/content/api-reference/flytekit-sdk/flytekit.lazy_import.lazy_module.md +++ b/content/api-reference/flytekit-sdk/flytekit.lazy_import.lazy_module.md @@ -1,7 +1,7 @@ --- title: flytekit.lazy_import.lazy_module icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.loggers.md b/content/api-reference/flytekit-sdk/flytekit.loggers.md index 7ecd7fa9c9..d064bde211 100644 --- a/content/api-reference/flytekit-sdk/flytekit.loggers.md +++ b/content/api-reference/flytekit-sdk/flytekit.loggers.md @@ -1,7 +1,7 @@ --- title: flytekit.loggers icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.md b/content/api-reference/flytekit-sdk/flytekit.md index e153f64151..8532d7fe9a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.md +++ b/content/api-reference/flytekit-sdk/flytekit.md @@ -2,7 +2,7 @@ title: flytekit description: "This package contains all of the most common abstractions you'll need to write Flyte workflows and extend Flytekit." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.admin.common.md b/content/api-reference/flytekit-sdk/flytekit.models.admin.common.md index 5f2ae136c7..af63683db0 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.admin.common.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.admin.common.md @@ -1,7 +1,7 @@ --- title: flytekit.models.admin.common icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.admin.task_execution.md b/content/api-reference/flytekit-sdk/flytekit.models.admin.task_execution.md index 143737642b..2d17860243 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.admin.task_execution.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.admin.task_execution.md @@ -1,7 +1,7 @@ --- title: flytekit.models.admin.task_execution icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.admin.workflow.md b/content/api-reference/flytekit-sdk/flytekit.models.admin.workflow.md index 819e2528ee..dece691e9a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.admin.workflow.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.admin.workflow.md @@ -1,7 +1,7 @@ --- title: flytekit.models.admin.workflow icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.annotation.md b/content/api-reference/flytekit-sdk/flytekit.models.annotation.md index 1fcfd6b9ee..123f2de95a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.annotation.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.annotation.md @@ -1,7 +1,7 @@ --- title: flytekit.models.annotation icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.array_job.md b/content/api-reference/flytekit-sdk/flytekit.models.array_job.md index 40c9cc4946..13e7113846 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.array_job.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.array_job.md @@ -1,7 +1,7 @@ --- title: flytekit.models.array_job icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.common.md b/content/api-reference/flytekit-sdk/flytekit.models.common.md index 20723c5803..1b503dee2d 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.common.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.common.md @@ -1,7 +1,7 @@ --- title: flytekit.models.common icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.concurrency.md b/content/api-reference/flytekit-sdk/flytekit.models.concurrency.md index d07a9a278c..5ad6f799c3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.concurrency.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.concurrency.md @@ -1,7 +1,7 @@ --- title: flytekit.models.concurrency icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.core.catalog.md b/content/api-reference/flytekit-sdk/flytekit.models.core.catalog.md index 09012a5b1a..95699f8d2c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.core.catalog.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.core.catalog.md @@ -1,7 +1,7 @@ --- title: flytekit.models.core.catalog icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.core.compiler.md b/content/api-reference/flytekit-sdk/flytekit.models.core.compiler.md index b017b349b9..ac0e5e7511 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.core.compiler.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.core.compiler.md @@ -1,7 +1,7 @@ --- title: flytekit.models.core.compiler icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.core.condition.md b/content/api-reference/flytekit-sdk/flytekit.models.core.condition.md index b830570cce..1465f1e5c1 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.core.condition.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.core.condition.md @@ -1,7 +1,7 @@ --- title: flytekit.models.core.condition icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.core.errors.md b/content/api-reference/flytekit-sdk/flytekit.models.core.errors.md index 20f17371fb..22e2f5c0eb 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.core.errors.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.core.errors.md @@ -1,7 +1,7 @@ --- title: flytekit.models.core.errors icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.core.execution.md b/content/api-reference/flytekit-sdk/flytekit.models.core.execution.md index 86dcda5ee3..788a05cc94 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.core.execution.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.core.execution.md @@ -1,7 +1,7 @@ --- title: flytekit.models.core.execution icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.core.identifier.md b/content/api-reference/flytekit-sdk/flytekit.models.core.identifier.md index 17a5d20076..8f1e5ed6b9 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.core.identifier.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.core.identifier.md @@ -1,7 +1,7 @@ --- title: flytekit.models.core.identifier icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.core.types.md b/content/api-reference/flytekit-sdk/flytekit.models.core.types.md index e52af81fc0..f73ee1fda5 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.core.types.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.core.types.md @@ -1,7 +1,7 @@ --- title: flytekit.models.core.types icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.core.workflow.md b/content/api-reference/flytekit-sdk/flytekit.models.core.workflow.md index ed2504bb9f..ae378217ac 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.core.workflow.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.core.workflow.md @@ -1,7 +1,7 @@ --- title: flytekit.models.core.workflow icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.documentation.md b/content/api-reference/flytekit-sdk/flytekit.models.documentation.md index 9635b94522..c930c1f7c3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.documentation.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.documentation.md @@ -1,7 +1,7 @@ --- title: flytekit.models.documentation icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.domain.md b/content/api-reference/flytekit-sdk/flytekit.models.domain.md index fb0ff39532..9058eb7601 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.domain.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.domain.md @@ -1,7 +1,7 @@ --- title: flytekit.models.domain icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.dynamic_job.md b/content/api-reference/flytekit-sdk/flytekit.models.dynamic_job.md index ac3e256133..1aefb868b8 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.dynamic_job.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.dynamic_job.md @@ -1,7 +1,7 @@ --- title: flytekit.models.dynamic_job icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.event.md b/content/api-reference/flytekit-sdk/flytekit.models.event.md index da9abb8437..41189db0a8 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.event.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.event.md @@ -1,7 +1,7 @@ --- title: flytekit.models.event icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.execution.md b/content/api-reference/flytekit-sdk/flytekit.models.execution.md index b2ff900027..7486565352 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.execution.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.execution.md @@ -1,7 +1,7 @@ --- title: flytekit.models.execution icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.filters.md b/content/api-reference/flytekit-sdk/flytekit.models.filters.md index 430aae7699..cc346f3778 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.filters.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.filters.md @@ -1,7 +1,7 @@ --- title: flytekit.models.filters icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.interface.md b/content/api-reference/flytekit-sdk/flytekit.models.interface.md index 5e6cc4cfc3..2b57db1e6e 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.interface.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.interface.md @@ -1,7 +1,7 @@ --- title: flytekit.models.interface icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.launch_plan.md b/content/api-reference/flytekit-sdk/flytekit.models.launch_plan.md index 1ed1692725..aa931877a6 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.launch_plan.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.launch_plan.md @@ -1,7 +1,7 @@ --- title: flytekit.models.launch_plan icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.literals.md b/content/api-reference/flytekit-sdk/flytekit.models.literals.md index 39edc2fadf..4c2433b212 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.literals.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.literals.md @@ -1,7 +1,7 @@ --- title: flytekit.models.literals icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.matchable_resource.md b/content/api-reference/flytekit-sdk/flytekit.models.matchable_resource.md index 54405103e0..b946281183 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.matchable_resource.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.matchable_resource.md @@ -1,7 +1,7 @@ --- title: flytekit.models.matchable_resource icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.named_entity.md b/content/api-reference/flytekit-sdk/flytekit.models.named_entity.md index 48438a720a..6bb5edb187 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.named_entity.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.named_entity.md @@ -1,7 +1,7 @@ --- title: flytekit.models.named_entity icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.node_execution.md b/content/api-reference/flytekit-sdk/flytekit.models.node_execution.md index bd407597cc..8f8b51e5a7 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.node_execution.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.node_execution.md @@ -1,7 +1,7 @@ --- title: flytekit.models.node_execution icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.presto.md b/content/api-reference/flytekit-sdk/flytekit.models.presto.md index 40ec2abc45..3a7b1bc50e 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.presto.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.presto.md @@ -2,7 +2,7 @@ title: flytekit.models.presto description: "This is a deprecated module." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.project.md b/content/api-reference/flytekit-sdk/flytekit.models.project.md index b1c6b6b845..2ac9cbafe6 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.project.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.project.md @@ -1,7 +1,7 @@ --- title: flytekit.models.project icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.qubole.md b/content/api-reference/flytekit-sdk/flytekit.models.qubole.md index ecd2bcd038..940d6a3043 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.qubole.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.qubole.md @@ -2,7 +2,7 @@ title: flytekit.models.qubole description: "This is a deprecated module." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.schedule.md b/content/api-reference/flytekit-sdk/flytekit.models.schedule.md index 61f51e5f33..060eccd56c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.schedule.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.schedule.md @@ -1,7 +1,7 @@ --- title: flytekit.models.schedule icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.security.md b/content/api-reference/flytekit-sdk/flytekit.models.security.md index b439a90245..54f545f8db 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.security.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.security.md @@ -1,7 +1,7 @@ --- title: flytekit.models.security icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.task.md b/content/api-reference/flytekit-sdk/flytekit.models.task.md index 56a9938bdc..82640c5f42 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.task.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.task.md @@ -1,7 +1,7 @@ --- title: flytekit.models.task icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.types.md b/content/api-reference/flytekit-sdk/flytekit.models.types.md index 3517ff0ef3..8bbe665be9 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.types.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.types.md @@ -1,7 +1,7 @@ --- title: flytekit.models.types icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.models.workflow_closure.md b/content/api-reference/flytekit-sdk/flytekit.models.workflow_closure.md index 901a5ef4f8..0d75d3b5b2 100644 --- a/content/api-reference/flytekit-sdk/flytekit.models.workflow_closure.md +++ b/content/api-reference/flytekit-sdk/flytekit.models.workflow_closure.md @@ -1,7 +1,7 @@ --- title: flytekit.models.workflow_closure icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.backfill.md b/content/api-reference/flytekit-sdk/flytekit.remote.backfill.md index a51eef8290..ecb6ee7d7e 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.backfill.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.backfill.md @@ -1,7 +1,7 @@ --- title: flytekit.remote.backfill icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.data.md b/content/api-reference/flytekit-sdk/flytekit.remote.data.md index 421b9a6b20..851a814237 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.data.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.data.md @@ -1,7 +1,7 @@ --- title: flytekit.remote.data icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.entities.md b/content/api-reference/flytekit-sdk/flytekit.remote.entities.md index 2986b780af..b659a7fd67 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.entities.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.entities.md @@ -2,7 +2,7 @@ title: flytekit.remote.entities description: "This module contains shadow entities for all Flyte entities as represented in Flyte Admin / Control Plane." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.executions.md b/content/api-reference/flytekit-sdk/flytekit.remote.executions.md index d7ceb4d09c..cdc6a904ab 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.executions.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.executions.md @@ -1,7 +1,7 @@ --- title: flytekit.remote.executions icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.interface.md b/content/api-reference/flytekit-sdk/flytekit.remote.interface.md index dd3b0b4af0..dbb3640f6b 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.interface.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.interface.md @@ -1,7 +1,7 @@ --- title: flytekit.remote.interface icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.lazy_entity.md b/content/api-reference/flytekit-sdk/flytekit.remote.lazy_entity.md index 1db51afb94..1dfd1a2216 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.lazy_entity.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.lazy_entity.md @@ -1,7 +1,7 @@ --- title: flytekit.remote.lazy_entity icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.metrics.md b/content/api-reference/flytekit-sdk/flytekit.remote.metrics.md index fd3f23e650..d260eb5f22 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.metrics.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.metrics.md @@ -1,7 +1,7 @@ --- title: flytekit.remote.metrics icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.remote.md b/content/api-reference/flytekit-sdk/flytekit.remote.remote.md index f0fe09807a..41f778bfc9 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.remote.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.remote.md @@ -2,7 +2,7 @@ title: flytekit.remote.remote description: "This module provides the ``FlyteRemote`` object, which is the end-user's main starting point for interacting with a Flyte backend in an interactive and programmatic way." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.remote_callable.md b/content/api-reference/flytekit-sdk/flytekit.remote.remote_callable.md index b8e2d1c0c3..602ca5d59f 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.remote_callable.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.remote_callable.md @@ -1,7 +1,7 @@ --- title: flytekit.remote.remote_callable icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.remote.remote_fs.md b/content/api-reference/flytekit-sdk/flytekit.remote.remote_fs.md index 1fc1715b87..babae035b3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.remote.remote_fs.md +++ b/content/api-reference/flytekit-sdk/flytekit.remote.remote_fs.md @@ -1,7 +1,7 @@ --- title: flytekit.remote.remote_fs icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.sensor.base_sensor.md b/content/api-reference/flytekit-sdk/flytekit.sensor.base_sensor.md index 0504496a27..343e844215 100644 --- a/content/api-reference/flytekit-sdk/flytekit.sensor.base_sensor.md +++ b/content/api-reference/flytekit-sdk/flytekit.sensor.base_sensor.md @@ -1,7 +1,7 @@ --- title: flytekit.sensor.base_sensor icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.sensor.file_sensor.md b/content/api-reference/flytekit-sdk/flytekit.sensor.file_sensor.md index 8ef6fb977c..e669572bd3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.sensor.file_sensor.md +++ b/content/api-reference/flytekit-sdk/flytekit.sensor.file_sensor.md @@ -1,7 +1,7 @@ --- title: flytekit.sensor.file_sensor icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.sensor.sensor_engine.md b/content/api-reference/flytekit-sdk/flytekit.sensor.sensor_engine.md index a68b43c9c8..32a90d250d 100644 --- a/content/api-reference/flytekit-sdk/flytekit.sensor.sensor_engine.md +++ b/content/api-reference/flytekit-sdk/flytekit.sensor.sensor_engine.md @@ -1,7 +1,7 @@ --- title: flytekit.sensor.sensor_engine icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.tools.fast_registration.md b/content/api-reference/flytekit-sdk/flytekit.tools.fast_registration.md index 292afcb2e1..b5a88e03f8 100644 --- a/content/api-reference/flytekit-sdk/flytekit.tools.fast_registration.md +++ b/content/api-reference/flytekit-sdk/flytekit.tools.fast_registration.md @@ -1,7 +1,7 @@ --- title: flytekit.tools.fast_registration icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.tools.ignore.md b/content/api-reference/flytekit-sdk/flytekit.tools.ignore.md index f138761b69..9ed63dfa4c 100644 --- a/content/api-reference/flytekit-sdk/flytekit.tools.ignore.md +++ b/content/api-reference/flytekit-sdk/flytekit.tools.ignore.md @@ -1,7 +1,7 @@ --- title: flytekit.tools.ignore icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.tools.interactive.md b/content/api-reference/flytekit-sdk/flytekit.tools.interactive.md index de7cf1a3c2..42fd4ceac3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.tools.interactive.md +++ b/content/api-reference/flytekit-sdk/flytekit.tools.interactive.md @@ -1,7 +1,7 @@ --- title: flytekit.tools.interactive icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.tools.module_loader.md b/content/api-reference/flytekit-sdk/flytekit.tools.module_loader.md index bdf9c568cf..998cf4c323 100644 --- a/content/api-reference/flytekit-sdk/flytekit.tools.module_loader.md +++ b/content/api-reference/flytekit-sdk/flytekit.tools.module_loader.md @@ -1,7 +1,7 @@ --- title: flytekit.tools.module_loader icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.tools.repo.md b/content/api-reference/flytekit-sdk/flytekit.tools.repo.md index b6bc211e53..61441606a5 100644 --- a/content/api-reference/flytekit-sdk/flytekit.tools.repo.md +++ b/content/api-reference/flytekit-sdk/flytekit.tools.repo.md @@ -1,7 +1,7 @@ --- title: flytekit.tools.repo icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.tools.script_mode.md b/content/api-reference/flytekit-sdk/flytekit.tools.script_mode.md index 4327e70fb2..2222daf36a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.tools.script_mode.md +++ b/content/api-reference/flytekit-sdk/flytekit.tools.script_mode.md @@ -1,7 +1,7 @@ --- title: flytekit.tools.script_mode icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.tools.serialize_helpers.md b/content/api-reference/flytekit-sdk/flytekit.tools.serialize_helpers.md index 13c53d5237..f17f75813a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.tools.serialize_helpers.md +++ b/content/api-reference/flytekit-sdk/flytekit.tools.serialize_helpers.md @@ -1,7 +1,7 @@ --- title: flytekit.tools.serialize_helpers icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.tools.subprocess.md b/content/api-reference/flytekit-sdk/flytekit.tools.subprocess.md index 30fc53a542..41a86eb5ca 100644 --- a/content/api-reference/flytekit-sdk/flytekit.tools.subprocess.md +++ b/content/api-reference/flytekit-sdk/flytekit.tools.subprocess.md @@ -1,7 +1,7 @@ --- title: flytekit.tools.subprocess icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.tools.translator.md b/content/api-reference/flytekit-sdk/flytekit.tools.translator.md index 2a298ada11..dab37b30a8 100644 --- a/content/api-reference/flytekit-sdk/flytekit.tools.translator.md +++ b/content/api-reference/flytekit-sdk/flytekit.tools.translator.md @@ -1,7 +1,7 @@ --- title: flytekit.tools.translator icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.directory.md b/content/api-reference/flytekit-sdk/flytekit.types.directory.md index ac59483ff1..9a180bf89d 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.directory.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.directory.md @@ -2,7 +2,7 @@ title: flytekit.types.directory description: "Similar to {{< py_class_ref flytekit.types.file.FlyteFile >}} there are some 'preformatted' directory types." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.directory.types.md b/content/api-reference/flytekit-sdk/flytekit.types.directory.types.md index ed3adbf725..11e2919842 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.directory.types.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.directory.types.md @@ -1,7 +1,7 @@ --- title: flytekit.types.directory.types icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.error.error.md b/content/api-reference/flytekit-sdk/flytekit.types.error.error.md index e14f667dea..b310423719 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.error.error.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.error.error.md @@ -1,7 +1,7 @@ --- title: flytekit.types.error.error icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.file.file.md b/content/api-reference/flytekit-sdk/flytekit.types.file.file.md index 0ceeecab36..2f6406fddd 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.file.file.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.file.file.md @@ -1,7 +1,7 @@ --- title: flytekit.types.file.file icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.file.image.md b/content/api-reference/flytekit-sdk/flytekit.types.file.image.md index caad1ba604..2893b262a9 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.file.image.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.file.image.md @@ -1,7 +1,7 @@ --- title: flytekit.types.file.image icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.file.md b/content/api-reference/flytekit-sdk/flytekit.types.file.md index 554f3c9e6b..3fa0c43241 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.file.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.file.md @@ -2,7 +2,7 @@ title: flytekit.types.file description: "This module provides functionality related to FlyteFile." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.iterator.iterator.md b/content/api-reference/flytekit-sdk/flytekit.types.iterator.iterator.md index 1b83f2c62d..22f13fa330 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.iterator.iterator.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.iterator.iterator.md @@ -1,7 +1,7 @@ --- title: flytekit.types.iterator.iterator icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.iterator.json_iterator.md b/content/api-reference/flytekit-sdk/flytekit.types.iterator.json_iterator.md index b33180e80d..616d2bd0d0 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.iterator.json_iterator.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.iterator.json_iterator.md @@ -1,7 +1,7 @@ --- title: flytekit.types.iterator.json_iterator icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.numpy.ndarray.md b/content/api-reference/flytekit-sdk/flytekit.types.numpy.ndarray.md index a90110f86a..08d72e8dbf 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.numpy.ndarray.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.numpy.ndarray.md @@ -1,7 +1,7 @@ --- title: flytekit.types.numpy.ndarray icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.pickle.pickle.md b/content/api-reference/flytekit-sdk/flytekit.types.pickle.pickle.md index 22b2666449..5bb1080bee 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.pickle.pickle.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.pickle.pickle.md @@ -1,7 +1,7 @@ --- title: flytekit.types.pickle.pickle icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.schema.types.md b/content/api-reference/flytekit-sdk/flytekit.types.schema.types.md index 23330917e3..b4d458a8e1 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.schema.types.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.schema.types.md @@ -1,7 +1,7 @@ --- title: flytekit.types.schema.types icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.schema.types_pandas.md b/content/api-reference/flytekit-sdk/flytekit.types.schema.types_pandas.md index 115bf9b32e..53748ded52 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.schema.types_pandas.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.schema.types_pandas.md @@ -1,7 +1,7 @@ --- title: flytekit.types.schema.types_pandas icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.structured.basic_dfs.md b/content/api-reference/flytekit-sdk/flytekit.types.structured.basic_dfs.md index 128b42b1b3..e1ddbab98a 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.structured.basic_dfs.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.structured.basic_dfs.md @@ -1,7 +1,7 @@ --- title: flytekit.types.structured.basic_dfs icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.structured.bigquery.md b/content/api-reference/flytekit-sdk/flytekit.types.structured.bigquery.md index 2b4f5bfb51..147e28a828 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.structured.bigquery.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.structured.bigquery.md @@ -1,7 +1,7 @@ --- title: flytekit.types.structured.bigquery icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.structured.md b/content/api-reference/flytekit-sdk/flytekit.types.structured.md index 4a5ebaf0c5..9f6c0c6504 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.structured.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.structured.md @@ -1,7 +1,7 @@ --- title: flytekit.types.structured icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.structured.snowflake.md b/content/api-reference/flytekit-sdk/flytekit.types.structured.snowflake.md index 50c0575ce4..4be0f9f016 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.structured.snowflake.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.structured.snowflake.md @@ -1,7 +1,7 @@ --- title: flytekit.types.structured.snowflake icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.types.structured.structured_dataset.md b/content/api-reference/flytekit-sdk/flytekit.types.structured.structured_dataset.md index ffe279fcda..6e1099adda 100644 --- a/content/api-reference/flytekit-sdk/flytekit.types.structured.structured_dataset.md +++ b/content/api-reference/flytekit-sdk/flytekit.types.structured.structured_dataset.md @@ -1,7 +1,7 @@ --- title: flytekit.types.structured.structured_dataset icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.utils.asyn.md b/content/api-reference/flytekit-sdk/flytekit.utils.asyn.md index 0ab2bd933d..cb7b78af82 100644 --- a/content/api-reference/flytekit-sdk/flytekit.utils.asyn.md +++ b/content/api-reference/flytekit-sdk/flytekit.utils.asyn.md @@ -2,7 +2,7 @@ title: flytekit.utils.asyn description: "Manages an async event loop on another thread." icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.utils.dict_formatter.md b/content/api-reference/flytekit-sdk/flytekit.utils.dict_formatter.md index b8197a0287..97f2e39d95 100644 --- a/content/api-reference/flytekit-sdk/flytekit.utils.dict_formatter.md +++ b/content/api-reference/flytekit-sdk/flytekit.utils.dict_formatter.md @@ -1,7 +1,7 @@ --- title: flytekit.utils.dict_formatter icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.utils.pbhash.md b/content/api-reference/flytekit-sdk/flytekit.utils.pbhash.md index 4ac57b666c..4f4d1e0177 100644 --- a/content/api-reference/flytekit-sdk/flytekit.utils.pbhash.md +++ b/content/api-reference/flytekit-sdk/flytekit.utils.pbhash.md @@ -1,7 +1,7 @@ --- title: flytekit.utils.pbhash icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/flytekit-sdk/flytekit.utils.rate_limiter.md b/content/api-reference/flytekit-sdk/flytekit.utils.rate_limiter.md index 69b0800b2d..477de43ad3 100644 --- a/content/api-reference/flytekit-sdk/flytekit.utils.rate_limiter.md +++ b/content/api-reference/flytekit-sdk/flytekit.utils.rate_limiter.md @@ -1,7 +1,7 @@ --- title: flytekit.utils.rate_limiter icon: box-seam -version: 1.16.28 +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/airflow/_index.md b/content/api-reference/plugins/airflow/_index.md index 78b95a2304..1187c24980 100644 --- a/content/api-reference/plugins/airflow/_index.md +++ b/content/api-reference/plugins/airflow/_index.md @@ -1,6 +1,8 @@ --- title: Apache Airflow -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.airflow." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/airflow/flytekitplugins.airflow.connector.md b/content/api-reference/plugins/airflow/flytekitplugins.airflow.connector.md index 64178358ab..5db364f81e 100644 --- a/content/api-reference/plugins/airflow/flytekitplugins.airflow.connector.md +++ b/content/api-reference/plugins/airflow/flytekitplugins.airflow.connector.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.airflow.connector -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/airflow/flytekitplugins.airflow.task.md b/content/api-reference/plugins/airflow/flytekitplugins.airflow.task.md index 95b1bbfddd..7c3bcaf107 100644 --- a/content/api-reference/plugins/airflow/flytekitplugins.airflow.task.md +++ b/content/api-reference/plugins/airflow/flytekitplugins.airflow.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.airflow.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -80,10 +81,10 @@ class AirflowContainerTask( |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -97,8 +98,8 @@ class AirflowContainerTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | @@ -538,7 +539,7 @@ class AirflowTask( | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`connector_signal_handler()`](#connector_signal_handler) | | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | | [`execute()`](#execute) | | | [`find_lhs()`](#find_lhs) | | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | @@ -552,8 +553,8 @@ class AirflowTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | diff --git a/content/api-reference/plugins/async-fsspec/_index.md b/content/api-reference/plugins/async-fsspec/_index.md index 0edf2d3f4d..b4faa29dd9 100644 --- a/content/api-reference/plugins/async-fsspec/_index.md +++ b/content/api-reference/plugins/async-fsspec/_index.md @@ -1,6 +1,8 @@ --- title: Async FSSpec -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.async_fsspec." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/async-fsspec/flytekitplugins.async_fsspec.s3fs.constants.md b/content/api-reference/plugins/async-fsspec/flytekitplugins.async_fsspec.s3fs.constants.md index 16f0abcff6..ae72e9ebd8 100644 --- a/content/api-reference/plugins/async-fsspec/flytekitplugins.async_fsspec.s3fs.constants.md +++ b/content/api-reference/plugins/async-fsspec/flytekitplugins.async_fsspec.s3fs.constants.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.async_fsspec.s3fs.constants -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/async-fsspec/flytekitplugins.async_fsspec.s3fs.s3fs.md b/content/api-reference/plugins/async-fsspec/flytekitplugins.async_fsspec.s3fs.s3fs.md index e0fbfbd17e..1bcc411806 100644 --- a/content/api-reference/plugins/async-fsspec/flytekitplugins.async_fsspec.s3fs.s3fs.md +++ b/content/api-reference/plugins/async-fsspec/flytekitplugins.async_fsspec.s3fs.s3fs.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.async_fsspec.s3fs.s3fs -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/hive/_index.md b/content/api-reference/plugins/hive/_index.md index ddbcb44c5d..3aed4a118e 100644 --- a/content/api-reference/plugins/hive/_index.md +++ b/content/api-reference/plugins/hive/_index.md @@ -1,6 +1,8 @@ --- title: Hive -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.hive." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/hive/flytekitplugins.hive.task.md b/content/api-reference/plugins/hive/flytekitplugins.hive.task.md index 27f3b40a24..740c13e6c7 100644 --- a/content/api-reference/plugins/hive/flytekitplugins.hive.task.md +++ b/content/api-reference/plugins/hive/flytekitplugins.hive.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.hive.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -99,7 +100,7 @@ stage_query: optional query that should be executed before the actual ``select_q |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | @@ -115,8 +116,8 @@ stage_query: optional query that should be executed before the actual ``select_q | [`interpolate_query()`](#interpolate_query) | This function will fill in the query template with the provided kwargs and return the interpolated query. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | @@ -482,7 +483,7 @@ output_schema_type: If some data is produced by this query, then you can specify |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | @@ -498,8 +499,8 @@ output_schema_type: If some data is produced by this query, then you can specify | [`interpolate_query()`](#interpolate_query) | This function will fill in the query template with the provided kwargs and return the interpolated query. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | diff --git a/content/api-reference/plugins/huggingface/_index.md b/content/api-reference/plugins/huggingface/_index.md index 26b887eb5b..1b8c20ead7 100644 --- a/content/api-reference/plugins/huggingface/_index.md +++ b/content/api-reference/plugins/huggingface/_index.md @@ -1,6 +1,8 @@ --- title: Hugging Face -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.huggingface." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -15,7 +17,7 @@ layout: py_api | Class | Description | |-|-| -| [`flytekitplugins.huggingface.sd_transformers.HuggingFaceDatasetRenderer`](flytekitplugins.huggingface.sd_transformers#flytekitpluginshuggingfacesd_transformershuggingfacedatasetrenderer) | The datasets. | +| [`flytekitplugins.huggingface.sd_transformers.HuggingFaceDatasetRenderer`](flytekitplugins.huggingface.sd_transformers#flytekitpluginshuggingfacesd_transformershuggingfacedatasetrenderer) | The datasets.Dataset printable representation is saved to HTML. | | [`flytekitplugins.huggingface.sd_transformers.HuggingFaceDatasetToParquetEncodingHandler`](flytekitplugins.huggingface.sd_transformers#flytekitpluginshuggingfacesd_transformershuggingfacedatasettoparquetencodinghandler) | | | [`flytekitplugins.huggingface.sd_transformers.ParquetToHuggingFaceDatasetDecodingHandler`](flytekitplugins.huggingface.sd_transformers#flytekitpluginshuggingfacesd_transformersparquettohuggingfacedatasetdecodinghandler) | | diff --git a/content/api-reference/plugins/huggingface/flytekitplugins.huggingface.sd_transformers.md b/content/api-reference/plugins/huggingface/flytekitplugins.huggingface.sd_transformers.md index a1736bae22..e5bba94257 100644 --- a/content/api-reference/plugins/huggingface/flytekitplugins.huggingface.sd_transformers.md +++ b/content/api-reference/plugins/huggingface/flytekitplugins.huggingface.sd_transformers.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.huggingface.sd_transformers -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -13,7 +14,7 @@ layout: py_api | Class | Description | |-|-| -| [`HuggingFaceDatasetRenderer`](./flytekitplugins.huggingface.sd_transformers#flytekitpluginshuggingfacesd_transformershuggingfacedatasetrenderer) | The datasets. | +| [`HuggingFaceDatasetRenderer`](./flytekitplugins.huggingface.sd_transformers#flytekitpluginshuggingfacesd_transformershuggingfacedatasetrenderer) | The datasets.Dataset printable representation is saved to HTML. | | [`HuggingFaceDatasetToParquetEncodingHandler`](./flytekitplugins.huggingface.sd_transformers#flytekitpluginshuggingfacesd_transformershuggingfacedatasettoparquetencodinghandler) | | | [`ParquetToHuggingFaceDatasetDecodingHandler`](./flytekitplugins.huggingface.sd_transformers#flytekitpluginshuggingfacesd_transformersparquettohuggingfacedatasetdecodinghandler) | | @@ -73,7 +74,7 @@ the StructuredDatasetEncoder | Method | Description | |-|-| -| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the. | +| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the incoming dataframe with defaults set for that dataframe type. | #### encode() @@ -129,7 +130,7 @@ and we have to get a Python value out of it. For the other way, see the Structur | Method | Description | |-|-| -| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal. | +| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal value into a Python instance. | #### decode() diff --git a/content/api-reference/plugins/identity-aware-proxy/_index.md b/content/api-reference/plugins/identity-aware-proxy/_index.md index da5a82422b..9e65340ded 100644 --- a/content/api-reference/plugins/identity-aware-proxy/_index.md +++ b/content/api-reference/plugins/identity-aware-proxy/_index.md @@ -1,6 +1,7 @@ --- title: Google IAP -version: 1.16.28 +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -15,7 +16,7 @@ layout: py_api | Class | Description | |-|-| -| [`flytekitplugins.identity_aware_proxy.cli.GCPIdentityAwareProxyAuthenticator`](flytekitplugins.identity_aware_proxy.cli#flytekitpluginsidentity_aware_proxycligcpidentityawareproxyauthenticator) | This Authenticator encapsulates the entire OAauth 2. | +| [`flytekitplugins.identity_aware_proxy.cli.GCPIdentityAwareProxyAuthenticator`](flytekitplugins.identity_aware_proxy.cli#flytekitpluginsidentity_aware_proxycligcpidentityawareproxyauthenticator) | This Authenticator encapsulates the entire OAauth 2.0 flow with GCP Identity Aware Proxy. | ### Functions diff --git a/content/api-reference/plugins/identity-aware-proxy/flytekitplugins.identity_aware_proxy.cli.md b/content/api-reference/plugins/identity-aware-proxy/flytekitplugins.identity_aware_proxy.cli.md index 77b4b95a51..b2c7164630 100644 --- a/content/api-reference/plugins/identity-aware-proxy/flytekitplugins.identity_aware_proxy.cli.md +++ b/content/api-reference/plugins/identity-aware-proxy/flytekitplugins.identity_aware_proxy.cli.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.identity_aware_proxy.cli -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -13,7 +14,7 @@ layout: py_api | Class | Description | |-|-| -| [`GCPIdentityAwareProxyAuthenticator`](./flytekitplugins.identity_aware_proxy.cli#flytekitpluginsidentity_aware_proxycligcpidentityawareproxyauthenticator) | This Authenticator encapsulates the entire OAauth 2. | +| [`GCPIdentityAwareProxyAuthenticator`](./flytekitplugins.identity_aware_proxy.cli#flytekitpluginsidentity_aware_proxycligcpidentityawareproxyauthenticator) | This Authenticator encapsulates the entire OAauth 2.0 flow with GCP Identity Aware Proxy. | ### Methods diff --git a/content/api-reference/plugins/inference/_index.md b/content/api-reference/plugins/inference/_index.md index 16cd4f8563..fb89a6e345 100644 --- a/content/api-reference/plugins/inference/_index.md +++ b/content/api-reference/plugins/inference/_index.md @@ -1,6 +1,8 @@ --- title: Inference -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.inference." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/inference/flytekitplugins.inference.nim.serve.md b/content/api-reference/plugins/inference/flytekitplugins.inference.nim.serve.md index 096fb88a1b..7f746e7e6a 100644 --- a/content/api-reference/plugins/inference/flytekitplugins.inference.nim.serve.md +++ b/content/api-reference/plugins/inference/flytekitplugins.inference.nim.serve.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.inference.nim.serve -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/inference/flytekitplugins.inference.ollama.serve.md b/content/api-reference/plugins/inference/flytekitplugins.inference.ollama.serve.md index e42e93d250..9380fd4647 100644 --- a/content/api-reference/plugins/inference/flytekitplugins.inference.ollama.serve.md +++ b/content/api-reference/plugins/inference/flytekitplugins.inference.ollama.serve.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.inference.ollama.serve -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/inference/flytekitplugins.inference.sidecar_template.md b/content/api-reference/plugins/inference/flytekitplugins.inference.sidecar_template.md index ba61573936..f63558ab00 100644 --- a/content/api-reference/plugins/inference/flytekitplugins.inference.sidecar_template.md +++ b/content/api-reference/plugins/inference/flytekitplugins.inference.sidecar_template.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.inference.sidecar_template -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/inference/flytekitplugins.inference.vllm.serve.md b/content/api-reference/plugins/inference/flytekitplugins.inference.vllm.serve.md index 6c1f5ef472..1c496b9497 100644 --- a/content/api-reference/plugins/inference/flytekitplugins.inference.vllm.serve.md +++ b/content/api-reference/plugins/inference/flytekitplugins.inference.vllm.serve.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.inference.vllm.serve -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/k8s-pod/_index.md b/content/api-reference/plugins/k8s-pod/_index.md index bf5118a9a2..4129f5e43c 100644 --- a/content/api-reference/plugins/k8s-pod/_index.md +++ b/content/api-reference/plugins/k8s-pod/_index.md @@ -1,6 +1,7 @@ --- title: Kubernetes Pod -version: 1.16.28 +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/k8s-pod/flytekitplugins.pod.task.md b/content/api-reference/plugins/k8s-pod/flytekitplugins.pod.task.md index 1eb3957a67..c57b6574de 100644 --- a/content/api-reference/plugins/k8s-pod/flytekitplugins.pod.task.md +++ b/content/api-reference/plugins/k8s-pod/flytekitplugins.pod.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.pod.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -96,13 +97,13 @@ class PodFunctionTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -116,8 +117,8 @@ class PodFunctionTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | diff --git a/content/api-reference/plugins/kf-mpi/_index.md b/content/api-reference/plugins/kf-mpi/_index.md index 5fcce8861d..ad0fee538c 100644 --- a/content/api-reference/plugins/kf-mpi/_index.md +++ b/content/api-reference/plugins/kf-mpi/_index.md @@ -1,6 +1,8 @@ --- title: Kubeflow MPI -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.kfmpi." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -16,11 +18,11 @@ layout: py_api | Class | Description | |-|-| | [`flytekitplugins.kfmpi.task.CleanPodPolicy`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskcleanpodpolicy) | CleanPodPolicy describes how to deal with pods when the job is finished. | -| [`flytekitplugins.kfmpi.task.HorovodFunctionTask`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskhorovodfunctiontask) | For more info, check out https://github. | -| [`flytekitplugins.kfmpi.task.HorovodJob`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskhorovodjob) | Configuration for an executable [`Horovod Job using MPI operator`](https://github. | +| [`flytekitplugins.kfmpi.task.HorovodFunctionTask`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskhorovodfunctiontask) | For more info, check out https://github.com/horovod/horovod. | +| [`flytekitplugins.kfmpi.task.HorovodJob`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskhorovodjob) | Configuration for an executable [`Horovod Job using MPI operator`](https://github.com/kubeflow/mpi-operator). | | [`flytekitplugins.kfmpi.task.Launcher`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitasklauncher) | Launcher replica configuration. | -| [`flytekitplugins.kfmpi.task.MPIFunctionTask`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskmpifunctiontask) | Plugin that submits a MPIJob (see https://github. | -| [`flytekitplugins.kfmpi.task.MPIJob`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskmpijob) | Configuration for an executable [`MPI Job`](https://github. | +| [`flytekitplugins.kfmpi.task.MPIFunctionTask`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskmpifunctiontask) | Plugin that submits a MPIJob (see https://github.com/kubeflow/mpi-operator) defined by the code within the _task_function to k8s cluster. | +| [`flytekitplugins.kfmpi.task.MPIJob`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskmpijob) | Configuration for an executable [`MPI Job`](https://github.com/kubeflow/mpi-operator). | | [`flytekitplugins.kfmpi.task.RestartPolicy`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskrestartpolicy) | RestartPolicy describes how the replicas should be restarted. | | [`flytekitplugins.kfmpi.task.RunPolicy`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskrunpolicy) | RunPolicy describes some policy to apply to the execution of a kubeflow job. | | [`flytekitplugins.kfmpi.task.Worker`](flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskworker) | Worker replica configuration. | @@ -29,5 +31,5 @@ layout: py_api | Package | Description | |-|-| -| [`flytekitplugins.kfmpi.task`](flytekitplugins.kfmpi.task) | This Plugin adds the capability of running distributed MPI training to Flyte using backend plugins, natively on. | +| [`flytekitplugins.kfmpi.task`](flytekitplugins.kfmpi.task) | This Plugin adds the capability of running distributed MPI training to Flyte using backend plugins, natively on Kubernetes. | diff --git a/content/api-reference/plugins/kf-mpi/flytekitplugins.kfmpi.task.md b/content/api-reference/plugins/kf-mpi/flytekitplugins.kfmpi.task.md index 5be67eebcb..db18cf64cf 100644 --- a/content/api-reference/plugins/kf-mpi/flytekitplugins.kfmpi.task.md +++ b/content/api-reference/plugins/kf-mpi/flytekitplugins.kfmpi.task.md @@ -1,6 +1,8 @@ --- title: flytekitplugins.kfmpi.task -version: 1.16.28 +description: "This Plugin adds the capability of running distributed MPI training to Flyte using backend plugins, natively on Kubernetes." +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -16,11 +18,11 @@ Kubernetes. It leverages [`MPI Job`](https://github.com/kubeflow/mpi-operator) P | Class | Description | |-|-| | [`CleanPodPolicy`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskcleanpodpolicy) | CleanPodPolicy describes how to deal with pods when the job is finished. | -| [`HorovodFunctionTask`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskhorovodfunctiontask) | For more info, check out https://github. | -| [`HorovodJob`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskhorovodjob) | Configuration for an executable [`Horovod Job using MPI operator`](https://github. | +| [`HorovodFunctionTask`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskhorovodfunctiontask) | For more info, check out https://github.com/horovod/horovod. | +| [`HorovodJob`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskhorovodjob) | Configuration for an executable [`Horovod Job using MPI operator`](https://github.com/kubeflow/mpi-operator). | | [`Launcher`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitasklauncher) | Launcher replica configuration. | -| [`MPIFunctionTask`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskmpifunctiontask) | Plugin that submits a MPIJob (see https://github. | -| [`MPIJob`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskmpijob) | Configuration for an executable [`MPI Job`](https://github. | +| [`MPIFunctionTask`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskmpifunctiontask) | Plugin that submits a MPIJob (see https://github.com/kubeflow/mpi-operator) defined by the code within the _task_function to k8s cluster. | +| [`MPIJob`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskmpijob) | Configuration for an executable [`MPI Job`](https://github.com/kubeflow/mpi-operator). | | [`RestartPolicy`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskrestartpolicy) | RestartPolicy describes how the replicas should be restarted. | | [`RunPolicy`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskrunpolicy) | RunPolicy describes some policy to apply to the execution of a kubeflow job. | | [`Worker`](./flytekitplugins.kfmpi.task#flytekitpluginskfmpitaskworker) | Worker replica configuration. | @@ -82,13 +84,13 @@ class HorovodFunctionTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -102,8 +104,8 @@ class HorovodFunctionTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | @@ -621,13 +623,13 @@ class MPIFunctionTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -641,8 +643,8 @@ class MPIFunctionTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | diff --git a/content/api-reference/plugins/kf-pytorch/_index.md b/content/api-reference/plugins/kf-pytorch/_index.md index c2faec4dab..993bf56314 100644 --- a/content/api-reference/plugins/kf-pytorch/_index.md +++ b/content/api-reference/plugins/kf-pytorch/_index.md @@ -1,6 +1,8 @@ --- title: Kubeflow PyTorch -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.kfpytorch." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -16,12 +18,12 @@ layout: py_api | Class | Description | |-|-| | [`flytekitplugins.kfpytorch.task.CleanPodPolicy`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskcleanpodpolicy) | CleanPodPolicy describes how to deal with pods when the job is finished. | -| [`flytekitplugins.kfpytorch.task.Elastic`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskelastic) | Configuration for [`torch elastic training`](https://pytorch. | +| [`flytekitplugins.kfpytorch.task.Elastic`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskelastic) | Configuration for [`torch elastic training`](https://pytorch.org/docs/stable/elastic/run.html). | | [`flytekitplugins.kfpytorch.task.ElasticWorkerResult`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskelasticworkerresult) | A named tuple representing the result of a torch elastic worker process. | | [`flytekitplugins.kfpytorch.task.Master`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskmaster) | Configuration for master replica group. | -| [`flytekitplugins.kfpytorch.task.PyTorch`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorch) | Configuration for an executable [`PyTorch Job`](https://github. | -| [`flytekitplugins.kfpytorch.task.PyTorchFunctionTask`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorchfunctiontask) | Plugin that submits a PyTorchJob (see https://github. | -| [`flytekitplugins.kfpytorch.task.PytorchElasticFunctionTask`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorchelasticfunctiontask) | Plugin for distributed training with torch elastic/torchrun (see. | +| [`flytekitplugins.kfpytorch.task.PyTorch`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorch) | Configuration for an executable [`PyTorch Job`](https://github.com/kubeflow/pytorch-operator). | +| [`flytekitplugins.kfpytorch.task.PyTorchFunctionTask`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorchfunctiontask) | Plugin that submits a PyTorchJob (see https://github.com/kubeflow/pytorch-operator) defined by the code within the _task_function to k8s cluster. | +| [`flytekitplugins.kfpytorch.task.PytorchElasticFunctionTask`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorchelasticfunctiontask) | Plugin for distributed training with torch elastic/torchrun (see https://pytorch.org/docs/stable/elastic/run.html). | | [`flytekitplugins.kfpytorch.task.RestartPolicy`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskrestartpolicy) | RestartPolicy describes how the replicas should be restarted. | | [`flytekitplugins.kfpytorch.task.RunPolicy`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskrunpolicy) | RunPolicy describes some policy to apply to the execution of a kubeflow job. | | [`flytekitplugins.kfpytorch.task.Worker`](flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskworker) | | @@ -41,5 +43,5 @@ layout: py_api |-|-| | [`flytekitplugins.kfpytorch.error_handling`](flytekitplugins.kfpytorch.error_handling) | Handle errors in elastic training jobs. | | [`flytekitplugins.kfpytorch.pod_template`](flytekitplugins.kfpytorch.pod_template) | | -| [`flytekitplugins.kfpytorch.task`](flytekitplugins.kfpytorch.task) | This Plugin adds the capability of running distributed pytorch training to Flyte using backend plugins, natively on. | +| [`flytekitplugins.kfpytorch.task`](flytekitplugins.kfpytorch.task) | This Plugin adds the capability of running distributed pytorch training to Flyte using backend plugins, natively on Kubernetes. | diff --git a/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.error_handling.md b/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.error_handling.md index c1333ad9e6..7f3704c529 100644 --- a/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.error_handling.md +++ b/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.error_handling.md @@ -1,6 +1,8 @@ --- title: flytekitplugins.kfpytorch.error_handling -version: 1.16.28 +description: "Handle errors in elastic training jobs." +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.pod_template.md b/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.pod_template.md index 040c2f0843..d940a35d12 100644 --- a/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.pod_template.md +++ b/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.pod_template.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.kfpytorch.pod_template -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.task.md b/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.task.md index 5fb992e740..a611d48d39 100644 --- a/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.task.md +++ b/content/api-reference/plugins/kf-pytorch/flytekitplugins.kfpytorch.task.md @@ -1,6 +1,8 @@ --- title: flytekitplugins.kfpytorch.task -version: 1.16.28 +description: "This Plugin adds the capability of running distributed pytorch training to Flyte using backend plugins, natively on Kubernetes." +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -16,12 +18,12 @@ Kubernetes. It leverages [`Pytorch Job`](https://github.com/kubeflow/pytorch-ope | Class | Description | |-|-| | [`CleanPodPolicy`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskcleanpodpolicy) | CleanPodPolicy describes how to deal with pods when the job is finished. | -| [`Elastic`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskelastic) | Configuration for [`torch elastic training`](https://pytorch. | +| [`Elastic`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskelastic) | Configuration for [`torch elastic training`](https://pytorch.org/docs/stable/elastic/run.html). | | [`ElasticWorkerResult`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskelasticworkerresult) | A named tuple representing the result of a torch elastic worker process. | | [`Master`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskmaster) | Configuration for master replica group. | -| [`PyTorch`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorch) | Configuration for an executable [`PyTorch Job`](https://github. | -| [`PyTorchFunctionTask`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorchfunctiontask) | Plugin that submits a PyTorchJob (see https://github. | -| [`PytorchElasticFunctionTask`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorchelasticfunctiontask) | Plugin for distributed training with torch elastic/torchrun (see. | +| [`PyTorch`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorch) | Configuration for an executable [`PyTorch Job`](https://github.com/kubeflow/pytorch-operator). | +| [`PyTorchFunctionTask`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorchfunctiontask) | Plugin that submits a PyTorchJob (see https://github.com/kubeflow/pytorch-operator) defined by the code within the _task_function to k8s cluster. | +| [`PytorchElasticFunctionTask`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskpytorchelasticfunctiontask) | Plugin for distributed training with torch elastic/torchrun (see https://pytorch.org/docs/stable/elastic/run.html). | | [`RestartPolicy`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskrestartpolicy) | RestartPolicy describes how the replicas should be restarted. | | [`RunPolicy`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskrunpolicy) | RunPolicy describes some policy to apply to the execution of a kubeflow job. | | [`Worker`](./flytekitplugins.kfpytorch.task#flytekitpluginskfpytorchtaskworker) | | @@ -230,13 +232,13 @@ class PyTorchFunctionTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -250,8 +252,8 @@ class PyTorchFunctionTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | @@ -706,13 +708,13 @@ class PytorchElasticFunctionTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -726,8 +728,8 @@ class PytorchElasticFunctionTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | diff --git a/content/api-reference/plugins/kf-tensorflow/_index.md b/content/api-reference/plugins/kf-tensorflow/_index.md index 16c66088c1..4ad464882f 100644 --- a/content/api-reference/plugins/kf-tensorflow/_index.md +++ b/content/api-reference/plugins/kf-tensorflow/_index.md @@ -1,6 +1,8 @@ --- title: Kubeflow TensorFlow -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.kftensorflow." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -21,13 +23,13 @@ layout: py_api | [`flytekitplugins.kftensorflow.task.PS`](flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtaskps) | | | [`flytekitplugins.kftensorflow.task.RestartPolicy`](flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtaskrestartpolicy) | RestartPolicy describes how the replicas should be restarted. | | [`flytekitplugins.kftensorflow.task.RunPolicy`](flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtaskrunpolicy) | RunPolicy describes a set of policies to apply to the execution of a Kubeflow job. | -| [`flytekitplugins.kftensorflow.task.TensorflowFunctionTask`](flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtasktensorflowfunctiontask) | Plugin that submits a TFJob (see https://github. | -| [`flytekitplugins.kftensorflow.task.TfJob`](flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtasktfjob) | Configuration for an executable [`TensorFlow Job`](https://github. | +| [`flytekitplugins.kftensorflow.task.TensorflowFunctionTask`](flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtasktensorflowfunctiontask) | Plugin that submits a TFJob (see https://github.com/kubeflow/tf-operator) defined by the code within the _task_function to k8s cluster. | +| [`flytekitplugins.kftensorflow.task.TfJob`](flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtasktfjob) | Configuration for an executable [`TensorFlow Job`](https://github.com/kubeflow/tf-operator). | | [`flytekitplugins.kftensorflow.task.Worker`](flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtaskworker) | | ### Packages | Package | Description | |-|-| -| [`flytekitplugins.kftensorflow.task`](flytekitplugins.kftensorflow.task) | This Plugin adds the capability of running distributed tensorflow training to Flyte using backend plugins, natively on. | +| [`flytekitplugins.kftensorflow.task`](flytekitplugins.kftensorflow.task) | This Plugin adds the capability of running distributed tensorflow training to Flyte using backend plugins, natively on Kubernetes. | diff --git a/content/api-reference/plugins/kf-tensorflow/flytekitplugins.kftensorflow.task.md b/content/api-reference/plugins/kf-tensorflow/flytekitplugins.kftensorflow.task.md index 2ec34c35f6..cc61b9d3b7 100644 --- a/content/api-reference/plugins/kf-tensorflow/flytekitplugins.kftensorflow.task.md +++ b/content/api-reference/plugins/kf-tensorflow/flytekitplugins.kftensorflow.task.md @@ -1,6 +1,8 @@ --- title: flytekitplugins.kftensorflow.task -version: 1.16.28 +description: "This Plugin adds the capability of running distributed tensorflow training to Flyte using backend plugins, natively on Kubernetes." +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -21,8 +23,8 @@ Kubernetes. It leverages [`TF Job`](https://github.com/kubeflow/tf-operator) Plu | [`PS`](./flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtaskps) | | | [`RestartPolicy`](./flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtaskrestartpolicy) | RestartPolicy describes how the replicas should be restarted. | | [`RunPolicy`](./flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtaskrunpolicy) | RunPolicy describes a set of policies to apply to the execution of a Kubeflow job. | -| [`TensorflowFunctionTask`](./flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtasktensorflowfunctiontask) | Plugin that submits a TFJob (see https://github. | -| [`TfJob`](./flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtasktfjob) | Configuration for an executable [`TensorFlow Job`](https://github. | +| [`TensorflowFunctionTask`](./flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtasktensorflowfunctiontask) | Plugin that submits a TFJob (see https://github.com/kubeflow/tf-operator) defined by the code within the _task_function to k8s cluster. | +| [`TfJob`](./flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtasktfjob) | Configuration for an executable [`TensorFlow Job`](https://github.com/kubeflow/tf-operator). | | [`Worker`](./flytekitplugins.kftensorflow.task#flytekitpluginskftensorflowtaskworker) | | ## flytekitplugins.kftensorflow.task.Chief @@ -174,13 +176,13 @@ class TensorflowFunctionTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -194,8 +196,8 @@ class TensorflowFunctionTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | diff --git a/content/api-reference/plugins/memray/_index.md b/content/api-reference/plugins/memray/_index.md index 87ea005498..d76a6dd762 100644 --- a/content/api-reference/plugins/memray/_index.md +++ b/content/api-reference/plugins/memray/_index.md @@ -1,6 +1,7 @@ --- title: Memray Profiling -version: 1.16.28 +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/memray/flytekitplugins.memray.md b/content/api-reference/plugins/memray/flytekitplugins.memray.md index 11e2cf5738..6727df0ac2 100644 --- a/content/api-reference/plugins/memray/flytekitplugins.memray.md +++ b/content/api-reference/plugins/memray/flytekitplugins.memray.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.memray -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/mmcloud/_index.md b/content/api-reference/plugins/mmcloud/_index.md index 4152c2a96c..adb40df6be 100644 --- a/content/api-reference/plugins/mmcloud/_index.md +++ b/content/api-reference/plugins/mmcloud/_index.md @@ -1,6 +1,8 @@ --- title: Memory Machine Cloud -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.mmcloud." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -24,7 +26,7 @@ layout: py_api | Function | Description | |-|-| -| [`flytekitplugins.mmcloud.utils.async_check_output()`](flytekitplugins.mmcloud.utils#async_check_output) | This behaves similarly to subprocess. | +| [`flytekitplugins.mmcloud.utils.async_check_output()`](flytekitplugins.mmcloud.utils#async_check_output) | This behaves similarly to subprocess.check_output(). | | [`flytekitplugins.mmcloud.utils.flyte_to_mmcloud_resources()`](flytekitplugins.mmcloud.utils#flyte_to_mmcloud_resources) | Map Flyte (K8s) resources to MMCloud resources. | | [`flytekitplugins.mmcloud.utils.mmcloud_status_to_flyte_phase()`](flytekitplugins.mmcloud.utils#mmcloud_status_to_flyte_phase) | Map MMCloud status to Flyte phase. | diff --git a/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.connector.md b/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.connector.md index 4f443aab50..7e700c03a1 100644 --- a/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.connector.md +++ b/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.connector.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.mmcloud.connector -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.task.md b/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.task.md index ea690879a4..e2a2d6ef3a 100644 --- a/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.task.md +++ b/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.mmcloud.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -87,13 +88,13 @@ class MMCloudTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return plugin-specific data as a serializable dictionary. | @@ -107,8 +108,8 @@ class MMCloudTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | diff --git a/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.utils.md b/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.utils.md index c13619b664..d773ea519e 100644 --- a/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.utils.md +++ b/content/api-reference/plugins/mmcloud/flytekitplugins.mmcloud.utils.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.mmcloud.utils -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -13,7 +14,7 @@ layout: py_api | Method | Description | |-|-| -| [`async_check_output()`](#async_check_output) | This behaves similarly to subprocess. | +| [`async_check_output()`](#async_check_output) | This behaves similarly to subprocess.check_output(). | | [`flyte_to_mmcloud_resources()`](#flyte_to_mmcloud_resources) | Map Flyte (K8s) resources to MMCloud resources. | | [`mmcloud_status_to_flyte_phase()`](#mmcloud_status_to_flyte_phase) | Map MMCloud status to Flyte phase. | diff --git a/content/api-reference/plugins/neptune/_index.md b/content/api-reference/plugins/neptune/_index.md index 2b15dcad64..e4b55a669f 100644 --- a/content/api-reference/plugins/neptune/_index.md +++ b/content/api-reference/plugins/neptune/_index.md @@ -1,6 +1,8 @@ --- title: Neptune -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.neptune." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -21,5 +23,5 @@ layout: py_api | Package | Description | |-|-| -| [`flytekitplugins.neptune`](flytekitplugins.neptune) | | +| [`flytekitplugins.neptune`](flytekitplugins.neptune) | .. currentmodule:: flytekitplugins.neptune. | diff --git a/content/api-reference/plugins/neptune/flytekitplugins.neptune.md b/content/api-reference/plugins/neptune/flytekitplugins.neptune.md index 88957e87c5..4b40921398 100644 --- a/content/api-reference/plugins/neptune/flytekitplugins.neptune.md +++ b/content/api-reference/plugins/neptune/flytekitplugins.neptune.md @@ -1,6 +1,8 @@ --- title: flytekitplugins.neptune -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.neptune." +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/omegaconf/_index.md b/content/api-reference/plugins/omegaconf/_index.md index 4e9afbbb22..2a8073b977 100644 --- a/content/api-reference/plugins/omegaconf/_index.md +++ b/content/api-reference/plugins/omegaconf/_index.md @@ -1,6 +1,7 @@ --- title: OmegaConf -version: 1.16.28 +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -15,7 +16,7 @@ layout: py_api | Class | Description | |-|-| -| [`flytekitplugins.omegaconf.OmegaConfTransformerMode`](flytekitplugins.omegaconf#flytekitpluginsomegaconfomegaconftransformermode) | Operation Mode indicating whether a (potentially unannotated) DictConfig object or a structured config using the. | +| [`flytekitplugins.omegaconf.OmegaConfTransformerMode`](flytekitplugins.omegaconf#flytekitpluginsomegaconfomegaconftransformermode) | Operation Mode indicating whether a (potentially unannotated) DictConfig object or a structured config using the underlying dataclass is returned. | ### Functions diff --git a/content/api-reference/plugins/omegaconf/flytekitplugins.omegaconf.md b/content/api-reference/plugins/omegaconf/flytekitplugins.omegaconf.md index 076330e30f..d0aa085508 100644 --- a/content/api-reference/plugins/omegaconf/flytekitplugins.omegaconf.md +++ b/content/api-reference/plugins/omegaconf/flytekitplugins.omegaconf.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.omegaconf -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -13,7 +14,7 @@ layout: py_api | Class | Description | |-|-| -| [`OmegaConfTransformerMode`](./flytekitplugins.omegaconf#flytekitpluginsomegaconfomegaconftransformermode) | Operation Mode indicating whether a (potentially unannotated) DictConfig object or a structured config using the. | +| [`OmegaConfTransformerMode`](./flytekitplugins.omegaconf#flytekitpluginsomegaconfomegaconftransformermode) | Operation Mode indicating whether a (potentially unannotated) DictConfig object or a structured config using the underlying dataclass is returned. | ### Methods diff --git a/content/api-reference/plugins/onnx-scikitlearn/_index.md b/content/api-reference/plugins/onnx-scikitlearn/_index.md index a6ebf024c5..2644b4d21b 100644 --- a/content/api-reference/plugins/onnx-scikitlearn/_index.md +++ b/content/api-reference/plugins/onnx-scikitlearn/_index.md @@ -1,6 +1,8 @@ --- title: ONNX ScikitLearn -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.onnxscikitlearn." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/onnx-scikitlearn/flytekitplugins.onnxscikitlearn.schema.md b/content/api-reference/plugins/onnx-scikitlearn/flytekitplugins.onnxscikitlearn.schema.md index 3a44312da0..16ceac6bda 100644 --- a/content/api-reference/plugins/onnx-scikitlearn/flytekitplugins.onnxscikitlearn.schema.md +++ b/content/api-reference/plugins/onnx-scikitlearn/flytekitplugins.onnxscikitlearn.schema.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.onnxscikitlearn.schema -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -130,7 +131,7 @@ def ScikitLearn2ONNXTransformer() | Method | Description | |-|-| | [`assert_type()`](#assert_type) | | -| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access. | +| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access.｀. | | [`from_generic_idl()`](#from_generic_idl) | TODO: Support all Flyte Types. | | [`get_literal_type()`](#get_literal_type) | Converts the python type to a Flyte LiteralType. | | [`guess_python_type()`](#guess_python_type) | Converts the Flyte LiteralType to a python object type. | diff --git a/content/api-reference/plugins/openai/_index.md b/content/api-reference/plugins/openai/_index.md index 01d1ad2c4c..5b67e47629 100644 --- a/content/api-reference/plugins/openai/_index.md +++ b/content/api-reference/plugins/openai/_index.md @@ -1,6 +1,8 @@ --- title: OpenAI -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.openai." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/openai/flytekitplugins.openai.batch.connector.md b/content/api-reference/plugins/openai/flytekitplugins.openai.batch.connector.md index 99fec95604..3a86fc7ba4 100644 --- a/content/api-reference/plugins/openai/flytekitplugins.openai.batch.connector.md +++ b/content/api-reference/plugins/openai/flytekitplugins.openai.batch.connector.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.openai.batch.connector -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/openai/flytekitplugins.openai.batch.task.md b/content/api-reference/plugins/openai/flytekitplugins.openai.batch.task.md index c6fb0b0b20..f7d5865eb6 100644 --- a/content/api-reference/plugins/openai/flytekitplugins.openai.batch.task.md +++ b/content/api-reference/plugins/openai/flytekitplugins.openai.batch.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.openai.batch.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -69,7 +70,7 @@ class BatchEndpointTask( | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`connector_signal_handler()`](#connector_signal_handler) | | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | | [`execute()`](#execute) | | | [`find_lhs()`](#find_lhs) | | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | @@ -83,8 +84,8 @@ class BatchEndpointTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | @@ -474,7 +475,7 @@ def find_lhs() class DownloadJSONFilesTask( name: str, task_config: flytekitplugins.openai.batch.task.OpenAIFileConfig, - container_image: str = 'cr.flyte.org/flyteorg/flytekit:py3.12-openai-batch-1.16.28', + container_image: str = 'cr.flyte.org/flyteorg/flytekit:py3.12-openai-batch-1.16.29', **kwargs, ) ``` @@ -518,7 +519,7 @@ class DownloadJSONFilesTask( |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This function is largely similar to the base PythonTask, with the exception that we have to infer the Python. | +| [`dispatch_execute()`](#dispatch_execute) | This function is largely similar to the base PythonTask, with the exception that we have to infer the Python interface before executing. | | [`execute()`](#execute) | Rather than running here, send everything to the executor. | | [`find_lhs()`](#find_lhs) | | | [`get_command()`](#get_command) | | @@ -777,7 +778,6 @@ def local_execution_mode() ```python def post_execute( - _: Optional[ExecutionParameters], rval: Any, ) -> Any ``` @@ -786,7 +786,6 @@ This function is a stub, just here to keep dispatch_execute compatibility betwee | Parameter | Type | Description | |-|-|-| -| `_` | `Optional[ExecutionParameters]` | | | `rval` | `Any` | | #### pre_execute() @@ -947,7 +946,7 @@ def find_lhs() class UploadJSONLFileTask( name: str, task_config: flytekitplugins.openai.batch.task.OpenAIFileConfig, - container_image: str = 'cr.flyte.org/flyteorg/flytekit:py3.12-openai-batch-1.16.28', + container_image: str = 'cr.flyte.org/flyteorg/flytekit:py3.12-openai-batch-1.16.29', **kwargs, ) ``` @@ -991,7 +990,7 @@ class UploadJSONLFileTask( |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This function is largely similar to the base PythonTask, with the exception that we have to infer the Python. | +| [`dispatch_execute()`](#dispatch_execute) | This function is largely similar to the base PythonTask, with the exception that we have to infer the Python interface before executing. | | [`execute()`](#execute) | Rather than running here, send everything to the executor. | | [`find_lhs()`](#find_lhs) | | | [`get_command()`](#get_command) | | @@ -1250,7 +1249,6 @@ def local_execution_mode() ```python def post_execute( - _: Optional[ExecutionParameters], rval: Any, ) -> Any ``` @@ -1259,7 +1257,6 @@ This function is a stub, just here to keep dispatch_execute compatibility betwee | Parameter | Type | Description | |-|-|-| -| `_` | `Optional[ExecutionParameters]` | | | `rval` | `Any` | | #### pre_execute() diff --git a/content/api-reference/plugins/openai/flytekitplugins.openai.batch.workflow.md b/content/api-reference/plugins/openai/flytekitplugins.openai.batch.workflow.md index 1ed945cbdd..f5cec51769 100644 --- a/content/api-reference/plugins/openai/flytekitplugins.openai.batch.workflow.md +++ b/content/api-reference/plugins/openai/flytekitplugins.openai.batch.workflow.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.openai.batch.workflow -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/openai/flytekitplugins.openai.chatgpt.connector.md b/content/api-reference/plugins/openai/flytekitplugins.openai.chatgpt.connector.md index 1e2f2efb80..01902859ae 100644 --- a/content/api-reference/plugins/openai/flytekitplugins.openai.chatgpt.connector.md +++ b/content/api-reference/plugins/openai/flytekitplugins.openai.chatgpt.connector.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.openai.chatgpt.connector -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/openai/flytekitplugins.openai.chatgpt.task.md b/content/api-reference/plugins/openai/flytekitplugins.openai.chatgpt.task.md index a9b2400277..d8d3af9f24 100644 --- a/content/api-reference/plugins/openai/flytekitplugins.openai.chatgpt.task.md +++ b/content/api-reference/plugins/openai/flytekitplugins.openai.chatgpt.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.openai.chatgpt.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -69,7 +70,7 @@ chatgpt_config: ChatGPT job configuration. Config structure can be found here. h |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | | [`execute()`](#execute) | | | [`find_lhs()`](#find_lhs) | | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | @@ -83,8 +84,8 @@ chatgpt_config: ChatGPT job configuration. Config structure can be found here. h | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | diff --git a/content/api-reference/plugins/optuna/_index.md b/content/api-reference/plugins/optuna/_index.md index ff5fd1cd32..d5a106c46c 100644 --- a/content/api-reference/plugins/optuna/_index.md +++ b/content/api-reference/plugins/optuna/_index.md @@ -1,6 +1,7 @@ --- title: Optuna -version: 1.16.28 +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/optuna/flytekitplugins.optuna.md b/content/api-reference/plugins/optuna/flytekitplugins.optuna.md index 44313192e6..11fc3fdeef 100644 --- a/content/api-reference/plugins/optuna/flytekitplugins.optuna.md +++ b/content/api-reference/plugins/optuna/flytekitplugins.optuna.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.optuna -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/pandera/_index.md b/content/api-reference/plugins/pandera/_index.md index 6e3fc96e61..d1d01cbabd 100644 --- a/content/api-reference/plugins/pandera/_index.md +++ b/content/api-reference/plugins/pandera/_index.md @@ -1,6 +1,8 @@ --- title: Pandera -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.pandera." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/pandera/flytekitplugins.pandera.config.md b/content/api-reference/plugins/pandera/flytekitplugins.pandera.config.md index c29d8f84f9..c78afab3ef 100644 --- a/content/api-reference/plugins/pandera/flytekitplugins.pandera.config.md +++ b/content/api-reference/plugins/pandera/flytekitplugins.pandera.config.md @@ -1,6 +1,8 @@ --- title: flytekitplugins.pandera.config -version: 1.16.28 +description: "Pandera validation configuration." +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/pandera/flytekitplugins.pandera.pandas_renderer.md b/content/api-reference/plugins/pandera/flytekitplugins.pandera.pandas_renderer.md index 8dc36fe959..8d431e32a7 100644 --- a/content/api-reference/plugins/pandera/flytekitplugins.pandera.pandas_renderer.md +++ b/content/api-reference/plugins/pandera/flytekitplugins.pandera.pandas_renderer.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.pandera.pandas_renderer -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/pandera/flytekitplugins.pandera.pandas_transformer.md b/content/api-reference/plugins/pandera/flytekitplugins.pandera.pandas_transformer.md index 75288b8217..1fd5983d64 100644 --- a/content/api-reference/plugins/pandera/flytekitplugins.pandera.pandas_transformer.md +++ b/content/api-reference/plugins/pandera/flytekitplugins.pandera.pandas_transformer.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.pandera.pandas_transformer -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -43,7 +44,7 @@ def PanderaPandasTransformer() | Method | Description | |-|-| | [`assert_type()`](#assert_type) | | -| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access. | +| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access.｀. | | [`from_generic_idl()`](#from_generic_idl) | TODO: Support all Flyte Types. | | [`get_literal_type()`](#get_literal_type) | Converts the python type to a Flyte LiteralType. | | [`guess_python_type()`](#guess_python_type) | Converts the Flyte LiteralType to a python object type. | diff --git a/content/api-reference/plugins/papermill/_index.md b/content/api-reference/plugins/papermill/_index.md index 652bcf044b..ebc71d7fd2 100644 --- a/content/api-reference/plugins/papermill/_index.md +++ b/content/api-reference/plugins/papermill/_index.md @@ -1,6 +1,8 @@ --- title: Papermill -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.papermill." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/papermill/flytekitplugins.papermill.task.md b/content/api-reference/plugins/papermill/flytekitplugins.papermill.task.md index b6a8f60e96..2a1a5c1d5f 100644 --- a/content/api-reference/plugins/papermill/flytekitplugins.papermill.task.md +++ b/content/api-reference/plugins/papermill/flytekitplugins.papermill.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.papermill.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -287,11 +288,11 @@ Please see class level documentation. |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`execute()`](#execute) | TODO: Figure out how to share FlyteContext ExecutionParameters with the notebook kernel (as notebook kernel. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`execute()`](#execute) | TODO: Figure out how to share FlyteContext ExecutionParameters with the notebook kernel (as notebook kernel is executed in a separate python process). | | [`extract_outputs()`](#extract_outputs) | Parse Outputs from Notebook. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -305,9 +306,9 @@ Please see class level documentation. | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | -| [`render_nb_html()`](#render_nb_html) | render output notebook to html. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | +| [`render_nb_html()`](#render_nb_html) | render output notebook to html We are using nbconvert htmlexporter and its classic template later about how to customize the exporter further. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | diff --git a/content/api-reference/plugins/polars/_index.md b/content/api-reference/plugins/polars/_index.md index 52ab565f3e..c9a568e729 100644 --- a/content/api-reference/plugins/polars/_index.md +++ b/content/api-reference/plugins/polars/_index.md @@ -1,6 +1,8 @@ --- title: Polars -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.polars." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/polars/flytekitplugins.polars.sd_transformers.md b/content/api-reference/plugins/polars/flytekitplugins.polars.sd_transformers.md index 8042f5486d..496279b0cb 100644 --- a/content/api-reference/plugins/polars/flytekitplugins.polars.sd_transformers.md +++ b/content/api-reference/plugins/polars/flytekitplugins.polars.sd_transformers.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.polars.sd_transformers -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -51,7 +52,7 @@ and we have to get a Python value out of it. For the other way, see the Structur | Method | Description | |-|-| -| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal. | +| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal value into a Python instance. | #### decode() @@ -103,7 +104,7 @@ and we have to get a Python value out of it. For the other way, see the Structur | Method | Description | |-|-| -| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal. | +| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal value into a Python instance. | #### decode() @@ -179,7 +180,7 @@ the StructuredDatasetEncoder | Method | Description | |-|-| -| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the. | +| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the incoming dataframe with defaults set for that dataframe type. | #### encode() @@ -236,7 +237,7 @@ the StructuredDatasetEncoder | Method | Description | |-|-| -| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the. | +| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the incoming dataframe with defaults set for that dataframe type. | #### encode() diff --git a/content/api-reference/plugins/ray/_index.md b/content/api-reference/plugins/ray/_index.md index 80fdabc667..c70f4b1b7b 100644 --- a/content/api-reference/plugins/ray/_index.md +++ b/content/api-reference/plugins/ray/_index.md @@ -1,6 +1,8 @@ --- title: Ray -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.ray." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -18,7 +20,7 @@ layout: py_api | [`flytekitplugins.ray.models.AutoscalerOptions`](flytekitplugins.ray.models#flytekitpluginsraymodelsautoscaleroptions) | | | [`flytekitplugins.ray.models.HeadGroupSpec`](flytekitplugins.ray.models#flytekitpluginsraymodelsheadgroupspec) | | | [`flytekitplugins.ray.models.RayCluster`](flytekitplugins.ray.models#flytekitpluginsraymodelsraycluster) | Define RayCluster spec that will be used by KubeRay to launch the cluster. | -| [`flytekitplugins.ray.models.RayJob`](flytekitplugins.ray.models#flytekitpluginsraymodelsrayjob) | Models _ray_pb2. | +| [`flytekitplugins.ray.models.RayJob`](flytekitplugins.ray.models#flytekitpluginsraymodelsrayjob) | Models _ray_pb2.RayJob. | | [`flytekitplugins.ray.models.WorkerGroupSpec`](flytekitplugins.ray.models#flytekitpluginsraymodelsworkergroupspec) | | | [`flytekitplugins.ray.task.AutoscalerOptionsConfig`](flytekitplugins.ray.task#flytekitpluginsraytaskautoscaleroptionsconfig) | | | [`flytekitplugins.ray.task.HeadNodeConfig`](flytekitplugins.ray.task#flytekitpluginsraytaskheadnodeconfig) | | diff --git a/content/api-reference/plugins/ray/flytekitplugins.ray.models.md b/content/api-reference/plugins/ray/flytekitplugins.ray.models.md index dc8c8f0388..2608cbd533 100644 --- a/content/api-reference/plugins/ray/flytekitplugins.ray.models.md +++ b/content/api-reference/plugins/ray/flytekitplugins.ray.models.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.ray.models -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -16,7 +17,7 @@ layout: py_api | [`AutoscalerOptions`](./flytekitplugins.ray.models#flytekitpluginsraymodelsautoscaleroptions) | | | [`HeadGroupSpec`](./flytekitplugins.ray.models#flytekitpluginsraymodelsheadgroupspec) | | | [`RayCluster`](./flytekitplugins.ray.models#flytekitpluginsraymodelsraycluster) | Define RayCluster spec that will be used by KubeRay to launch the cluster. | -| [`RayJob`](./flytekitplugins.ray.models#flytekitpluginsraymodelsrayjob) | Models _ray_pb2. | +| [`RayJob`](./flytekitplugins.ray.models#flytekitpluginsraymodelsrayjob) | Models _ray_pb2.RayJob. | | [`WorkerGroupSpec`](./flytekitplugins.ray.models#flytekitpluginsraymodelsworkergroupspec) | | ## flytekitplugins.ray.models.AutoscalerOptions diff --git a/content/api-reference/plugins/ray/flytekitplugins.ray.task.md b/content/api-reference/plugins/ray/flytekitplugins.ray.task.md index 3ecb2bde46..10a9f9a11c 100644 --- a/content/api-reference/plugins/ray/flytekitplugins.ray.task.md +++ b/content/api-reference/plugins/ray/flytekitplugins.ray.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.ray.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -113,13 +114,13 @@ class RayFunctionTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -133,8 +134,8 @@ class RayFunctionTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | diff --git a/content/api-reference/plugins/slurm/_index.md b/content/api-reference/plugins/slurm/_index.md index 580e9d987e..3f97e93d9b 100644 --- a/content/api-reference/plugins/slurm/_index.md +++ b/content/api-reference/plugins/slurm/_index.md @@ -1,6 +1,7 @@ --- title: Slurm -version: 1.16.28 +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/slurm/flytekitplugins.slurm.ssh_utils.md b/content/api-reference/plugins/slurm/flytekitplugins.slurm.ssh_utils.md index b1516f3fa1..cf68600ae2 100644 --- a/content/api-reference/plugins/slurm/flytekitplugins.slurm.ssh_utils.md +++ b/content/api-reference/plugins/slurm/flytekitplugins.slurm.ssh_utils.md @@ -1,6 +1,8 @@ --- title: flytekitplugins.slurm.ssh_utils -version: 1.16.28 +description: "Utilities of asyncssh connections." +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/snowflake/_index.md b/content/api-reference/plugins/snowflake/_index.md index 7accd1afee..6e201f786a 100644 --- a/content/api-reference/plugins/snowflake/_index.md +++ b/content/api-reference/plugins/snowflake/_index.md @@ -1,6 +1,8 @@ --- title: Snowflake -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.snowflake." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/snowflake/flytekitplugins.snowflake.connector.md b/content/api-reference/plugins/snowflake/flytekitplugins.snowflake.connector.md index a4f18f91cb..b0ff7c411a 100644 --- a/content/api-reference/plugins/snowflake/flytekitplugins.snowflake.connector.md +++ b/content/api-reference/plugins/snowflake/flytekitplugins.snowflake.connector.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.snowflake.connector -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/snowflake/flytekitplugins.snowflake.task.md b/content/api-reference/plugins/snowflake/flytekitplugins.snowflake.task.md index 5abc9231ff..e8a3231231 100644 --- a/content/api-reference/plugins/snowflake/flytekitplugins.snowflake.task.md +++ b/content/api-reference/plugins/snowflake/flytekitplugins.snowflake.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.snowflake.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -107,7 +108,7 @@ To be used to query Snowflake databases. | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`connector_signal_handler()`](#connector_signal_handler) | | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | | [`execute()`](#execute) | | | [`find_lhs()`](#find_lhs) | | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | @@ -123,8 +124,8 @@ To be used to query Snowflake databases. | [`interpolate_query()`](#interpolate_query) | This function will fill in the query template with the provided kwargs and return the interpolated query. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | diff --git a/content/api-reference/plugins/spark/_index.md b/content/api-reference/plugins/spark/_index.md index 546b31aa18..32201b9b7f 100644 --- a/content/api-reference/plugins/spark/_index.md +++ b/content/api-reference/plugins/spark/_index.md @@ -1,6 +1,8 @@ --- title: Spark -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.spark." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/spark/flytekitplugins.spark.connector.md b/content/api-reference/plugins/spark/flytekitplugins.spark.connector.md index 531c6585d9..a3eb54b5d0 100644 --- a/content/api-reference/plugins/spark/flytekitplugins.spark.connector.md +++ b/content/api-reference/plugins/spark/flytekitplugins.spark.connector.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.spark.connector -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/spark/flytekitplugins.spark.databricks_auth.md b/content/api-reference/plugins/spark/flytekitplugins.spark.databricks_auth.md index 26307fbee3..4a7f4d0ee0 100644 --- a/content/api-reference/plugins/spark/flytekitplugins.spark.databricks_auth.md +++ b/content/api-reference/plugins/spark/flytekitplugins.spark.databricks_auth.md @@ -1,6 +1,8 @@ --- title: flytekitplugins.spark.databricks_auth -version: 1.16.28 +description: "Authentication strategies for the Databricks connector." +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/spark/flytekitplugins.spark.generic_task.md b/content/api-reference/plugins/spark/flytekitplugins.spark.generic_task.md index a6cc770919..320f400c94 100644 --- a/content/api-reference/plugins/spark/flytekitplugins.spark.generic_task.md +++ b/content/api-reference/plugins/spark/flytekitplugins.spark.generic_task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.spark.generic_task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -86,13 +87,13 @@ class GenericSparkTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -106,8 +107,8 @@ class GenericSparkTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | diff --git a/content/api-reference/plugins/spark/flytekitplugins.spark.models.md b/content/api-reference/plugins/spark/flytekitplugins.spark.models.md index 74481ddda6..0c0c95e41a 100644 --- a/content/api-reference/plugins/spark/flytekitplugins.spark.models.md +++ b/content/api-reference/plugins/spark/flytekitplugins.spark.models.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.spark.models -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/spark/flytekitplugins.spark.pyspark_transformers.md b/content/api-reference/plugins/spark/flytekitplugins.spark.pyspark_transformers.md index f65e7ddd60..405258661e 100644 --- a/content/api-reference/plugins/spark/flytekitplugins.spark.pyspark_transformers.md +++ b/content/api-reference/plugins/spark/flytekitplugins.spark.pyspark_transformers.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.spark.pyspark_transformers -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -36,7 +37,7 @@ def PySparkPipelineModelTransformer() | Method | Description | |-|-| | [`assert_type()`](#assert_type) | | -| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access. | +| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access.｀. | | [`from_generic_idl()`](#from_generic_idl) | TODO: Support all Flyte Types. | | [`get_literal_type()`](#get_literal_type) | Converts the python type to a Flyte LiteralType. | | [`guess_python_type()`](#guess_python_type) | Converts the Flyte LiteralType to a python object type. | diff --git a/content/api-reference/plugins/spark/flytekitplugins.spark.schema.md b/content/api-reference/plugins/spark/flytekitplugins.spark.schema.md index bf093a9065..157ea6b77b 100644 --- a/content/api-reference/plugins/spark/flytekitplugins.spark.schema.md +++ b/content/api-reference/plugins/spark/flytekitplugins.spark.schema.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.spark.schema -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -148,7 +149,7 @@ def ClassicSparkDataFrameTransformer() | Method | Description | |-|-| | [`assert_type()`](#assert_type) | | -| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access. | +| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access.｀. | | [`from_generic_idl()`](#from_generic_idl) | TODO: Support all Flyte Types. | | [`get_literal_type()`](#get_literal_type) | Converts the python type to a Flyte LiteralType. | | [`guess_python_type()`](#guess_python_type) | Converts the Flyte LiteralType to a python object type. | @@ -463,7 +464,7 @@ def SparkDataFrameTransformer() | Method | Description | |-|-| | [`assert_type()`](#assert_type) | | -| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access. | +| [`from_binary_idl()`](#from_binary_idl) | This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access.｀. | | [`from_generic_idl()`](#from_generic_idl) | TODO: Support all Flyte Types. | | [`get_literal_type()`](#get_literal_type) | Converts the python type to a Flyte LiteralType. | | [`guess_python_type()`](#guess_python_type) | Converts the Flyte LiteralType to a python object type. | diff --git a/content/api-reference/plugins/spark/flytekitplugins.spark.sd_transformers.md b/content/api-reference/plugins/spark/flytekitplugins.spark.sd_transformers.md index 664e959977..1553fb0c79 100644 --- a/content/api-reference/plugins/spark/flytekitplugins.spark.sd_transformers.md +++ b/content/api-reference/plugins/spark/flytekitplugins.spark.sd_transformers.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.spark.sd_transformers -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -52,7 +53,7 @@ the StructuredDatasetEncoder | Method | Description | |-|-| -| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the. | +| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the incoming dataframe with defaults set for that dataframe type. | #### encode() @@ -108,7 +109,7 @@ and we have to get a Python value out of it. For the other way, see the Structur | Method | Description | |-|-| -| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal. | +| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal value into a Python instance. | #### decode() @@ -160,7 +161,7 @@ and we have to get a Python value out of it. For the other way, see the Structur | Method | Description | |-|-| -| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal. | +| [`decode()`](#decode) | This is code that will be called by the dataset transformer engine to ultimately translate from a Flyte Literal value into a Python instance. | #### decode() @@ -236,7 +237,7 @@ the StructuredDatasetEncoder | Method | Description | |-|-| -| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the. | +| [`encode()`](#encode) | Even if the user code returns a plain dataframe instance, the dataset transformer engine will wrap the incoming dataframe with defaults set for that dataframe type. | #### encode() diff --git a/content/api-reference/plugins/spark/flytekitplugins.spark.task.md b/content/api-reference/plugins/spark/flytekitplugins.spark.task.md index 45880a675f..f9200ee789 100644 --- a/content/api-reference/plugins/spark/flytekitplugins.spark.task.md +++ b/content/api-reference/plugins/spark/flytekitplugins.spark.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.spark.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -289,14 +290,14 @@ class PysparkFunctionTask( | Method | Description | |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | -| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will. | +| [`compile_into_workflow()`](#compile_into_workflow) | In the case of dynamic workflows, this function will produce a workflow definition at execution time which will then proceed to be executed. | | [`connector_signal_handler()`](#connector_signal_handler) | | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor. | -| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte. | +| [`dispatch_execute()`](#dispatch_execute) | This method translates Flyte's Type system based input values and invokes the actual call to the executor This method is also invoked during runtime. | +| [`dynamic_execute()`](#dynamic_execute) | By the time this function is invoked, the local_execute function should have unwrapped the Promises and Flyte literal wrappers so that the kwargs we are working with here are now Python native literal values. | | [`execute()`](#execute) | This method will be invoked to execute the task. | | [`find_lhs()`](#find_lhs) | | -| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task. | +| [`get_command()`](#get_command) | Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform. | | [`get_config()`](#get_config) | Returns the task config as a serializable dictionary. | | [`get_container()`](#get_container) | Returns the container definition (if any) that is used to run the task on hosted Flyte. | | [`get_custom()`](#get_custom) | Return additional plugin-specific custom data (if any) as a serializable dictionary. | @@ -310,8 +311,8 @@ class PysparkFunctionTask( | [`get_type_for_output_var()`](#get_type_for_output_var) | Returns the python type for the specified output variable by name. | | [`local_execute()`](#local_execute) | This function is used only in the local execution path and is responsible for calling dispatch execute. | | [`local_execution_mode()`](#local_execution_mode) | | -| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up,. | -| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs. | +| [`post_execute()`](#post_execute) | Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. | +| [`pre_execute()`](#pre_execute) | This is the method that will be invoked directly before executing the task method and before all the inputs are converted. | | [`reset_command_fn()`](#reset_command_fn) | Resets the command which should be used in the container definition of this task to the default arguments. | | [`sandbox_execute()`](#sandbox_execute) | Call dispatch_execute, in the context of a local sandbox execution. | | [`set_command_fn()`](#set_command_fn) | By default, the task will run on the Flyte platform using the pyflyte-execute command. | diff --git a/content/api-reference/plugins/spark/flytekitplugins.spark.utils.md b/content/api-reference/plugins/spark/flytekitplugins.spark.utils.md index 21cb3f988b..4d600bf182 100644 --- a/content/api-reference/plugins/spark/flytekitplugins.spark.utils.md +++ b/content/api-reference/plugins/spark/flytekitplugins.spark.utils.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.spark.utils -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/sqlalchemy/_index.md b/content/api-reference/plugins/sqlalchemy/_index.md index a657c11bd1..0223bf5410 100644 --- a/content/api-reference/plugins/sqlalchemy/_index.md +++ b/content/api-reference/plugins/sqlalchemy/_index.md @@ -1,6 +1,8 @@ --- title: SQLAlchemy -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.sqlalchemy." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/plugins/sqlalchemy/flytekitplugins.sqlalchemy.task.md b/content/api-reference/plugins/sqlalchemy/flytekitplugins.sqlalchemy.task.md index bfba43cf45..b3a19bd46f 100644 --- a/content/api-reference/plugins/sqlalchemy/flytekitplugins.sqlalchemy.task.md +++ b/content/api-reference/plugins/sqlalchemy/flytekitplugins.sqlalchemy.task.md @@ -1,6 +1,7 @@ --- title: flytekitplugins.sqlalchemy.task -version: 1.16.28 +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -107,7 +108,7 @@ class SQLAlchemyTask( task_config: flytekitplugins.sqlalchemy.task.SQLAlchemyConfig, inputs: typing.Optional[typing.Dict[str, typing.Type]] = None, output_schema_type: typing.Optional[typing.Type[flytekit.types.schema.types.FlyteSchema]] = flytekit.types.schema.types.FlyteSchema, - container_image: str = 'cr.flyte.org/flyteorg/flytekit:py3.12-sqlalchemy-1.16.28', + container_image: str = 'cr.flyte.org/flyteorg/flytekit:py3.12-sqlalchemy-1.16.29', **kwargs, ) ``` @@ -156,7 +157,7 @@ class SQLAlchemyTask( |-|-| | [`compile()`](#compile) | Generates a node that encapsulates this task in a workflow definition. | | [`construct_node_metadata()`](#construct_node_metadata) | Used when constructing the node that encapsulates this task as part of a broader workflow definition. | -| [`dispatch_execute()`](#dispatch_execute) | This function is largely similar to the base PythonTask, with the exception that we have to infer the Python. | +| [`dispatch_execute()`](#dispatch_execute) | This function is largely similar to the base PythonTask, with the exception that we have to infer the Python interface before executing. | | [`execute()`](#execute) | Rather than running here, send everything to the executor. | | [`find_lhs()`](#find_lhs) | | | [`get_command()`](#get_command) | | @@ -445,7 +446,6 @@ def local_execution_mode() ```python def post_execute( - _: Optional[ExecutionParameters], rval: Any, ) -> Any ``` @@ -454,7 +454,6 @@ This function is a stub, just here to keep dispatch_execute compatibility betwee | Parameter | Type | Description | |-|-|-| -| `_` | `Optional[ExecutionParameters]` | | | `rval` | `Any` | | #### pre_execute() diff --git a/content/api-reference/plugins/wandb/_index.md b/content/api-reference/plugins/wandb/_index.md index 4af20d7ecb..7cbd749273 100644 --- a/content/api-reference/plugins/wandb/_index.md +++ b/content/api-reference/plugins/wandb/_index.md @@ -1,6 +1,8 @@ --- title: Weights & Biases -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.wandb." +icon: book +version: 1.16.29 variants: +flyte +union layout: py_api --- @@ -21,5 +23,5 @@ layout: py_api | Package | Description | |-|-| -| [`flytekitplugins.wandb`](flytekitplugins.wandb) | | +| [`flytekitplugins.wandb`](flytekitplugins.wandb) | .. currentmodule:: flytekitplugins.wandb. | diff --git a/content/api-reference/plugins/wandb/flytekitplugins.wandb.md b/content/api-reference/plugins/wandb/flytekitplugins.wandb.md index 54735ad342..1fd94f5627 100644 --- a/content/api-reference/plugins/wandb/flytekitplugins.wandb.md +++ b/content/api-reference/plugins/wandb/flytekitplugins.wandb.md @@ -1,6 +1,8 @@ --- title: flytekitplugins.wandb -version: 1.16.28 +description: ".. currentmodule:: flytekitplugins.wandb." +icon: box-seam +version: 1.16.29 variants: +flyte +union layout: py_api --- diff --git a/content/api-reference/union-sdk/union.md b/content/api-reference/union-sdk/union.md index c687fac39b..fde1c639c0 100644 --- a/content/api-reference/union-sdk/union.md +++ b/content/api-reference/union-sdk/union.md @@ -137,7 +137,6 @@ or the drop in replacement ArrayNode implementation ```python def task( - _task_function: Optional[Callable[P, FuncOut]] = None, task_config: Optional[T] = None, cache: Union[bool, Cache] = False, retries: int = 0, @@ -208,7 +207,6 @@ Please see some cookbook `task examples` for additional information. | Parameter | Type | Description | |-|-|-| -| `_task_function` | `Optional[Callable[P, FuncOut]]` | This argument is implicitly passed and represents the decorated function | | `task_config` | `Optional[T]` | This argument provides configuration for a specific task types. Please refer to the plugins documentation for the right object to use. | | `cache` | `Union[bool, Cache]` | Boolean or Cache that indicates how caching is configured. | | `retries` | `int` | Number of times to retry this task during a workflow execution. | @@ -241,7 +239,6 @@ Please see some cookbook `task examples` for additional information. ```python def workflow( - _workflow_function: Optional[Callable[P, FuncOut]] = None, failure_policy: Optional[WorkflowFailurePolicy] = None, interruptible: bool = False, on_failure: Optional[Union[WorkflowBase, Task]] = None, @@ -796,7 +793,6 @@ Please see the `user guide` for more usage examples. | Parameter | Type | Description | |-|-|-| -| `_workflow_function` | `Optional[Callable[P, FuncOut]]` | This argument is implicitly passed and represents the decorated function. | | `failure_policy` | `Optional[WorkflowFailurePolicy]` | Use the options in flytekit.WorkflowFailurePolicy | | `interruptible` | `bool` | Whether or not tasks launched from this workflow are by default interruptible | | `on_failure` | `Optional[Union[WorkflowBase, Task]]` | Invoke this workflow or task on failure. The Workflow / task has to match the signature of the current workflow, with an additional parameter called `error` Error | diff --git a/data/version-manifest.json b/data/version-manifest.json index fa446b9992..4bc0de542b 100644 --- a/data/version-manifest.json +++ b/data/version-manifest.json @@ -1,30 +1,26 @@ { - "docs_version": "1.16.28.3", - "tag": "v1.16.28.3", - "z": 3, - "cut_kind": "manual", - "existing_z": [ - 0, - 1, - 2 - ], - "sdk": "1.16.28", + "docs_version": "1.16.29.0", + "tag": "v1.16.29.0", + "z": 0, + "cut_kind": "sdk-release", + "existing_z": [], + "sdk": "1.16.29", "sdk_on_pypi": "true", "sdk_label": "flytekit", "variants": { "union": { - "flytekit": "1.16.28", - "union": "0.1.203", - "examples": "d09852bdfeb7848b5d774e4db7b5240cac5b8617", - "content": "3e81825803a8952b88a2a935d0867f476af99c53", - "infra": "f4ad8dc33f9fa1deb48a1cb2995e12eed671b76d" + "flytekit": "1.16.29", + "union": "0.1.204", + "examples": "3b173a9258fa5a0e796b6bbf47c8bb0aa3b27c4f", + "content": "375704112da4640fddbab0679b8b759c19818801", + "infra": "a49c4ae7378540e1d06028e6fefcb02284715fc2" }, "flyte": { - "flytekit": "1.16.28", - "backend": "v1.16.8", - "examples": "d09852bdfeb7848b5d774e4db7b5240cac5b8617", - "content": "3e81825803a8952b88a2a935d0867f476af99c53", - "infra": "f4ad8dc33f9fa1deb48a1cb2995e12eed671b76d" + "flytekit": "1.16.29", + "backend": "v1.16.9", + "examples": "3b173a9258fa5a0e796b6bbf47c8bb0aa3b27c4f", + "content": "375704112da4640fddbab0679b8b759c19818801", + "infra": "a49c4ae7378540e1d06028e6fefcb02284715fc2" } } } diff --git a/versions.toml b/versions.toml index f9ebd1ca6a..60662b3d74 100644 --- a/versions.toml +++ b/versions.toml @@ -7,11 +7,11 @@ # primary line does; a secondary line (v1) sets false. # indexed = whether this line's stable tree is search-indexed. Defaults true # (the stable tree is normally the line's one canonical surface). -stable = "v1.16.28.3" +stable = "v1.16.29.0" enumerated = [ - "v1.16.28.0", "v1.16.28.1", "v1.16.28.2", + "v1.16.28.3", ] # Pins that have been retired. A pin leaves `enumerated` and arrives here in the # same edit, made by `manifest.py --promote`, and its redirect is DERIVED from @@ -22,6 +22,7 @@ enumerated = [ retired = [ "v1.16.26.3", "v1.16.26.4", + "v1.16.28.0", ] # v1.16.26.2 is deliberately not enumerated. It documents exactly the same