fate_flow_cli.md

FATE-Flow Client Command Line Interface

Usage

python fate_flow_client.py -f $command

Job

submit_job

• description: submit a pipeline job
• parameter:
  • -c --config: runtime conf path, Required
  • -d --dsl: dsl path, Required

stop_job

• description: stop job
• parameter:
  • -j --job_id: job id, Required

query_job

• description: query job information by filters
• parameter:
  • -j --job_id: filter by job id, Optional
  • -r --role : filter by role, Optional
  • -p --party_id: filter by party id, Optional
  • -s --status: filter by status, Optional

job_config

• description: download the configuration of this job
• parameter:
  • -j --job_id: job id, Required
  • -r --role : role, Required
  • -p --party_id: party id, Required
  • -o --output_path: config output directory path, Required

job_log

• description: download the log of this job
• parameter:
  • -j --job_id: job id, Required
  • -o --output_path: config output directory path, Required

query_task

• description: query task information by filters
• parameter:
  • -j --job_id: filter by job id, Optional
  • -cpn --component_name: filter by component name, Optional
  • -r --role : filter by role, Optional
  • -p --party_id: filter by party id, Optional
  • -s --status: filter by status, Optional

Tracking

component_parameters

• description: query the parameters of this component
• parameter:
  • -j --job_id: job id, Required
  • -cpn --component_name: component name, Required
  • -r --role: role, Required
  • -p --party_id: party id, Required

component_metric_all

• description: query all metric data
• parameter:
  • -j --job_id: job id, Required
  • -cpn --component_name: component name, Required
  • -r --role: role, Required
  • -p --party_id: party id, Required

component_metrics

• description: query the list of metrics
• parameter:
  • -j --job_id: job id, Required
  • -cpn --component_name: component name, Required
  • -r --role: role, Required
  • -p --party_id: party id, Required

component_output_model

• description: query this component model
• parameter:
  • -j --job_id: job id, Required
  • -cpn --component_name: component name, Required
  • -r --role: role, Required
  • -p --party_id: party id, Required

component_output_data

• description: download the output data of this component
• parameter:
  • -j --job_id: job id, Required
  • -cpn --component_name: component name, Required
  • -r --role: role, Required
  • -p --party_id: party id, Required
  • -o --output_path: config output path, Required

DataAccess

download

• description: download table
• parameter:
  • -w --work mode: work mode, Required
  • -n --namespace: namespace, Required
  • -t --table_name: table name, Required
  • -o --output_path: output path, Required

upload

• description: upload table
• parameter:
  • -c --config: config path, Required

Table

table_info

• description: query table information
• parameter:
  • -n --namespace: namespace, Required
  • -t --table_name: table name, Required

Model

load

• description: load model.Since the model is not well controlled here, the interface here is not implemented.

online

• description: publish model online.Since the model is not well controlled here, the interface here is not implemented.

version

• description: query model version history
• parameter:
  • -n --namespace: namespace, Required