运行
=======

.. contents:: 本节目录
    :depth: 2

命令: ``run``

当项目、算法、数据集准备好后就可以开始训练任务了，运行是 ``run`` 命令。
``--help`` 命令可看到有 ``training`` ``serving`` 子命令,
分别代表训练任务、验证任务、模型服务。目前CLI仅支持 `训练任务`_ 。

.. code-block:: shell

    anyctl run --help

.. code-block:: text

    Usage: anyctl run [OPTIONS] COMMAND [ARGS]...

        Run training or serving on remote Anylearn.

    Options:
        --help  Show this message and exit.

    Commands:
        serving     Run serving task.
        training    Run training task.


训练任务
---------------

命令: ``training``

+---------------------------+----------+-------------+-------------------------------------------------------------+
| 参数及缩写                | 是否必须 | 默认值      | 说明                                                        |
+===========================+==========+=============+=============================================================+
| algorithm_name            | True     |             | 算法名称                                                    |
+---------------------------+----------+-------------+-------------------------------------------------------------+
| -\-data， -d              | True     |             | 数据集KV对                                                  |
+---------------------------+----------+-------------+-------------------------------------------------------------+
| -\-param, -p              | True     |             | 超参数KV对                                                  |
+---------------------------+----------+-------------+-------------------------------------------------------------+
| -\-data-yaml              | False    |             | YAML格式的数据集定义文件的绝对路径。                        |
|                           |          |             | 如果指定，则通过 ``-d`` 或 ``--data`` 选项的数据集将被忽略  |
+---------------------------+----------+-------------+-------------------------------------------------------------+

使用示例：

.. code-block:: shell

    anyctl run training anyctl_algo -n 1 -d data-path=anyctl_dset -p batch-size=256 -p epochs=12

如果需要配置远程地址和用户信息请参考 :ref:`set_host_user_info` 。

运行后会有以下提示信息：

.. code-block:: text

    [SUCCESS] CREATED TRAIxxx  #提示训练任务创建成功并返回任务ID


模型服务
-------------

命令: ``serving``

*CLI暂不支持此功能*