mirror of
https://github.com/wassname/ray.git
synced 2026-09-12 12:51:15 +08:00
[tune] Initial Commit for Tune CLI (#3983)
This introduces a light CLI for Tune.
This commit is contained in:
@@ -499,6 +499,50 @@ And stopping a trial (``PUT /trials/:id``):
|
||||
curl -X PUT http://<address>:<port>/trials/<trial_id>
|
||||
|
||||
|
||||
Tune CLI (Experimental)
|
||||
-----------------------
|
||||
|
||||
``tune`` has an easy-to-use command line interface (CLI) to manage and monitor your experiments on Ray. To do this, verify that you have the ``tabulate`` library installed:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip install tabulate
|
||||
|
||||
Here are a few examples of command line calls.
|
||||
|
||||
- ``tune list-trials``: List tabular information about trials within an experiment. Add the ``--sort`` flag to sort the output by specific columns.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tune list-trials [EXPERIMENT_DIR]
|
||||
|
||||
+------------------+-----------------------+------------+
|
||||
| trainable_name | experiment_tag | trial_id |
|
||||
|------------------+-----------------------+------------|
|
||||
| MyTrainableClass | 0_height=40,width=37 | 87b54a1d |
|
||||
| MyTrainableClass | 1_height=21,width=70 | 23b89036 |
|
||||
| MyTrainableClass | 2_height=99,width=90 | 518dbe95 |
|
||||
| MyTrainableClass | 3_height=54,width=21 | 7b99a28a |
|
||||
| MyTrainableClass | 4_height=90,width=69 | ae4e02fb |
|
||||
+------------------+-----------------------+------------+
|
||||
Dropped columns: ['status', 'last_update_time']
|
||||
|
||||
- ``tune list-experiments``: List tabular information about experiments within a project. Add the ``--sort`` flag to sort the output by specific columns.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tune list-experiments [PROJECT_DIR]
|
||||
|
||||
+----------------------+----------------+------------------+---------------------+
|
||||
| name | total_trials | running_trials | terminated_trials |
|
||||
|----------------------+----------------+------------------+---------------------|
|
||||
| pbt_test | 10 | 0 | 0 |
|
||||
| test | 1 | 0 | 0 |
|
||||
| hyperband_test | 1 | 0 | 1 |
|
||||
+----------------------+----------------+------------------+---------------------+
|
||||
Dropped columns: ['error_trials', 'last_updated']
|
||||
|
||||
|
||||
Further Questions or Issues?
|
||||
----------------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user