Sử dụng Giao diện dòng lệnh TFX

Giao diện dòng lệnh TFX (CLI) thực hiện đầy đủ các hành động quy trình bằng cách sử dụng bộ điều phối quy trình, chẳng hạn như Kubeflow Pipelines, Vertex Pipelines. Bộ điều phối cục bộ cũng có thể được sử dụng để phát triển hoặc gỡ lỗi nhanh hơn. Luồng khí Apache Beam và Apache được hỗ trợ dưới dạng tính năng thử nghiệm. Ví dụ: bạn có thể sử dụng CLI để:

  • Tạo, cập nhật và xóa đường ống.
  • Chạy một đường ống và giám sát hoạt động trên các bộ điều phối khác nhau.
  • Liệt kê các đường ống và đường ống chạy.

Giới thiệu về TFX CLI

TFX CLI được cài đặt như một phần của gói TFX. Tất cả các lệnh CLI đều tuân theo cấu trúc bên dưới:

tfx command-group command flags

Các tùy chọn command-group sau hiện được hỗ trợ:

  • đường ống tfx - Tạo và quản lý đường ống TFX.
  • tfx run - Tạo và quản lý các lần chạy đường ống TFX trên các nền tảng điều phối khác nhau.
  • mẫu tfx - Các lệnh thử nghiệm để liệt kê và sao chép các mẫu đường ống TFX.

Mỗi nhóm lệnh cung cấp một tập hợp commands . Làm theo hướng dẫn trong các phần lệnh quy trình , lệnh chạylệnh mẫu để tìm hiểu thêm về cách sử dụng các lệnh này.

Cờ cho phép bạn chuyển đối số vào lệnh CLI. Các từ trong cờ được phân tách bằng dấu gạch ngang ( - ) hoặc dấu gạch dưới ( _ ). Ví dụ: cờ tên đường ống có thể được chỉ định là --pipeline-name hoặc --pipeline_name . Tài liệu này chỉ định các cờ có dấu gạch dưới để ngắn gọn. Tìm hiểu thêm về flags được sử dụng trong TFX CLI .

đường ống tfx

Cấu trúc cho các lệnh trong nhóm lệnh tfx pipeline như sau:

tfx pipeline command required-flags [optional-flags]

Sử dụng các phần sau để tìm hiểu thêm về các lệnh trong nhóm lệnh tfx pipeline .

tạo nên

Tạo một đường dẫn mới trong bộ điều phối đã cho.

Cách sử dụng:

tfx pipeline create --pipeline_path=pipeline-path [--endpoint=endpoint --engine=engine \
--iap_client_id=iap-client-id --namespace=namespace \
--build_image --build_base_image=build-base-image]
--pipeline_path= pipeline-path
Đường dẫn đến tệp cấu hình đường ống.
--endpoint= endpoint

(Tùy chọn.) Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow
  • local : đặt công cụ cho bộ điều phối cục bộ
  • vertex : đặt động cơ thành Vertex Pipelines
  • Luồng khí : (thử nghiệm) đặt động cơ thành Luồng khí Apache
  • Beam : (thử nghiệm) đặt công cụ thành Apache Beam

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--iap_client_id= iap-client-id
(Tùy chọn.) ID khách hàng cho điểm cuối được bảo vệ IAP khi sử dụng Quy trình Kubeflow.
--namespace= namespace
(Tùy chọn.) Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .
--build_image

(Tùy chọn.) Khi enginekubeflow hoặc vertex , TFX sẽ tạo hình ảnh vùng chứa cho quy trình của bạn nếu được chỉ định. `Dockerfile` trong thư mục hiện tại sẽ được sử dụng và TFX sẽ tự động tạo một tệp nếu không tồn tại.

Hình ảnh được xây dựng sẽ được đẩy đến sổ đăng ký từ xa được chỉ định trong `KubeflowDagRunnerConfig` hoặc `KubeflowV2DagRunnerConfig`.

--build_base_image= build-base-image

(Tùy chọn.) Khi enginekubeflow , TFX sẽ tạo hình ảnh vùng chứa cho quy trình của bạn. Hình ảnh cơ sở xây dựng chỉ định hình ảnh vùng chứa cơ sở sẽ sử dụng khi xây dựng hình ảnh vùng chứa đường ống.

Ví dụ:

