GXF 命令行界面#

GXF 命令行界面 (CLI) 可以通过 gxf_cli 命令和以下选项调用

gxf_cli –help
gxf_cli --version
gxf_cli [-s SERVER] [-t TRANSPORT] command [args]
其中

  • -h/--help 显示帮助选项并退出

  • -v/--version 打印版本并退出。

可选参数

  • -s/--server: 指定服务器地址，默认地址为 ‘localhost:8000’，这是 GXF 图中 http 服务器使用的默认地址。

  • -t/--transport: 指定传输类型，默认为 ‘http’，如果 GXF 图启用了 GRPC 服务器，也可以设置为 ‘grpc’

以下部分详细介绍了可以与 gxf_cli 一起使用的命令选项。

stat#

此命令用于持续监控正在运行的 gxe 进程的统计信息。

命令语法

gxf_cli stat [-h] [-u UID] target

目标可以是以下之一

  • entity - 监控实体统计信息

  • codelet - 监控 codelet 统计信息

  • event - 监控调度事件统计信息

  • term - 监控调度项统计信息

可选参数

  • -u/--uid: 仅监控具有指定 uid 的实体或组件的数据

  • -h/--help - 打印帮助并退出。

config#

此命令用于设置正在运行的图中特定组件的参数

命令语法

gxf_cli config [-h] cid key value

  • cid: cid 是目标组件的 uid，如果名称可用，可以替换为 “entity_name/component_name”

  • key: 参数名称

  • value: 要设置的值，JSON 格式

可选参数

  • -h/--help - 打印帮助并退出。

dump#

此命令用于以可解析的 YAML 格式转储当前运行图中的实体。

命令语法

gxf_cli dump [-h] [-u UID]

可选参数

  • -u/--uid: 仅转储具有指定 uid 的实体上的数据

  • -h/--help - 打印帮助并退出。

从正在运行的图中转储的示例内容:

---
name: rx
id: 8
components:
  - name: signal
    id: 9
    type: nvidia::gxf::DoubleBufferReceiver
    parameters:
      capacity: 1
      policy: 2
  - name: nvidia::gxf::MessageAvailableSchedulingTerm_rx
    id: 10
    type: nvidia::gxf::MessageAvailableSchedulingTerm
    parameters:
      receiver: rx/signal
      min_size: 1
  - name: ping_rx
    id: 11
    type: nvidia::gxf::test::PingRx
    parameters:
      signal: rx/signal
  - name: step_count_rx
    id: 12
    type: nvidia::gxf::test::StepCount
    parameters:
      use_assert: false
      expected_start_count: 1
      expected_count: 100
在本页中