Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
tensorflow
GitHub Repository: tensorflow/docs-l10n
 Path: blob/master/site/es-419/tfx/guide/cli.md
25118 views

Cómo usar la interfaz de línea de comandos de TFX

La interfaz de línea de comandos (CLI) de TFX ejecuta una gama completa de acciones de canalización con orquestadores de canalizaciones, como Kubeflow Pipelines y Vertex Pipelines. El orquestador local también se puede usar para desarrollar o depurar más rápido. Apache Beam y Apache Airflow son compatibles como características experimentales. Por ejemplo, puede utilizar la CLI para las siguientes tareas:

  • Crear, actualizar y eliminar canalizaciones.

  • Ejecutar una canalización y supervisar la ejecución en varios orquestadores.

  • Enumerar canalizaciones y ejecuciones de canalizaciones.

Nota: La CLI de TFX actualmente no ofrece garantías de compatibilidad. La interfaz CLI podría cambiar a medida que se publiquen nuevas versiones.

Acerca de la CLI de TFX

La CLI de TFX se instala como parte del paquete de TFX. Todos los comandos de la CLI siguen la siguiente estructura:


tfx <var>command-group</var> <var>command</var> <var>flags</var>

Actualmente se admiten las siguientes opciones de grupo de comandos:

  • tfx pipeline: cree y administre canalizaciones de TFX.

  • tfx run: cree y administre ejecuciones de canalizaciones de TFX en distintas plataformas de orquestación.

  • tfx template: comandos experimentales para enumerar y copiar plantillas de canalización de TFX.

Cada grupo de comandos proporciona un conjunto de comandos. Siga las instrucciones de las secciones comandos de canalización, comandos de ejecución y comandos de plantilla para obtener más información sobre el uso de estos comandos.

Aviso: Actualmente no todos los comandos son compatibles con todos los orquestadores. Dichos comandos mencionan explícitamente los motores compatibles.

Las marcas le permiten pasar argumentos a comandos de CLI. Las palabras de las marcas se separan por un guion (-) o un guion bajo (_). Por ejemplo, el indicador del nombre de la canalización se puede especificar como --pipeline-name o --pipeline_name. Este documento especifica marcas con guiones bajos para mayor brevedad. Obtenga más información sobre las marcas que se usan en la CLI de TFX.

tfx pipeline

La estructura de los comandos en el grupo de comandos tfx pipeline es la siguiente:


tfx pipeline <var>command</var> <var>required-flags</var> [<var>optional-flags</var>]

Use las siguientes secciones para obtener más información sobre los comandos en el grupo de comandos tfx pipeline.

create

Crea una nueva canalización en el orquestador dado.

Uso:


tfx pipeline create --pipeline_path=<var>pipeline-path</var> [--endpoint=<var>endpoint</var> --engine=<var>engine</var> \
--iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var> \
--build_image --build_base_image=<var>build-base-image</var>]
--pipeline_path=pipeline-path
La ruta al archivo de configuración de la canalización.
--endpoint=endpoint

(Opcional). Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow
  • local: establece el motor en el orquestador local
  • vertex: establece el motor en Vertex Pipelines
  • airflow: (experimental) configura el motor en Apache Airflow
  • beam: (experimental) configura el motor en Apache Beam

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--iap_client_id=iap-client-id
(Opcional). El ID de cliente para el punto de conexión protegido por IAP cuando se utiliza Kubeflow Pipelines.
--namespace=namespace
(Opcional). Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.
--build_image

(Opcional). Cuando el motor es kubeflow o vertex, TFX crea una imagen de contenedor para su canalización, si se especifica. Se usa `Dockerfile` en el directorio actual y, si no existe, TFX generará una automáticamente.

La imagen creada se enviará al registro remoto que se especifica en `KubeflowDagRunnerConfig` o `KubeflowV2DagRunnerConfig`.

--build_base_image=build-base-image

(Opcional). Cuando el motor es kubeflow, TFX crea una imagen de contenedor para su canalización. La imagen base de compilación especifica la imagen base del contenedor que se usará cuando se compile la imagen del contenedor de la canalización.

Ejemplos:

Kubeflow:


