Support help option in mlcflow

[anandhu-eng]

These are some sample outputs:

anandhu@anandhu-VivoBook-ASUSLaptop-X515UA-M515UA:~/testing/mlcflow$ python3 -m mlc.main help 

    MLCFlow is a CLI tool for managing repos, scripts and caches.
    This framework is designed to drive the automatioin workflows of MLPerf benchmarks more efficiently.
    You can use this tool for any of your workflow automation tasks.

    There are actions and targets in MLCFlow. MLCFlow CLI enables users to perform actions on specified targets using simple syntax:
          
    mlc <action> <target> [options]

    Here, actions are the operations to be performed and the target is the object on which the action is executed.

    Each target has its own set of specific actions to tailor automation workflows as specifed below
    
    | Target  | Actions                                               |
    |---------|-------------------------------------------------------|
    | script  | run, find/search, rm, mv, cp, add, test, docker, show |
    | cache   | find/search, rm, show                                 |
    | repo    | pull, search, rm, list, find/search                   |
    
    Example:
      mlc run script detect-os
      
    For help related to a particular target, run the command: mlc help <target>
    
    For help related to particular action for a particular target, run the command: mlc help <action> <target>

anandhu@anandhu-VivoBook-ASUSLaptop-X515UA-M515UA:~/testing/mlcflow$ python3 -m mlc.main help find cache

    ####################################################################################################################
    Cache Action
    ####################################################################################################################
    Currently, the following actions are supported for Repos:
    1. find/search
    3. show
    4. list
    5. remove(rm)

    
    ####################################################################################################################
    Target: Cache
    Action: Find (Alias: Search)
    ####################################################################################################################

    The find/search action retrieves the path of cache generated by a particular script.  

    Syntax:

    mlc find cache --tags=<list_of_tag_used_to_run_the_particular_script> 

    Example Command:

    mlc find cache --tags=get,dataset,igbh

anandhu@anandhu-VivoBook-ASUSLaptop-X515UA-M515UA:~/testing/mlcflow$ python3 -m mlc.main help cache

    ####################################################################################################################
    Cache Action
    ####################################################################################################################
    Currently, the following actions are supported for Repos:
    1. find/search
    3. show
    4. list
    5. remove(rm)

    
    ####################################################################################################################
    Target: Cache
    Action: Find (Alias: Search)
    ####################################################################################################################

    The find/search action retrieves the path of cache generated by a particular script.  

    Syntax:

    mlc find cache --tags=<list_of_tag_used_to_run_the_particular_script> 

    Example Command:

    mlc find cache --tags=get,dataset,igbh

        
    ####################################################################################################################
    Target: Cache
    Action: List
    ####################################################################################################################

    Lists all the cache and their paths.

    Example Command:

    mlc list cache

        
    ####################################################################################################################
    Target: Cache
    Action: Remove(rm)
    ####################################################################################################################

    rm action is used to remove one/more caches generated while running scripts through MLC.

    Syntax:

    mlc rm cache --tags=<list_of_tag_used_to_run_the_particular_script> 

    Options:
        1. -f could be used to force remove caches. Without -f, user would be prompted for confirmation to delete a cache.

    A user could delete the entire generated caches through the following command:
        
    mlc rm cache

    Example Command:

    mlc rm cache --tags=get,dataset,igbh

        
    ####################################################################################################################
    Target: Cache
    Action: Find (Alias: Search)
    ####################################################################################################################

    The find/search action retrieves the path of cache generated by a particular script.  

    Syntax:

    mlc find cache --tags=<list_of_tag_used_to_run_the_particular_script> 

    Example Command:

    mlc find cache --tags=get,dataset,igbh

        
    ####################################################################################################################
    Target: Cache
    Action: Show
    ####################################################################################################################

    Retrieves the path and metadata of the cache generated while running scripts through MLC.
        
    Syntax:
        
    mlc show cache --tags=<list_of_tags_used_while_running_script>

    Example Command:

    mlc show cache --tags=get,dataset,igbh

    Note:
    - We have an action named Find which is the subset of show, it retrieves only the path of the searched cache. 

[github-actions]

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