Kubeflow:

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

Địa phương:

tfx pipeline create --engine=local --pipeline_path=pipeline-path

Đỉnh:

tfx pipeline create --engine=vertex --pipeline_path=pipeline-path \
--build_image

Để tự động phát hiện công cụ từ môi trường người dùng, bạn chỉ cần tránh sử dụng cờ công cụ như ví dụ bên dưới. Để biết thêm chi tiết, hãy kiểm tra phần cờ.

tfx pipeline create --pipeline_path=pipeline-path

cập nhật

Cập nhật quy trình hiện có trong bộ điều phối đã cho.

Cách sử dụng:

tfx pipeline update --pipeline_path=pipeline-path [--endpoint=endpoint --engine=engine \
--iap_client_id=iap-client-id --namespace=namespace --build_image]
--pipeline_path= pipeline-path
Đường dẫn đến tệp cấu hình đường ống.
--endpoint= endpoint

(Tùy chọn.) Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow
  • local : đặt công cụ cho bộ điều phối cục bộ
  • vertex : đặt động cơ thành Vertex Pipelines
  • Luồng khí : (thử nghiệm) đặt động cơ thành Luồng khí Apache
  • Beam : (thử nghiệm) đặt công cụ thành Apache Beam

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--iap_client_id= iap-client-id
(Tùy chọn.) ID khách hàng cho điểm cuối được bảo vệ bằng IAP.
--namespace= namespace
(Tùy chọn.) Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .
--build_image

(Tùy chọn.) Khi enginekubeflow hoặc vertex , TFX sẽ tạo hình ảnh vùng chứa cho quy trình của bạn nếu được chỉ định. `Dockerfile` trong thư mục hiện tại sẽ được sử dụng.

Hình ảnh được xây dựng sẽ được đẩy đến sổ đăng ký từ xa được chỉ định trong `KubeflowDagRunnerConfig` hoặc `KubeflowV2DagRunnerConfig`.

Ví dụ:

Kubeflow:

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

Địa phương:

tfx pipeline update --engine=local --pipeline_path=pipeline-path

Đỉnh:

tfx pipeline update --engine=vertex --pipeline_path=pipeline-path \
--build_image

biên soạn

Biên dịch tệp cấu hình quy trình để tạo tệp quy trình công việc trong Kubeflow và thực hiện các bước kiểm tra sau trong khi biên dịch:

  1. Kiểm tra xem đường dẫn đường ống có hợp lệ không.
  2. Kiểm tra xem chi tiết đường ống có được trích xuất thành công từ tệp cấu hình đường ống hay không.
  3. Kiểm tra xem DagRunner trong cấu hình đường dẫn có khớp với động cơ hay không.
  4. Kiểm tra xem tệp quy trình công việc có được tạo thành công trong đường dẫn gói được cung cấp hay không (chỉ dành cho Kubeflow).

Được khuyến nghị sử dụng trước khi tạo hoặc cập nhật quy trình.

Cách sử dụng:

tfx pipeline compile --pipeline_path=pipeline-path [--engine=engine]
--pipeline_path= pipeline-path
Đường dẫn đến tệp cấu hình đường ống.
--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow
  • local : đặt công cụ cho bộ điều phối cục bộ
  • vertex : đặt động cơ thành Vertex Pipelines
  • Luồng khí : (thử nghiệm) đặt động cơ thành Luồng khí Apache
  • Beam : (thử nghiệm) đặt công cụ thành Apache Beam

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

Ví dụ:

Kubeflow:

tfx pipeline compile --engine=kubeflow --pipeline_path=pipeline-path

Địa phương:

tfx pipeline compile --engine=local --pipeline_path=pipeline-path

Đỉnh:

tfx pipeline compile --engine=vertex --pipeline_path=pipeline-path

xóa bỏ

Xóa một đường dẫn khỏi bộ điều phối đã cho.

Cách sử dụng:

tfx pipeline delete --pipeline_path=pipeline-path [--endpoint=endpoint --engine=engine \
--iap_client_id=iap-client-id --namespace=namespace]
--pipeline_path= pipeline-path
Đường dẫn đến tệp cấu hình đường ống.
--endpoint= endpoint