tfx pipeline create --engine=kubeflow --pipeline_path=<var>pipeline-path</var> \
--iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var> --endpoint=<var>endpoint</var> \
--build_image

Local:


tfx pipeline create --engine=local --pipeline_path=<var>pipeline-path</var>

Vertex:


tfx pipeline create --engine=vertex --pipeline_path=<var>pipeline-path</var> \
--build_image

Para detectar automáticamente el motor desde el entorno del usuario, simplemente evite usar la marca del motor como en el siguiente ejemplo. Si desea obtener más detalles, consulte la sección sobre marcas.


tfx pipeline create --pipeline_path=<var>pipeline-path</var>

update

Actualiza una canalización existente en el orquestador determinado.

Uso:


tfx pipeline update --pipeline_path=<var>pipeline-path</var> [--endpoint=<var>endpoint</var> --engine=<var>engine</var> \
--iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var> --build_image]
--pipeline_path=pipeline-path
La ruta al archivo de configuración de la canalización.
--endpoint=endpoint

(Opcional). Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow
  • local: establece el motor en el orquestador local
  • vertex: establece el motor en Vertex Pipelines
  • airflow: (experimental) configura el motor en Apache Airflow
  • beam: (experimental) configura el motor en Apache Beam

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--iap_client_id=iap-client-id
(Opcional). El ID de cliente para el punto de conexión protegido por IAP.
--namespace=namespace
(Opcional). Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.
--build_image

(Opcional). Cuando el motor es kubeflow o vertex, TFX crea una imagen de contenedor para su canalización, si se especifica. Se usa `Dockerfile` en el directorio actual.

La imagen creada se enviará al registro remoto que se especifica en `KubeflowDagRunnerConfig` o `KubeflowV2DagRunnerConfig`.

Ejemplos:

Kubeflow:


tfx pipeline update --engine=kubeflow --pipeline_path=<var>pipeline-path</var> \
--iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var> --endpoint=<var>endpoint</var> \
--build_image

Local:


tfx pipeline update --engine=local --pipeline_path=<var>pipeline-path</var>

Vertex:


tfx pipeline update --engine=vertex --pipeline_path=<var>pipeline-path</var> \
--build_image

compile

Compila el archivo de configuración de la canalización para crear un archivo de flujo de trabajo en Kubeflow y ejecuta las siguientes comprobaciones durante la compilación:

  1. Comprueba si la ruta de la canalización es válida.

  2. Comprueba si los detalles de la canalización se extraen correctamente del archivo de configuración de la canalización.

  3. Comprueba si el DagRunner en la configuración de la canalización coincide con el motor.

  4. Comprueba si el archivo de flujo de trabajo se creó correctamente en la ruta del paquete proporcionada (solo para Kubeflow).

Se recomienda usarlo antes de crear o actualizar una canalización.

Uso:


tfx pipeline compile --pipeline_path=<var>pipeline-path</var> [--engine=<var>engine</var>]
--pipeline_path=pipeline-path
La ruta al archivo de configuración de la canalización.
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow
  • local: establece el motor en el orquestador local
  • vertex: establece el motor en Vertex Pipelines
  • airflow: (experimental) configura el motor en Apache Airflow
  • beam: (experimental) configura el motor en Apache Beam

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

Ejemplos:

Kubeflow:


tfx pipeline compile --engine=kubeflow --pipeline_path=<var>pipeline-path</var>

Local:


tfx pipeline compile --engine=local --pipeline_path=<var>pipeline-path</var>

Vertex:


tfx pipeline compile --engine=vertex --pipeline_path=<var>pipeline-path</var>

delete

Elimina una canalización del orquestador determinado.

Uso:


tfx pipeline delete --pipeline_path=<var>pipeline-path</var> [--endpoint=<var>endpoint</var> --engine=<var>engine</var> \
--iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var>]
--pipeline_path=pipeline-path
La ruta al archivo de configuración de la canalización.
--endpoint=endpoint

(Opcional). Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow
  • local: establece el motor en el orquestador local
  • vertex: establece el motor en Vertex Pipelines
  • airflow: (experimental) configura el motor en Apache Airflow
  • beam: (experimental) configura el motor en Apache Beam

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--iap_client_id=iap-client-id
(Opcional). El ID de cliente para el punto de conexión protegido por IAP.
--namespace=namespace
(Opcional). Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.

Ejemplos:

Kubeflow:


tfx pipeline delete --engine=kubeflow --pipeline_name=<var>pipeline-name</var> \
--iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var> --endpoint=<var>endpoint</var>

Local:


tfx pipeline delete --engine=local --pipeline_name=<var>pipeline-name</var>

Vertex:


tfx pipeline delete --engine=vertex --pipeline_name=<var>pipeline-name</var>

list

Enumera todas las canalizaciones en el orquestador determinado.

Uso:


tfx pipeline list [--endpoint=<var>endpoint</var> --engine=<var>engine</var> \
--iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var>]
--endpoint=endpoint

(Opcional). Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow
  • local: establece el motor en el orquestador local
  • vertex: establece el motor en Vertex Pipelines
  • airflow: (experimental) configura el motor en Apache Airflow
  • beam: (experimental) configura el motor en Apache Beam

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--iap_client_id=iap-client-id
(Opcional). El ID de cliente para el punto de conexión protegido por IAP.
--namespace=namespace
(Opcional). Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.

Ejemplos:

Kubeflow:


tfx pipeline list --engine=kubeflow --iap_client_id=<var>iap-client-id</var> \
--namespace=<var>namespace</var> --endpoint=<var>endpoint</var>

Local:


tfx pipeline list --engine=local

Vertex:


tfx pipeline list --engine=vertex

tfx run

La estructura de los comandos en el grupo de comandos tfx run es la siguiente:


tfx run <var>command</var> <var>required-flags</var> [<var>optional-flags</var>]

Utilice las siguientes secciones para obtener más información sobre los comandos en el grupo de comandos tfx run.

create

Crea una nueva instancia de ejecución para una canalización en el orquestador. Para Kubeflow, se utiliza la versión más reciente de la canalización en el clúster.

Uso:


tfx run create --pipeline_name=<var>pipeline-name</var> [--endpoint=<var>endpoint</var> \
--engine=<var>engine</var> --iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var>]
--pipeline_name=pipeline-name
El nombre de la canalización.
--endpoint=endpoint