(Tùy chọn.) Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow
  • local : đặt công cụ cho bộ điều phối cục bộ
  • vertex : đặt động cơ thành Vertex Pipelines
  • Luồng khí : (thử nghiệm) đặt động cơ thành Luồng khí Apache
  • Beam : (thử nghiệm) đặt công cụ thành Apache Beam

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--iap_client_id= iap-client-id
(Tùy chọn.) ID khách hàng cho điểm cuối được bảo vệ bằng IAP.
--namespace= namespace
(Tùy chọn.) Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .

Ví dụ:

Kubeflow:

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

Địa phương:

tfx pipeline delete --engine=local --pipeline_name=pipeline-name

Đỉnh:

tfx pipeline delete --engine=vertex --pipeline_name=pipeline-name

danh sách

Liệt kê tất cả các đường ống trong bộ điều phối nhất định.

Cách sử dụng:

tfx pipeline list [--endpoint=endpoint --engine=engine \
--iap_client_id=iap-client-id --namespace=namespace]
--endpoint= endpoint

(Tùy chọn.) Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow
  • local : đặt công cụ cho bộ điều phối cục bộ
  • vertex : đặt động cơ thành Vertex Pipelines
  • Luồng khí : (thử nghiệm) đặt động cơ thành Luồng khí Apache
  • Beam : (thử nghiệm) đặt công cụ thành Apache Beam

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--iap_client_id= iap-client-id
(Tùy chọn.) ID khách hàng cho điểm cuối được bảo vệ bằng IAP.
--namespace= namespace
(Tùy chọn.) Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .

Ví dụ:

Kubeflow:

tfx pipeline list --engine=kubeflow --iap_client_id=iap-client-id \
--namespace=namespace --endpoint=endpoint

Địa phương:

tfx pipeline list --engine=local

Đỉnh:

tfx pipeline list --engine=vertex

chạy tfx

Cấu trúc các lệnh trong nhóm lệnh tfx run như sau:

tfx run command required-flags [optional-flags]

Sử dụng các phần sau để tìm hiểu thêm về các lệnh trong nhóm lệnh tfx run .

tạo nên

Tạo một phiên bản chạy mới cho một quy trình trong bộ điều phối. Đối với Kubeflow, phiên bản quy trình mới nhất của quy trình trong cụm sẽ được sử dụng.

Cách sử dụng:

tfx run create --pipeline_name=pipeline-name [--endpoint=endpoint \
--engine=engine --iap_client_id=iap-client-id --namespace=namespace]
--pipeline_name= pipeline-name
Tên của đường ống.
--endpoint= endpoint