(Opcional). Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow
  • local: establece el motor en el orquestador local
  • vertex: establece el motor en Vertex Pipelines
  • airflow: (experimental) configura el motor en Apache Airflow
  • beam: (experimental) configura el motor en Apache Beam

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--runtime_parameter=parameter-name=parameter-value
(Opcional). Establece un valor de parámetro de tiempo de ejecución. Se puede configurar varias veces para establecer valores de múltiples variables. Solo se puede aplicar a los motores `airflow`, `kubeflow` y `vertex`.
--iap_client_id=iap-client-id
(Opcional). El ID de cliente para el punto de conexión protegido por IAP.
--namespace=namespace
(Opcional). Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.
--project=GCP-project-id
(Obligatorio para Vertex). El ID del proyecto de GCP para la canalización de Vertex.
--region=GCP-region
(Obligatorio para Vertex). Nombre de región de GCP como us-central1. Consulte la [documentación de Vertex](https://cloud.google.com/vertex-ai/docs/general/locations) para conocer las regiones disponibles.

Ejemplos:

Kubeflow:


tfx run create --engine=kubeflow --pipeline_name=<var>pipeline-name</var> --iap_client_id=<var>iap-client-id</var> \
--namespace=<var>namespace</var> --endpoint=<var>endpoint</var>

Local:


tfx run create --engine=local --pipeline_name=<var>pipeline-name</var>

Vertex:


tfx run create --engine=vertex --pipeline_name=<var>pipeline-name</var> \
  --runtime_parameter=<var>var_name</var>=<var>var_value</var> \
  --project=<var>gcp-project-id</var> --region=<var>gcp-region</var>

terminate

Detiene una ejecución de una canalización determinada.

** Nota importante: Actualmente solo se admite en Kubeflow.

Uso:


tfx run terminate --run_id=<var>run-id</var> [--endpoint=<var>endpoint</var> --engine=<var>engine</var> \
--iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var>]
--run_id=run-id
Identificador único para una ejecución de canalización.
--endpoint=endpoint

(Opcional). Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--iap_client_id=iap-client-id
(Opcional). El ID de cliente para el punto de conexión protegido por IAP.
--namespace=namespace
(Opcional). Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.

Ejemplos:

Kubeflow:


tfx run delete --engine=kubeflow --run_id=<var>run-id</var> --iap_client_id=<var>iap-client-id</var> \
--namespace=<var>namespace</var> --endpoint=<var>endpoint</var>

list

Enumera todas las ejecuciones de una canalización.

** Nota importante: Actualmente no es compatible con Local y Apache Beam.

Uso:


tfx run list --pipeline_name=<var>pipeline-name</var> [--endpoint=<var>endpoint</var> \
--engine=<var>engine</var> --iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var>]
--pipeline_name=pipeline-name
El nombre de la canalización.
--endpoint=endpoint

(Opcional). Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow
  • airflow: (experimental) configura el motor en Apache Airflow

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--iap_client_id=iap-client-id
(Opcional). El ID de cliente para el punto de conexión protegido por IAP.
--namespace=namespace
(Opcional). Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.

Ejemplos:

Kubeflow:


tfx run list --engine=kubeflow --pipeline_name=<var>pipeline-name</var> --iap_client_id=<var>iap-client-id</var> \
--namespace=<var>namespace</var> --endpoint=<var>endpoint</var>

status

Devuelve el estado actual de una ejecución.

** Nota importante: Actualmente no es compatible con Local y Apache Beam.

Uso:


tfx run status --pipeline_name=<var>pipeline-name</var> --run_id=<var>run-id</var> [--endpoint=<var>endpoint</var> \
--engine=<var>engine</var> --iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var>]
--pipeline_name=pipeline-name
El nombre de la canalización.
--run_id=run-id
Identificador único para una ejecución de canalización.
--endpoint=endpoint

(Opcional). Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow
  • airflow: (experimental) configura el motor en Apache Airflow

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--iap_client_id=iap-client-id
(Opcional). El ID de cliente para el punto de conexión protegido por IAP.
--namespace=namespace
(Opcional). Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.

Ejemplos:

Kubeflow:


tfx run status --engine=kubeflow --run_id=<var>run-id</var> --pipeline_name=<var>pipeline-name</var> \
--iap_client_id=<var>iap-client-id</var> --namespace=<var>namespace</var> --endpoint=<var>endpoint</var>

delete

Elimina una ejecución de una canalización determinada.

** Nota importante: Actualmente solo se admite en Kubeflow

Uso:


tfx run delete --run_id=<var>run-id</var> [--engine=<var>engine</var> --iap_client_id=<var>iap-client-id</var> \
--namespace=<var>namespace</var> --endpoint=<var>endpoint</var>]
--run_id=run-id
Identificador único para una ejecución de canalización.
--endpoint=endpoint

(Opcional). Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--engine=engine

(Opcional). El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--iap_client_id=iap-client-id
(Opcional). El ID de cliente para el punto de conexión protegido por IAP.
--namespace=namespace
(Opcional). Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.

Ejemplos:

Kubeflow:


tfx run delete --engine=kubeflow --run_id=<var>run-id</var> --iap_client_id=<var>iap-client-id</var> \
--namespace=<var>namespace</var> --endpoint=<var>endpoint</var>

tfx template [Experimental]

La estructura de los comandos en el grupo de comandos tfx template es la siguiente:


tfx template <var>command</var> <var>required-flags</var> [<var>optional-flags</var>]

Use las siguientes secciones para obtener más información sobre los comandos en el grupo de comandos tfx template. La plantilla es una característica experimental y podría sufrir cambios en cualquier momento.

list

Enumera las plantillas de canalización de TFX disponibles.

Uso:


tfx template list

copy

Copia una plantilla en el directorio de destino.

Uso:


tfx template copy --model=<var>model</var> --pipeline_name=<var>pipeline-name</var> \
--destination_path=<var>destination-path</var>
--model=model
El nombre del modelo creado por la plantilla de canalización.
--pipeline_name=pipeline-name
El nombre de la canalización.
--destination_path=destination-path
La ruta en la que se copiará la plantilla.

Explicación de las marcas de la CLI de TFX

Marcas comunes

--engine=engine

El orquestador que se usará para la canalización. El valor del motor debe coincidir con uno de los siguientes valores:

  • kubeflow: configura el motor en Kubeflow
  • local: establece el motor en el orquestador local
  • vertex: establece el motor en Vertex Pipelines
  • airflow: (experimental) configura el motor en Apache Airflow
  • beam: (experimental) configura el motor en Apache Beam

Si el motor no está configurado, se detecta automáticamente en función del entorno.

** Nota importante: El orquestador requerido por DagRunner en el archivo de configuración de la canalización debe coincidir con el motor que se seleccione o se detecte automáticamente. La detección automática del motor se basa en el entorno del usuario. Si Apache Airflow y Kubeflow Pipelines no están instalados, se utiliza el orquestador local de forma predeterminada.

--pipeline_name=pipeline-name
El nombre de la canalización.
--pipeline_path=pipeline-path
La ruta al archivo de configuración de la canalización.
--run_id=run-id
Identificador único para una ejecución de canalización.

Marcas específicas de Kubeflow

--endpoint=endpoint

Punto de conexión del servicio de API de Kubeflow Pipelines. El punto de conexión de su servicio de API de Kubeflow Pipelines es el mismo que la URL del panel de Kubeflow Pipelines. El valor de su punto de conexión debería ser similar a lo que sigue:

<pre>https://<var>host-name</var>/pipeline</pre>

<p>
  If you do not know the endpoint for your Kubeflow Pipelines cluster,
  contact you cluster administrator.
</p>

<p>
  If the <code>--endpoint</code> is not specified, the in-cluster service
  DNS name is used as the default value. This name works only if the
  CLI command executes in a pod on the Kubeflow Pipelines cluster, such as a
  <a href="https://www.kubeflow.org/docs/components/notebooks/jupyter-tensorflow-examples/"
       class="external">Kubeflow Jupyter notebooks</a> instance.
</p>
--iap_client_id=iap-client-id
El ID de cliente para el punto de conexión protegido por IAP.
--namespace=namespace
Espacio de nombres de Kubernetes para conectarse a la API de Kubeflow Pipelines. Si no se especifica el espacio de nombres, el valor predeterminado es kubeflow.

Archivos generados por la CLI de TFX

Cuando se crean y ejecutan canalizaciones, se generan varios archivos para su gestión.

  • ${HOME}/tfx/local, beam, airflow, vertex

    • Los metadatos de canalización leídos desde la configuración se almacenan en ${HOME}/tfx/${ORCHESTRATION_ENGINE}/${PIPELINE_NAME}. Esta ubicación se puede personalizar al configurar variables de entorno como AIRFLOW_HOME o KUBEFLOW_HOME. Este comportamiento podría cambiar en versiones futuras. Este directorio se usa para almacenar información de canalizaciones, incluidos los ID de canalizaciones en el clúster de Kubeflow Pipelines, que se necesita para crear ejecuciones o actualizar canalizaciones.

    • Antes de TFX 0.25, estos archivos se ubicaban en ${HOME}/${ORCHESTRATION_ENGINE}. En TFX 0.25, los archivos en la ubicación anterior se moverán automáticamente a la nueva ubicación para facilitar la migración.

    • Desde TFX 0.27, kubeflow no crea estos archivos de metadatos en el sistema de archivos local. Sin embargo, consulte a continuación otros archivos que crea kubeflow.

  • (Solo Kubeflow) Dockerfile y una imagen de contenedor

    • Kubeflow Pipelines requiere dos tipos de entradas para una canalización. TFX se encarga de generar estos archivos en el directorio actual.

    • Una es una imagen de contenedor que se usará para ejecutar componentes en la canalización. Esta imagen de contenedor se construye cuando se crea o actualiza una canalización para Kubeflow Pipelines con el indicador --build-image. Si no existe, la CLI de TFX generará Dockerfile y creará y enviará una imagen de contenedor al registro especificado en KubeflowDagRunnerConfig.