(Tùy chọn.) Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow
  • local : đặt công cụ cho bộ điều phối cục bộ
  • vertex : đặt động cơ thành Vertex Pipelines
  • Luồng khí : (thử nghiệm) đặt động cơ thành Luồng khí Apache
  • Beam : (thử nghiệm) đặt công cụ thành Apache Beam

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--runtime_parameter= parameter-name = parameter-value
(Tùy chọn.) Đặt giá trị tham số thời gian chạy. Có thể đặt nhiều lần để đặt giá trị của nhiều biến. Chỉ áp dụng cho động cơ `airflow`, kubeflow` và `vertex`.
--iap_client_id= iap-client-id
(Tùy chọn.) ID khách hàng cho điểm cuối được bảo vệ bằng IAP.
--namespace= namespace
(Tùy chọn.) Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .
--project= GCP-project-id
(Bắt buộc đối với Vertex.) Id dự án GCP cho quy trình đỉnh.
--khu vực= GCP-region
(Bắt buộc đối với Vertex.) Tên vùng GCP như us-central1. Xem [tài liệu của Vertex](https://cloud.google.com/vertex-ai/docs/general/locations) để biết các khu vực có sẵn.

Ví dụ:

Kubeflow:

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

Địa phương:

tfx run create --engine=local --pipeline_name=pipeline-name

Đỉnh:

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

chấm dứt

Dừng hoạt động của một đường ống nhất định.

** Lưu ý quan trọng: Hiện chỉ được hỗ trợ trong Kubeflow.

Cách sử dụng:

tfx run terminate --run_id=run-id [--endpoint=endpoint --engine=engine \
--iap_client_id=iap-client-id --namespace=namespace]
--run_id= run-id
Mã định danh duy nhất cho một lần chạy đường ống.
--endpoint= endpoint

(Tùy chọn.) Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--iap_client_id= iap-client-id
(Tùy chọn.) ID khách hàng cho điểm cuối được bảo vệ bằng IAP.
--namespace= namespace
(Tùy chọn.) Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .

Ví dụ:

Kubeflow:

tfx run delete --engine=kubeflow --run_id=run-id --iap_client_id=iap-client-id \
--namespace=namespace --endpoint=endpoint

danh sách

Liệt kê tất cả các hoạt động của một đường ống.

** Lưu ý quan trọng: Hiện không được hỗ trợ trong Local và Apache Beam.

Cách sử dụng:

tfx run list --pipeline_name=pipeline-name [--endpoint=endpoint \
--engine=engine --iap_client_id=iap-client-id --namespace=namespace]
--pipeline_name= pipeline-name
Tên của đường ống.
--endpoint= endpoint

(Tùy chọn.) Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow
  • Luồng khí : (thử nghiệm) đặt động cơ thành Luồng khí Apache

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--iap_client_id= iap-client-id
(Tùy chọn.) ID khách hàng cho điểm cuối được bảo vệ bằng IAP.
--namespace= namespace
(Tùy chọn.) Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .

Ví dụ:

Kubeflow:

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

trạng thái

Trả về trạng thái hiện tại của một lần chạy.

** Lưu ý quan trọng: Hiện không được hỗ trợ trong Local và Apache Beam.

Cách sử dụng:

tfx run status --pipeline_name=pipeline-name --run_id=run-id [--endpoint=endpoint \
--engine=engine --iap_client_id=iap-client-id --namespace=namespace]
--pipeline_name= pipeline-name
Tên của đường ống.
--run_id= run-id
Mã định danh duy nhất cho một lần chạy đường ống.
--endpoint= endpoint

(Tùy chọn.) Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow
  • Luồng khí : (thử nghiệm) đặt động cơ thành Luồng khí Apache

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--iap_client_id= iap-client-id
(Tùy chọn.) ID khách hàng cho điểm cuối được bảo vệ bằng IAP.
--namespace= namespace
(Tùy chọn.) Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .

Ví dụ:

Kubeflow:

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

xóa bỏ

Xóa một đường ống nhất định.

** Lưu ý quan trọng: Hiện chỉ được hỗ trợ trong Kubeflow

Cách sử dụng:

tfx run delete --run_id=run-id [--engine=engine --iap_client_id=iap-client-id \
--namespace=namespace --endpoint=endpoint]
--run_id= run-id
Mã định danh duy nhất cho một lần chạy đường ống.
--endpoint= endpoint

(Tùy chọn.) Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--động cơ= engine

(Tùy chọn.) Bộ điều phối được sử dụng cho quy trình. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--iap_client_id= iap-client-id
(Tùy chọn.) ID khách hàng cho điểm cuối được bảo vệ bằng IAP.
--namespace= namespace
(Tùy chọn.) Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .

Ví dụ:

Kubeflow:

tfx run delete --engine=kubeflow --run_id=run-id --iap_client_id=iap-client-id \
--namespace=namespace --endpoint=endpoint

mẫu tfx [Thử nghiệm]

Cấu trúc cho các lệnh trong nhóm lệnh tfx template như sau:

tfx template command required-flags [optional-flags]

Sử dụng các phần sau để tìm hiểu thêm về các lệnh trong nhóm lệnh tfx template . Mẫu là một tính năng thử nghiệm và có thể thay đổi bất kỳ lúc nào.

danh sách

Liệt kê các mẫu đường ống TFX có sẵn.

Cách sử dụng:

tfx template list

sao chép

Sao chép mẫu vào thư mục đích.

Cách sử dụng:

tfx template copy --model=model --pipeline_name=pipeline-name \
--destination_path=destination-path
--model= model
Tên của mô hình được xây dựng bởi mẫu đường ống.
--pipeline_name= pipeline-name
Tên của đường ống.
--destination_path= destination-path
Đường dẫn để sao chép mẫu vào.

Hiểu cờ TFX CLI

Cờ chung

--động cơ= engine

Bộ điều phối được sử dụng cho đường ống. Giá trị của động cơ phải phù hợp với các giá trị sau:

  • kubeflow : đặt công cụ thành Kubeflow
  • local : đặt công cụ cho bộ điều phối cục bộ
  • vertex : đặt động cơ thành Vertex Pipelines
  • Luồng khí : (thử nghiệm) đặt động cơ thành Luồng khí Apache
  • Beam : (thử nghiệm) đặt công cụ thành Apache Beam

Nếu động cơ không được cài đặt, động cơ sẽ tự động được phát hiện dựa trên môi trường.

** Lưu ý quan trọng: Bộ điều phối mà DagRunner yêu cầu trong tệp cấu hình đường ống phải khớp với công cụ đã chọn hoặc được tự động phát hiện. Tự động phát hiện động cơ dựa trên môi trường người dùng. Nếu Apache Airflow và Kubeflow Pipelines chưa được cài đặt thì bộ điều phối cục bộ sẽ được sử dụng theo mặc định.

--pipeline_name= pipeline-name
Tên của đường ống.
--pipeline_path= pipeline-path
Đường dẫn đến tệp cấu hình đường ống.
--run_id= run-id
Mã định danh duy nhất cho một lần chạy đường ống.

Cờ cụ thể của Kubeflow

--endpoint= endpoint

Điểm cuối của dịch vụ Kubeflow Pipelines API. Điểm cuối của dịch vụ Kubeflow Pipelines API giống với URL của bảng thông tin Kubeflow Pipelines. Giá trị điểm cuối của bạn phải giống như:

https://host-name/pipeline

Nếu bạn không biết điểm cuối cho cụm Đường dẫn Kubeflow của mình, hãy liên hệ với quản trị viên cụm của bạn.

Nếu --endpoint không được chỉ định, tên DNS dịch vụ trong cụm sẽ được sử dụng làm giá trị mặc định. Tên này chỉ hoạt động nếu lệnh CLI thực thi trong một nhóm trên cụm Đường ống Kubeflow, chẳng hạn như phiên bản sổ ghi chép Kubeflow Jupyter .

--iap_client_id= iap-client-id
ID ứng dụng khách cho điểm cuối được bảo vệ bằng IAP.
--namespace= namespace
Không gian tên Kubernetes để kết nối với API Kubeflow Pipelines. Nếu không gian tên không được chỉ định thì giá trị mặc định là kubeflow .

Các tệp được tạo bởi TFX CLI

Khi đường ống được tạo và chạy, một số tệp sẽ được tạo để quản lý đường ống.

  • ${HOME}/tfx/local, chùm, luồng không khí, đỉnh
    • Siêu dữ liệu đường dẫn được đọc từ cấu hình được lưu trữ trong ${HOME}/tfx/${ORCHESTRATION_ENGINE}/${PIPELINE_NAME} . Vị trí này có thể được tùy chỉnh bằng cách đặt biến môi trường như AIRFLOW_HOME hoặc KUBEFLOW_HOME . Hành vi này có thể được thay đổi trong các phiên bản tương lai. Thư mục này được dùng để lưu trữ thông tin quy trình bao gồm id quy trình trong cụm Quy trình Kubeflow cần thiết để tạo các lần chạy hoặc cập nhật quy trình.
    • Trước TFX 0.25, các tệp này nằm trong ${HOME}/${ORCHESTRATION_ENGINE} . Trong TFX 0.25, các tệp ở vị trí cũ sẽ tự động được di chuyển đến vị trí mới để di chuyển suôn sẻ.
    • Từ TFX 0.27, kubeflow không tạo các tệp siêu dữ liệu này trong hệ thống tệp cục bộ. Tuy nhiên, hãy xem bên dưới để biết các tệp khác mà kubeflow tạo.
  • (Chỉ Kubeflow) Dockerfile và hình ảnh vùng chứa
    • Đường ống Kubeflow yêu cầu hai loại đầu vào cho đường ống. Các tệp này được tạo bởi TFX trong thư mục hiện tại.
    • Một là hình ảnh vùng chứa sẽ được sử dụng để chạy các thành phần trong đường ống. Hình ảnh vùng chứa này được tạo khi một quy trình cho Đường ống Kubeflow được tạo hoặc cập nhật bằng cờ --build-image . TFX CLI sẽ tạo Dockerfile nếu không tồn tại, đồng thời sẽ xây dựng và đẩy hình ảnh vùng chứa vào sổ đăng ký được chỉ định trong KubeflowDagRunnerConfig.